Extensions for Using Data Elements from FHIR R4 in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4 in FHIR STU3 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4_Encounter_R3 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-Encounter resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. Encounter
Definition

An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

ShortAn interaction during which services are provided to the patient
Control0..*
Alternate NamesVisit
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
2. Encounter.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. Encounter.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional Content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on Encounter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Encounter.extension:serviceType
    Slice NameserviceType
    Definition

    R4: Encounter.serviceType (new:CodeableConcept)

    ShortR4: Specific type of service (new)
    Comments

    Element Encounter.serviceType has a context of Encounter based on following the parent source element upwards and mapping to Encounter. Element Encounter.serviceType has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R4: Specific type of service (new)) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Encounter.extension:reasonReference
    Slice NamereasonReference
    Definition

    R4: Encounter.reasonReference (new:Reference(Condition,Procedure,Observation,ImmunizationRecommendation))

    ShortR4: Reason the encounter takes place (reference) (new)
    Comments

    Element Encounter.reasonReference has a context of Encounter based on following the parent source element upwards and mapping to Encounter. Element Encounter.reasonReference has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R4: Reason the encounter takes place (reference) (new)) (Extension Type: Reference(Cross-version Profile for R4.Condition for use in FHIR STU3, Condition, Cross-version Profile for R4.Procedure for use in FHIR STU3, Procedure, Cross-version Profile for R4.Observation for use in FHIR STU3, Observation, Cross-version Profile for R4.ImmunizationRecommendation for use in FHIR STU3, ImmunizationRecommendation))
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. Encounter.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Alternate Namesextensions, user content
    12. Encounter.status
    Definition

    planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

    Shortplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
    Comments

    Note that internal business rules will detemine the appropraite transitions that may occur between statuses (and also classes).

    This element is labeled as a modifier because the status contains codes that mark the encounter as not currently valid.

    Control1..1
    BindingThe codes SHALL be taken from EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|3.0.2
    (required to http://hl7.org/fhir/ValueSet/encounter-status|3.0.2)

    Current state of the encounter

    Typecode
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue

    Guidance on how to interpret the contents of this table can be foundhere

    0. Encounter
    2. Encounter.extension
    Control0..*
    SlicingThis element introduces a set of slices on Encounter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 4. Encounter.extension:serviceType
      Slice NameserviceType
      Definition

      R4: Encounter.serviceType (new:CodeableConcept)

      ShortR4: Specific type of service (new)
      Comments

      Element Encounter.serviceType has a context of Encounter based on following the parent source element upwards and mapping to Encounter. Element Encounter.serviceType has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..1
      TypeExtension(R4: Specific type of service (new)) (Extension Type: CodeableConcept)
      6. Encounter.extension:reasonReference
      Slice NamereasonReference
      Definition

      R4: Encounter.reasonReference (new:Reference(Condition,Procedure,Observation,ImmunizationRecommendation))

      ShortR4: Reason the encounter takes place (reference) (new)
      Comments

      Element Encounter.reasonReference has a context of Encounter based on following the parent source element upwards and mapping to Encounter. Element Encounter.reasonReference has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

      Control0..*
      TypeExtension(R4: Reason the encounter takes place (reference) (new)) (Extension Type: Reference(Cross-version Profile for R4.Condition for use in FHIR STU3, Condition, Cross-version Profile for R4.Procedure for use in FHIR STU3, Procedure, Cross-version Profile for R4.Observation for use in FHIR STU3, Observation, Cross-version Profile for R4.ImmunizationRecommendation for use in FHIR STU3, ImmunizationRecommendation))
      8. Encounter.incomingReferral
      10. Encounter.incomingReferral.extension
      Control0..*
      SlicingThis element introduces a set of slices on Encounter.incomingReferral.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 12. Encounter.incomingReferral.extension:basedOn
        Slice NamebasedOn
        Definition

        R4: Encounter.basedOn additional types from child elements (display, identifier, reference, type)

        ShortR4: The ServiceRequest that initiated this encounter additional types
        Comments

        Element Encounter.basedOn is mapped to FHIR STU3 element Encounter.incomingReferral as SourceIsBroaderThanTarget. The mappings for Encounter.basedOn do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R4 element Encounter.basedOn with unmapped reference targets: ServiceRequest.

        Control0..*
        TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
        14. Encounter.participant
        16. Encounter.participant.individual
        18. Encounter.participant.individual.extension
        Control0..*
        SlicingThis element introduces a set of slices on Encounter.participant.individual.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 20. Encounter.participant.individual.extension:individual
          Slice Nameindividual
          Definition

          R4: Encounter.participant.individual

          ShortR4: individual
          Comments

          Element Encounter.participant.individual is mapped to FHIR STU3 element Encounter.participant.individual as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R4 element Encounter.participant.individual with unmapped reference targets: PractitionerRole.

          Control0..1
          TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
          22. Encounter.hospitalization
          24. Encounter.hospitalization.origin
          26. Encounter.hospitalization.origin.extension
          Control0..*
          SlicingThis element introduces a set of slices on Encounter.hospitalization.origin.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 28. Encounter.hospitalization.origin.extension:origin
            Slice Nameorigin
            Definition

            R4: Encounter.hospitalization.origin additional types from child elements (display, identifier, reference, type)

            ShortR4: The location/organization from which the patient came before admission additional types
            Comments

            Element Encounter.hospitalization.origin is mapped to FHIR STU3 element Encounter.hospitalization.origin as SourceIsBroaderThanTarget. The mappings for Encounter.hospitalization.origin do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R4 element Encounter.hospitalization.origin with unmapped reference targets: Organization.

            Control0..1
            TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
            30. Encounter.hospitalization.destination
            32. Encounter.hospitalization.destination.extension
            Control0..*
            SlicingThis element introduces a set of slices on Encounter.hospitalization.destination.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 34. Encounter.hospitalization.destination.extension:destination
              Slice Namedestination
              Definition

              R4: Encounter.hospitalization.destination additional types from child elements (display, identifier, reference, type)

              ShortR4: Location/organization to which the patient is discharged additional types
              Comments

              Element Encounter.hospitalization.destination is mapped to FHIR STU3 element Encounter.hospitalization.destination as SourceIsBroaderThanTarget. The mappings for Encounter.hospitalization.destination do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R4 element Encounter.hospitalization.destination with unmapped reference targets: Organization.

              Control0..1
              TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
              36. Encounter.location
              38. Encounter.location.extension
              Control0..*
              SlicingThis element introduces a set of slices on Encounter.location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 40. Encounter.location.extension:physicalType
                Slice NamephysicalType
                Definition

                R4: Encounter.location.physicalType (new:CodeableConcept)

                ShortR4: The physical type of the location (usually the level in the location hierachy - bed room ward etc.) (new)
                Comments

                Element Encounter.location.physicalType has a context of Encounter.location based on following the parent source element upwards and mapping to Encounter. Element Encounter.location.physicalType has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query.

                There may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario.

                Control0..1
                TypeExtension(R4: The physical type of the location (usually the level in the location hierachy - bed room ward etc.) (new)) (Extension Type: CodeableConcept)

                Guidance on how to interpret the contents of this table can be foundhere

                0. Encounter
                Definition

                An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

                ShortAn interaction during which services are provided to the patient
                Control0..*
                Alternate NamesVisit
                Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
                dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
                dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
                2. Encounter.id
                Definition

                The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

                ShortLogical id of this artifact
                Comments

                The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

                Control0..1
                Typeid
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                4. Encounter.meta
                Definition

                The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

                ShortMetadata about the resource
                Control0..1
                TypeMeta
                Summarytrue
                6. Encounter.implicitRules
                Definition

                A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

                ShortA set of rules under which this content was created
                Comments

                Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

                This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

                Control0..1
                Typeuri
                Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                8. Encounter.language
                Definition

                The base language in which the resource is written.

                ShortLanguage of the resource content
                Comments

                Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

                Control0..1
                BindingUnless not suitable, these codes SHALL be taken from Common Languages
                (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

                A human language.

                Additional BindingsPurpose
                All LanguagesMax Binding
                Typecode
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                10. Encounter.text
                Definition

                A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                ShortText summary of the resource, for human interpretation
                Comments

                Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

                Control0..1
                This element is affected by the following invariants: dom-1
                TypeNarrative
                Alternate Namesnarrative, html, xhtml, display
                12. Encounter.contained
                Definition

                These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                ShortContained, inline Resources
                Comments

                This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

                Control0..*
                TypeResource
                Alternate Namesinline resources, anonymous resources, contained resources
                14. Encounter.extension
                Definition

                An Extension

                ShortExtension
                Control0..*
                TypeExtension
                SlicingThis element introduces a set of slices on Encounter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 16. Encounter.extension:serviceType
                  Slice NameserviceType
                  Definition

                  R4: Encounter.serviceType (new:CodeableConcept)

                  ShortR4: Specific type of service (new)
                  Comments

                  Element Encounter.serviceType has a context of Encounter based on following the parent source element upwards and mapping to Encounter. Element Encounter.serviceType has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                  Control0..1
                  This element is affected by the following invariants: ele-1
                  TypeExtension(R4: Specific type of service (new)) (Extension Type: CodeableConcept)
                  Is Modifierfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  18. Encounter.extension:reasonReference
                  Slice NamereasonReference
                  Definition

                  R4: Encounter.reasonReference (new:Reference(Condition,Procedure,Observation,ImmunizationRecommendation))

                  ShortR4: Reason the encounter takes place (reference) (new)
                  Comments

                  Element Encounter.reasonReference has a context of Encounter based on following the parent source element upwards and mapping to Encounter. Element Encounter.reasonReference has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

                  Control0..*
                  This element is affected by the following invariants: ele-1
                  TypeExtension(R4: Reason the encounter takes place (reference) (new)) (Extension Type: Reference(Cross-version Profile for R4.Condition for use in FHIR STU3, Condition, Cross-version Profile for R4.Procedure for use in FHIR STU3, Procedure, Cross-version Profile for R4.Observation for use in FHIR STU3, Observation, Cross-version Profile for R4.ImmunizationRecommendation for use in FHIR STU3, ImmunizationRecommendation))
                  Is Modifierfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  20. Encounter.modifierExtension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                  ShortExtensions that cannot be ignored
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                  Alternate Namesextensions, user content
                  22. Encounter.identifier
                  Definition

                  Identifier(s) by which this encounter is known.

                  ShortIdentifier(s) by which this encounter is known
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control0..*
                  TypeIdentifier
                  Summarytrue
                  24. Encounter.status
                  Definition

                  planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

                  Shortplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
                  Comments

                  Note that internal business rules will detemine the appropraite transitions that may occur between statuses (and also classes).

                  This element is labeled as a modifier because the status contains codes that mark the encounter as not currently valid.

                  Control1..1
                  BindingThe codes SHALL be taken from EncounterStatus
                  (required to http://hl7.org/fhir/ValueSet/encounter-status|3.0.2)

                  Current state of the encounter

                  Typecode
                  Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  26. Encounter.statusHistory
                  Definition

                  The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.

                  ShortList of past encounter statuses
                  Comments

                  The current status is always found in the current version of the resource, not the status history.

                  Control0..*
                  TypeBackboneElement
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                  28. Encounter.statusHistory.id
                  Definition

                  unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  Shortxml:id (or equivalent in JSON)
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  30. Encounter.statusHistory.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional Content defined by implementations
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Alternate Namesextensions, user content
                  32. Encounter.statusHistory.modifierExtension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                  ShortExtensions that cannot be ignored
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                  Summarytrue
                  Alternate Namesextensions, user content, modifiers
                  34. Encounter.statusHistory.status
                  Definition

                  planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

                  Shortplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
                  Control1..1
                  BindingThe codes SHALL be taken from EncounterStatus
                  (required to http://hl7.org/fhir/ValueSet/encounter-status|3.0.2)

                  Current state of the encounter

                  Typecode
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  36. Encounter.statusHistory.period
                  Definition

                  The time that the episode was in the specified status.

                  ShortThe time that the episode was in the specified status
                  Control1..1
                  TypePeriod
                  38. Encounter.class
                  Definition

                  inpatient | outpatient | ambulatory | emergency +.

                  Shortinpatient | outpatient | ambulatory | emergency +
                  Control0..1
                  BindingUnless not suitable, these codes SHALL be taken from ActEncounterCode|2014-03-26
                  (extensible to http://hl7.org/fhir/ValueSet/v3-ActEncounterCode|2014-03-26)

                  Classification of the encounter

                  TypeCoding
                  Summarytrue
                  40. Encounter.classHistory
                  Definition

                  The class history permits the tracking of the encounters transitions without needing to go through the resource history.

                  This would be used for a case where an admission starts of as an emergency encounter, then transisions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kindof discharge from emergency to inpatient.

                  ShortList of past encounter classes
                  Control0..*
                  TypeBackboneElement
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                  42. Encounter.classHistory.id
                  Definition

                  unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  Shortxml:id (or equivalent in JSON)
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  44. Encounter.classHistory.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional Content defined by implementations
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Alternate Namesextensions, user content
                  46. Encounter.classHistory.modifierExtension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                  ShortExtensions that cannot be ignored
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                  Summarytrue
                  Alternate Namesextensions, user content, modifiers
                  48. Encounter.classHistory.class
                  Definition

                  inpatient | outpatient | ambulatory | emergency +.

                  Shortinpatient | outpatient | ambulatory | emergency +
                  Control1..1
                  BindingUnless not suitable, these codes SHALL be taken from ActEncounterCode|2014-03-26
                  (extensible to http://hl7.org/fhir/ValueSet/v3-ActEncounterCode|2014-03-26)

                  Classification of the encounter

                  TypeCoding
                  50. Encounter.classHistory.period
                  Definition

                  The time that the episode was in the specified class.

                  ShortThe time that the episode was in the specified class
                  Control1..1
                  TypePeriod
                  52. Encounter.type
                  Definition

                  Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

                  ShortSpecific type of encounter
                  Comments

                  Since there are many ways to further classify encounters, this element is 0..*.

                  Control0..*
                  BindingFor example codes, see EncounterType
                  (example to http://hl7.org/fhir/ValueSet/encounter-type|3.0.2)

                  The type of encounter

                  TypeCodeableConcept
                  Summarytrue
                  54. Encounter.priority
                  Definition

                  Indicates the urgency of the encounter.

                  ShortIndicates the urgency of the encounter
                  Control0..1
                  BindingFor example codes, see ActPriority|2016-11-11
                  (example to http://hl7.org/fhir/ValueSet/v3-ActPriority|2016-11-11)

                  Indicates the urgency of the encounter.

                  TypeCodeableConcept
                  56. Encounter.subject
                  Definition

                  The patient ro group present at the encounter.

                  ShortThe patient ro group present at the encounter
                  Comments

                  While the encounter is always about the patient, the patient may not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked).

                  Control0..1
                  TypeReference(Patient, Group)
                  Summarytrue
                  Alternate Namespatient
                  58. Encounter.episodeOfCare
                  Definition

                  Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).

                  ShortEpisode(s) of care that this encounter should be recorded against
                  Control0..*
                  TypeReference(EpisodeOfCare)
                  Summarytrue
                  60. Encounter.incomingReferral
                  Definition

                  The referral request this encounter satisfies (incoming referral).

                  ShortThe ReferralRequest that initiated this encounter
                  Control0..*
                  TypeReference(ReferralRequest)
                  62. Encounter.incomingReferral.id
                  Definition

                  unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  Shortxml:id (or equivalent in JSON)
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  64. Encounter.incomingReferral.extension
                  Definition

                  An Extension

                  ShortExtension
                  Control0..*
                  TypeExtension
                  SlicingThis element introduces a set of slices on Encounter.incomingReferral.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 66. Encounter.incomingReferral.extension:basedOn
                    Slice NamebasedOn
                    Definition

                    R4: Encounter.basedOn additional types from child elements (display, identifier, reference, type)

                    ShortR4: The ServiceRequest that initiated this encounter additional types
                    Comments

                    Element Encounter.basedOn is mapped to FHIR STU3 element Encounter.incomingReferral as SourceIsBroaderThanTarget. The mappings for Encounter.basedOn do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R4 element Encounter.basedOn with unmapped reference targets: ServiceRequest.

                    Control0..*
                    TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                    68. Encounter.incomingReferral.reference
                    Definition

                    A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                    ShortLiteral reference, Relative, internal or absolute URL
                    Comments

                    Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                    Control0..1
                    This element is affected by the following invariants: ref-1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    70. Encounter.incomingReferral.identifier
                    Definition

                    An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                    ShortLogical reference, when literal reference is not known
                    Comments

                    When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                    When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                    Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control0..1
                    TypeIdentifier
                    Summarytrue
                    72. Encounter.incomingReferral.display
                    Definition

                    Plain text narrative that identifies the resource in addition to the resource reference.

                    ShortText alternative for the resource
                    Comments

                    This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    74. Encounter.participant
                    Definition

                    The list of people responsible for providing the service.

                    ShortList of participants involved in the encounter
                    Control0..*
                    TypeBackboneElement
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                    76. Encounter.participant.id
                    Definition

                    unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    Shortxml:id (or equivalent in JSON)
                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    78. Encounter.participant.extension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional Content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Alternate Namesextensions, user content
                    80. Encounter.participant.modifierExtension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                    ShortExtensions that cannot be ignored
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                    Summarytrue
                    Alternate Namesextensions, user content, modifiers
                    82. Encounter.participant.type
                    Definition

                    Role of participant in encounter.

                    ShortRole of participant in encounter
                    Comments

                    The participant type indicates how an individual partitipates in an encounter. It includes non-practitioner participants, and for practitioners this is to describe the action type in the context of this encounter (e.g. Admitting Dr, Attending Dr, Translator, Consulting Dr). This is different to the practitioner roles which are functional roles, derived from terms of employment, education, licensing, etc.

                    Control0..*
                    BindingUnless not suitable, these codes SHALL be taken from ParticipantType
                    (extensible to http://hl7.org/fhir/ValueSet/encounter-participant-type|3.0.2)

                    Role of participant in encounter

                    TypeCodeableConcept
                    Summarytrue
                    84. Encounter.participant.period
                    Definition

                    The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.

                    ShortPeriod of time during the encounter that the participant participated
                    Control0..1
                    TypePeriod
                    86. Encounter.participant.individual
                    Definition

                    Persons involved in the encounter other than the patient.

                    ShortPersons involved in the encounter other than the patient
                    Control0..1
                    TypeReference(Practitioner, RelatedPerson)
                    Summarytrue
                    88. Encounter.participant.individual.id
                    Definition

                    unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    Shortxml:id (or equivalent in JSON)
                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    90. Encounter.participant.individual.extension
                    Definition

                    An Extension

                    ShortExtension
                    Control0..*
                    TypeExtension
                    SlicingThis element introduces a set of slices on Encounter.participant.individual.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 92. Encounter.participant.individual.extension:individual
                      Slice Nameindividual
                      Definition

                      R4: Encounter.participant.individual

                      ShortR4: individual
                      Comments

                      Element Encounter.participant.individual is mapped to FHIR STU3 element Encounter.participant.individual as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R4 element Encounter.participant.individual with unmapped reference targets: PractitionerRole.

                      Control0..1
                      TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                      94. Encounter.participant.individual.reference
                      Definition

                      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                      ShortLiteral reference, Relative, internal or absolute URL
                      Comments

                      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                      Control0..1
                      This element is affected by the following invariants: ref-1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      96. Encounter.participant.individual.identifier
                      Definition

                      An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                      ShortLogical reference, when literal reference is not known
                      Comments

                      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                      NoteThis is a business identifier, not a resource identifier (see discussion)
                      Control0..1
                      TypeIdentifier
                      Summarytrue
                      98. Encounter.participant.individual.display
                      Definition

                      Plain text narrative that identifies the resource in addition to the resource reference.

                      ShortText alternative for the resource
                      Comments

                      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                      Control0..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      100. Encounter.appointment
                      Definition

                      The appointment that scheduled this encounter.

                      ShortThe appointment that scheduled this encounter
                      Control0..1
                      TypeReference(Appointment)
                      Summarytrue
                      102. Encounter.period
                      Definition

                      The start and end time of the encounter.

                      ShortThe start and end time of the encounter
                      Comments

                      If not (yet) known, the end of the Period may be omitted.

                      Control0..1
                      TypePeriod
                      104. Encounter.length
                      Definition

                      Quantity of time the encounter lasted. This excludes the time during leaves of absence.

                      ShortQuantity of time the encounter lasted (less time absent)
                      Comments

                      May differ from the time the Encounter.period lasted because of leave of absence.

                      Control0..1
                      TypeDuration
                      106. Encounter.reason
                      Definition

                      Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

                      ShortReason the encounter takes place (code)
                      Comments

                      For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

                      Control0..*
                      BindingThe codes SHOULD be taken from Encounter Reason Codes
                      (preferred to http://hl7.org/fhir/ValueSet/encounter-reason|3.0.2)

                      Reason why the encounter takes place.

                      TypeCodeableConcept
                      Summarytrue
                      Alternate NamesIndication, Admission diagnosis
                      108. Encounter.diagnosis
                      Definition

                      The list of diagnosis relevant to this encounter.

                      ShortThe list of diagnosis relevant to this encounter
                      Control0..*
                      TypeBackboneElement
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                      110. Encounter.diagnosis.id
                      Definition

                      unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      Shortxml:id (or equivalent in JSON)
                      Control0..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      XML FormatIn the XML format, this property is represented as an attribute.
                      112. Encounter.diagnosis.extension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                      ShortAdditional Content defined by implementations
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Alternate Namesextensions, user content
                      114. Encounter.diagnosis.modifierExtension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                      ShortExtensions that cannot be ignored
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                      Summarytrue
                      Alternate Namesextensions, user content, modifiers
                      116. Encounter.diagnosis.condition
                      Definition

                      Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

                      ShortReason the encounter takes place (resource)
                      Comments

                      For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

                      Control1..1
                      TypeReference(Condition, Procedure)
                      Alternate NamesAdmission diagnosis, discharge diagnosis, indication
                      118. Encounter.diagnosis.role
                      Definition

                      Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).

                      ShortRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
                      Control0..1
                      BindingThe codes SHOULD be taken from DiagnosisRole
                      (preferred to http://hl7.org/fhir/ValueSet/diagnosis-role|3.0.2)

                      The type of diagnosis this condition represents

                      TypeCodeableConcept
                      120. Encounter.diagnosis.rank
                      Definition

                      Ranking of the diagnosis (for each role type).

                      ShortRanking of the diagnosis (for each role type)
                      Control0..1
                      TypepositiveInt
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      122. Encounter.account
                      Definition

                      The set of accounts that may be used for billing for this Encounter.

                      ShortThe set of accounts that may be used for billing for this Encounter
                      Comments

                      The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules.

                      Control0..*
                      TypeReference(Account)
                      124. Encounter.hospitalization
                      Definition

                      Details about the admission to a healthcare service.

                      ShortDetails about the admission to a healthcare service
                      Comments

                      An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included.

                      The duration recorded in the period of this encounter covers the entire scope of this hospitalization record.

                      Control0..1
                      TypeBackboneElement
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                      126. Encounter.hospitalization.id
                      Definition

                      unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      Shortxml:id (or equivalent in JSON)
                      Control0..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      XML FormatIn the XML format, this property is represented as an attribute.
                      128. Encounter.hospitalization.extension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                      ShortAdditional Content defined by implementations
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Alternate Namesextensions, user content
                      130. Encounter.hospitalization.modifierExtension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                      ShortExtensions that cannot be ignored
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                      Summarytrue
                      Alternate Namesextensions, user content, modifiers
                      132. Encounter.hospitalization.preAdmissionIdentifier
                      Definition

                      Pre-admission identifier.

                      ShortPre-admission identifier
                      Control0..1
                      TypeIdentifier
                      134. Encounter.hospitalization.origin
                      Definition

                      The location from which the patient came before admission.

                      ShortThe location from which the patient came before admission
                      Control0..1
                      TypeReference(Location)
                      136. Encounter.hospitalization.origin.id
                      Definition

                      unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      Shortxml:id (or equivalent in JSON)
                      Control0..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      XML FormatIn the XML format, this property is represented as an attribute.
                      138. Encounter.hospitalization.origin.extension
                      Definition

                      An Extension

                      ShortExtension
                      Control0..*
                      TypeExtension
                      SlicingThis element introduces a set of slices on Encounter.hospitalization.origin.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 140. Encounter.hospitalization.origin.extension:origin
                        Slice Nameorigin
                        Definition

                        R4: Encounter.hospitalization.origin additional types from child elements (display, identifier, reference, type)

                        ShortR4: The location/organization from which the patient came before admission additional types
                        Comments

                        Element Encounter.hospitalization.origin is mapped to FHIR STU3 element Encounter.hospitalization.origin as SourceIsBroaderThanTarget. The mappings for Encounter.hospitalization.origin do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R4 element Encounter.hospitalization.origin with unmapped reference targets: Organization.

                        Control0..1
                        TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                        142. Encounter.hospitalization.origin.reference
                        Definition

                        A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                        ShortLiteral reference, Relative, internal or absolute URL
                        Comments

                        Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                        Control0..1
                        This element is affected by the following invariants: ref-1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        144. Encounter.hospitalization.origin.identifier
                        Definition

                        An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                        ShortLogical reference, when literal reference is not known
                        Comments

                        When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                        When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                        Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                        NoteThis is a business identifier, not a resource identifier (see discussion)
                        Control0..1
                        TypeIdentifier
                        Summarytrue
                        146. Encounter.hospitalization.origin.display
                        Definition

                        Plain text narrative that identifies the resource in addition to the resource reference.

                        ShortText alternative for the resource
                        Comments

                        This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                        Control0..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        148. Encounter.hospitalization.admitSource
                        Definition

                        From where patient was admitted (physician referral, transfer).

                        ShortFrom where patient was admitted (physician referral, transfer)
                        Control0..1
                        BindingThe codes SHOULD be taken from AdmitSource
                        (preferred to http://hl7.org/fhir/ValueSet/encounter-admit-source|3.0.2)

                        From where the patient was admitted.

                        TypeCodeableConcept
                        150. Encounter.hospitalization.reAdmission
                        Definition

                        Whether this hospitalization is a readmission and why if known.

                        ShortThe type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
                        Control0..1
                        BindingFor example codes, see v2 Re-Admission Indicator
                        (example to http://hl7.org/fhir/ValueSet/v2-0092|2.8.2)

                        The reason for re-admission of this hospitalization encounter.

                        TypeCodeableConcept
                        152. Encounter.hospitalization.dietPreference
                        Definition

                        Diet preferences reported by the patient.

                        ShortDiet preferences reported by the patient
                        Comments

                        For example a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive).

                        Control0..*
                        BindingFor example codes, see Diet
                        (example to http://hl7.org/fhir/ValueSet/encounter-diet|3.0.2)

                        Medical, cultural or ethical food preferences to help with catering requirements.

                        TypeCodeableConcept
                        Requirements

                        Used to track patient's diet restrictions and/or preference. For a complete description of the nutrition needs of a patient during their stay, one should use the nutritionOrder resource which links to Encounter.

                        154. Encounter.hospitalization.specialCourtesy
                        Definition

                        Special courtesies (VIP, board member).

                        ShortSpecial courtesies (VIP, board member)
                        Control0..*
                        BindingThe codes SHOULD be taken from SpecialCourtesy
                        (preferred to http://hl7.org/fhir/ValueSet/encounter-special-courtesy|3.0.2)

                        Special courtesies

                        TypeCodeableConcept
                        156. Encounter.hospitalization.specialArrangement
                        Definition

                        Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.

                        ShortWheelchair, translator, stretcher, etc.
                        Control0..*
                        BindingThe codes SHOULD be taken from SpecialArrangements
                        (preferred to http://hl7.org/fhir/ValueSet/encounter-special-arrangements|3.0.2)

                        Special arrangements

                        TypeCodeableConcept
                        158. Encounter.hospitalization.destination
                        Definition

                        Location to which the patient is discharged.

                        ShortLocation to which the patient is discharged
                        Control0..1
                        TypeReference(Location)
                        160. Encounter.hospitalization.destination.id
                        Definition

                        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        Shortxml:id (or equivalent in JSON)
                        Control0..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        XML FormatIn the XML format, this property is represented as an attribute.
                        162. Encounter.hospitalization.destination.extension
                        Definition

                        An Extension

                        ShortExtension
                        Control0..*
                        TypeExtension
                        SlicingThis element introduces a set of slices on Encounter.hospitalization.destination.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 164. Encounter.hospitalization.destination.extension:destination
                          Slice Namedestination
                          Definition

                          R4: Encounter.hospitalization.destination additional types from child elements (display, identifier, reference, type)

                          ShortR4: Location/organization to which the patient is discharged additional types
                          Comments

                          Element Encounter.hospitalization.destination is mapped to FHIR STU3 element Encounter.hospitalization.destination as SourceIsBroaderThanTarget. The mappings for Encounter.hospitalization.destination do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R4 element Encounter.hospitalization.destination with unmapped reference targets: Organization.

                          Control0..1
                          TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                          166. Encounter.hospitalization.destination.reference
                          Definition

                          A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                          ShortLiteral reference, Relative, internal or absolute URL
                          Comments

                          Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                          Control0..1
                          This element is affected by the following invariants: ref-1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          168. Encounter.hospitalization.destination.identifier
                          Definition

                          An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                          ShortLogical reference, when literal reference is not known
                          Comments

                          When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                          When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                          Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                          NoteThis is a business identifier, not a resource identifier (see discussion)
                          Control0..1
                          TypeIdentifier
                          Summarytrue
                          170. Encounter.hospitalization.destination.display
                          Definition

                          Plain text narrative that identifies the resource in addition to the resource reference.

                          ShortText alternative for the resource
                          Comments

                          This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                          Control0..1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          172. Encounter.hospitalization.dischargeDisposition
                          Definition

                          Category or kind of location after discharge.

                          ShortCategory or kind of location after discharge
                          Control0..1
                          BindingFor example codes, see DischargeDisposition
                          (example to http://hl7.org/fhir/ValueSet/encounter-discharge-disposition|3.0.2)

                          Discharge Disposition

                          TypeCodeableConcept
                          174. Encounter.location
                          Definition

                          List of locations where the patient has been during this encounter.

                          ShortList of locations where the patient has been
                          Comments

                          Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual".

                          Control0..*
                          TypeBackboneElement
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                          176. Encounter.location.id
                          Definition

                          unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          Shortxml:id (or equivalent in JSON)
                          Control0..1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          XML FormatIn the XML format, this property is represented as an attribute.
                          178. Encounter.location.extension
                          Definition

                          An Extension

                          ShortExtension
                          Control0..*
                          TypeExtension
                          SlicingThis element introduces a set of slices on Encounter.location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 180. Encounter.location.extension:physicalType
                            Slice NamephysicalType
                            Definition

                            R4: Encounter.location.physicalType (new:CodeableConcept)

                            ShortR4: The physical type of the location (usually the level in the location hierachy - bed room ward etc.) (new)
                            Comments

                            Element Encounter.location.physicalType has a context of Encounter.location based on following the parent source element upwards and mapping to Encounter. Element Encounter.location.physicalType has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query.

                            There may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario.

                            Control0..1
                            This element is affected by the following invariants: ele-1
                            TypeExtension(R4: The physical type of the location (usually the level in the location hierachy - bed room ward etc.) (new)) (Extension Type: CodeableConcept)
                            Is Modifierfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            182. Encounter.location.modifierExtension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                            ShortExtensions that cannot be ignored
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                            Summarytrue
                            Alternate Namesextensions, user content, modifiers
                            184. Encounter.location.location
                            Definition

                            The location where the encounter takes place.

                            ShortLocation the encounter takes place
                            Control1..1
                            TypeReference(Location)
                            186. Encounter.location.status
                            Definition

                            The status of the participants' presence at the specified location during the period specified. If the participant is is no longer at the location, then the period will have an end date/time.

                            Shortplanned | active | reserved | completed
                            Comments

                            When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed.

                            Control0..1
                            BindingThe codes SHALL be taken from EncounterLocationStatus
                            (required to http://hl7.org/fhir/ValueSet/encounter-location-status|3.0.2)

                            The status of the location.

                            Typecode
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            188. Encounter.location.period
                            Definition

                            Time period during which the patient was present at the location.

                            ShortTime period during which the patient was present at the location
                            Control0..1
                            TypePeriod
                            190. Encounter.serviceProvider
                            Definition

                            An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.

                            ShortThe custodian organization of this Encounter record
                            Control0..1
                            TypeReference(Organization)
                            192. Encounter.partOf
                            Definition

                            Another Encounter of which this encounter is a part of (administratively or in time).

                            ShortAnother Encounter this encounter is part of
                            Comments

                            This is also used for associating a child's encounter back to the mother's encounter.

                            Refer to the Notes section in the Patient resource for further details.

                            Control0..1
                            TypeReference(Encounter)