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

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

Resource Profile: Profile_R2_Encounter_R4 - 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..*
Is Modifierfalse
Summaryfalse
Alternate NamesVisit
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Encounter.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. 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 can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
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:indication
    Slice Nameindication
    Definition

    DSTU2: Encounter.indication additional types from child elements (display, reference)

    ShortDSTU2: Reason the encounter takes place (resource) additional types
    Comments

    Element Encounter.indication is mapped to FHIR R4 element Encounter.reasonCode as SourceIsBroaderThanTarget. Element Encounter.indication is mapped to FHIR R4 element Encounter.diagnosis.condition as SourceIsBroaderThanTarget. The mappings for Encounter.indication do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Encounter.indication with unmapped reference targets: Condition, Procedure. 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(Alternate Reference) (Extension Type: Reference(Resource))
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Encounter.extension:dischargeDiagnosis
    Slice NamedischargeDiagnosis
    Definition

    DSTU2: Encounter.hospitalization.dischargeDiagnosis (new:Reference(Condition))

    ShortDSTU2: The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete (new)
    Comments

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

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(DSTU2: The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Condition for use in FHIR R4, Condition))
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    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 Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    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 determine the appropriate transitions that may occur between statuses (and also classes).

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

    Current state of the encounter.

    Typecode
    Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Encounter.class
    Definition

    Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

    ShortClassification of patient encounter
    Control1..1
    BindingUnless not suitable, these codes SHALL be taken from ActEncounterCode (3.0.0)http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
    (extensible to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode|3.0.0)

    Classification of the encounter.

    TypeCoding
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Encounter.class.extension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the element. 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 can 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
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on Encounter.class.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 18. Encounter.class.extension:class
      Slice Nameclass
      Definition

      DSTU2: Encounter.class additional codes

      ShortDSTU2: inpatient | outpatient | ambulatory | emergency + additional codes
      Comments

      Element Encounter.class is mapped to FHIR R4 element Encounter.class as RelatedTo. The mappings for Encounter.class do not allow expression of the necessary codes, per the bindings on the source and target.

      Control0..1
      TypeExtension(DSTU2: inpatient | outpatient | ambulatory | emergency + additional codes) (Extension Type: code)
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

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

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

        DSTU2: Encounter.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

        ShortDSTU2: meta additional types
        Comments

        Element Encounter.meta is mapped to FHIR R4 element Encounter.meta as SourceIsBroaderThanTarget. The mappings for Encounter.meta do not cover the following types: Meta. The mappings for Encounter.meta do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.

        Control0..1
        TypeExtension(DSTU2: meta additional types) (Extension Type: Meta)
        8. Encounter.text
        10. Encounter.text.extension
        Control0..*
        SlicingThis element introduces a set of slices on Encounter.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 12. Encounter.text.extension:text
          Slice Nametext
          Definition

          DSTU2: Encounter.text additional types (Narrative) additional types from child elements (div, status)

          ShortDSTU2: text additional types
          Comments

          Element Encounter.text is mapped to FHIR R4 element Encounter.text as SourceIsBroaderThanTarget. The mappings for Encounter.text do not cover the following types: Narrative. The mappings for Encounter.text do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

          Control0..1
          TypeExtension(DSTU2: text additional types) (Complex Extension)
          14. 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
          • 16. Encounter.extension:indication
            Slice Nameindication
            Definition

            DSTU2: Encounter.indication additional types from child elements (display, reference)

            ShortDSTU2: Reason the encounter takes place (resource) additional types
            Comments

            Element Encounter.indication is mapped to FHIR R4 element Encounter.reasonCode as SourceIsBroaderThanTarget. Element Encounter.indication is mapped to FHIR R4 element Encounter.diagnosis.condition as SourceIsBroaderThanTarget. The mappings for Encounter.indication do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Encounter.indication with unmapped reference targets: Condition, Procedure. 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(Alternate Reference) (Extension Type: Reference(Resource))
            18. Encounter.extension:dischargeDiagnosis
            Slice NamedischargeDiagnosis
            Definition

            DSTU2: Encounter.hospitalization.dischargeDiagnosis (new:Reference(Condition))

            ShortDSTU2: The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete (new)
            Comments

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

            Control0..*
            TypeExtension(DSTU2: The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Condition for use in FHIR R4, Condition))
            20. Encounter.identifier
            NoteThis is a business identifier, not a resource identifier (see discussion)
            22. Encounter.identifier.extension
            Control0..*
            SlicingThis element introduces a set of slices on Encounter.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 24. Encounter.identifier.extension:identifier
              Slice Nameidentifier
              Definition

              DSTU2: Encounter.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

              ShortDSTU2: identifier additional types
              Comments

              Element Encounter.identifier is mapped to FHIR R4 element Encounter.identifier as SourceIsBroaderThanTarget. The mappings for Encounter.identifier do not cover the following types: Identifier. The mappings for Encounter.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

              Control0..*
              TypeExtension(DSTU2: identifier additional types) (Extension Type: Identifier)
              26. Encounter.statusHistory
              28. Encounter.statusHistory.period
              30. Encounter.statusHistory.period.extension
              Control0..*
              SlicingThis element introduces a set of slices on Encounter.statusHistory.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 32. Encounter.statusHistory.period.extension:period
                Slice Nameperiod
                Definition

                DSTU2: Encounter.statusHistory.period additional types (Period) additional types from child elements (end, start)

                ShortDSTU2: period additional types
                Comments

                Element Encounter.statusHistory.period is mapped to FHIR R4 element Encounter.statusHistory.period as SourceIsBroaderThanTarget. The mappings for Encounter.statusHistory.period do not cover the following types: Period. The mappings for Encounter.statusHistory.period do not cover the following types based on type expansion: end, start.

                Control0..1
                TypeExtension(DSTU2: period additional types) (Extension Type: Period)
                34. Encounter.class
                36. Encounter.class.extension
                Control0..*
                SlicingThis element introduces a set of slices on Encounter.class.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 38. Encounter.class.extension:class
                  Slice Nameclass
                  Definition

                  DSTU2: Encounter.class additional codes

                  ShortDSTU2: inpatient | outpatient | ambulatory | emergency + additional codes
                  Comments

                  Element Encounter.class is mapped to FHIR R4 element Encounter.class as RelatedTo. The mappings for Encounter.class do not allow expression of the necessary codes, per the bindings on the source and target.

                  Control0..1
                  TypeExtension(DSTU2: inpatient | outpatient | ambulatory | emergency + additional codes) (Extension Type: code)
                  40. Encounter.subject
                  42. Encounter.subject.extension
                  Control0..*
                  SlicingThis element introduces a set of slices on Encounter.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 44. Encounter.subject.extension:patient
                    Slice Namepatient
                    Definition

                    DSTU2: Encounter.patient additional types from child elements (display, reference)

                    ShortDSTU2: The patient present at the encounter additional types
                    Comments

                    Element Encounter.patient is mapped to FHIR R4 element Encounter.subject as SourceIsBroaderThanTarget. The mappings for Encounter.patient do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Encounter.patient with unmapped reference targets: Patient. While the encounter is always about the patient, the patient may not actually be known in all contexts of use.

                    Control0..1
                    TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                    46. Encounter.episodeOfCare
                    48. Encounter.episodeOfCare.extension
                    Control0..*
                    SlicingThis element introduces a set of slices on Encounter.episodeOfCare.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 50. Encounter.episodeOfCare.extension:episodeOfCare
                      Slice NameepisodeOfCare
                      Definition

                      DSTU2: Encounter.episodeOfCare additional types from child elements (display, reference)

                      ShortDSTU2: episodeOfCare additional types
                      Comments

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

                      Control0..*
                      TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                      52. Encounter.basedOn
                      54. Encounter.basedOn.extension
                      Control0..*
                      SlicingThis element introduces a set of slices on Encounter.basedOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 56. Encounter.basedOn.extension:incomingReferral
                        Slice NameincomingReferral
                        Definition

                        DSTU2: Encounter.incomingReferral additional types from child elements (display, reference)

                        ShortDSTU2: The ReferralRequest that initiated this encounter additional types
                        Comments

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

                        Control0..*
                        TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                        58. Encounter.participant
                        60. Encounter.participant.period
                        62. Encounter.participant.period.extension
                        Control0..*
                        SlicingThis element introduces a set of slices on Encounter.participant.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 64. Encounter.participant.period.extension:period
                          Slice Nameperiod
                          Definition

                          DSTU2: Encounter.participant.period additional types (Period) additional types from child elements (end, start)

                          ShortDSTU2: Period of time during the encounter participant was present additional types
                          Comments

                          Element Encounter.participant.period is mapped to FHIR R4 element Encounter.participant.period as SourceIsBroaderThanTarget. The mappings for Encounter.participant.period do not cover the following types: Period. The mappings for Encounter.participant.period do not cover the following types based on type expansion: end, start.

                          Control0..1
                          TypeExtension(DSTU2: Period of time during the encounter participant was present additional types) (Extension Type: Period)
                          66. Encounter.participant.individual
                          68. 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
                          • 70. Encounter.participant.individual.extension:individual
                            Slice Nameindividual
                            Definition

                            DSTU2: Encounter.participant.individual additional types from child elements (display, reference)

                            ShortDSTU2: individual additional types
                            Comments

                            Element Encounter.participant.individual is mapped to FHIR R4 element Encounter.participant.individual as RelatedTo. The mappings for Encounter.participant.individual do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Encounter.participant.individual with unmapped reference targets: Practitioner, RelatedPerson.

                            Control0..1
                            TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                            72. Encounter.appointment
                            74. Encounter.appointment.extension
                            Control0..*
                            SlicingThis element introduces a set of slices on Encounter.appointment.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 76. Encounter.appointment.extension:appointment
                              Slice Nameappointment
                              Definition

                              DSTU2: Encounter.appointment additional types from child elements (display, reference)

                              ShortDSTU2: appointment additional types
                              Comments

                              Element Encounter.appointment is mapped to FHIR R4 element Encounter.appointment as RelatedTo. The mappings for Encounter.appointment do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Encounter.appointment with unmapped reference targets: Appointment.

                              Control0..1
                              TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                              78. Encounter.period
                              80. Encounter.period.extension
                              Control0..*
                              SlicingThis element introduces a set of slices on Encounter.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 82. Encounter.period.extension:period
                                Slice Nameperiod
                                Definition

                                DSTU2: Encounter.period additional types (Period) additional types from child elements (end, start)

                                ShortDSTU2: period additional types
                                Comments

                                Element Encounter.period is mapped to FHIR R4 element Encounter.period as SourceIsBroaderThanTarget. The mappings for Encounter.period do not cover the following types: Period. The mappings for Encounter.period do not cover the following types based on type expansion: end, start. If not (yet) known, the end of the Period may be omitted.

                                Control0..1
                                TypeExtension(DSTU2: period additional types) (Extension Type: Period)
                                84. Encounter.diagnosis
                                86. Encounter.diagnosis.condition
                                88. Encounter.diagnosis.condition.extension
                                Control0..*
                                SlicingThis element introduces a set of slices on Encounter.diagnosis.condition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 90. Encounter.diagnosis.condition.extension:admittingDiagnosis
                                  Slice NameadmittingDiagnosis
                                  Definition

                                  DSTU2: Encounter.hospitalization.admittingDiagnosis additional types from child elements (display, reference)

                                  ShortDSTU2: The admitting diagnosis as reported by admitting practitioner additional types
                                  Comments

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

                                  Control0..*
                                  TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                  92. Encounter.hospitalization
                                  94. Encounter.hospitalization.preAdmissionIdentifier
                                  96. Encounter.hospitalization.preAdmissionIdentifier.extension
                                  Control0..*
                                  SlicingThis element introduces a set of slices on Encounter.hospitalization.preAdmissionIdentifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 98. Encounter.hospitalization.preAdmissionIdentifier.extension:preAdmissionIdentifier
                                    Slice NamepreAdmissionIdentifier
                                    Definition

                                    DSTU2: Encounter.hospitalization.preAdmissionIdentifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

                                    ShortDSTU2: preAdmissionIdentifier additional types
                                    Comments

                                    Element Encounter.hospitalization.preAdmissionIdentifier is mapped to FHIR R4 element Encounter.hospitalization.preAdmissionIdentifier as SourceIsBroaderThanTarget. The mappings for Encounter.hospitalization.preAdmissionIdentifier do not cover the following types: Identifier. The mappings for Encounter.hospitalization.preAdmissionIdentifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

                                    Control0..1
                                    TypeExtension(DSTU2: preAdmissionIdentifier additional types) (Extension Type: Identifier)
                                    100. Encounter.hospitalization.origin
                                    102. 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
                                    • 104. Encounter.hospitalization.origin.extension:origin
                                      Slice Nameorigin
                                      Definition

                                      DSTU2: Encounter.hospitalization.origin additional types from child elements (display, reference)

                                      ShortDSTU2: The location from which the patient came before admission additional types
                                      Comments

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

                                      Control0..1
                                      TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                      106. Encounter.hospitalization.destination
                                      108. 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
                                      • 110. Encounter.hospitalization.destination.extension:destination
                                        Slice Namedestination
                                        Definition

                                        DSTU2: Encounter.hospitalization.destination additional types from child elements (display, reference)

                                        ShortDSTU2: Location to which the patient is discharged additional types
                                        Comments

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

                                        Control0..1
                                        TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                        112. Encounter.location
                                        114. Encounter.location.location
                                        116. Encounter.location.location.extension
                                        Control0..*
                                        SlicingThis element introduces a set of slices on Encounter.location.location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 118. Encounter.location.location.extension:location
                                          Slice Namelocation
                                          Definition

                                          DSTU2: Encounter.location.location additional types from child elements (display, reference)

                                          ShortDSTU2: location additional types
                                          Comments

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

                                          Control0..1
                                          TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                          120. Encounter.location.period
                                          122. Encounter.location.period.extension
                                          Control0..*
                                          SlicingThis element introduces a set of slices on Encounter.location.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 124. Encounter.location.period.extension:period
                                            Slice Nameperiod
                                            Definition

                                            DSTU2: Encounter.location.period additional types (Period) additional types from child elements (end, start)

                                            ShortDSTU2: period additional types
                                            Comments

                                            Element Encounter.location.period is mapped to FHIR R4 element Encounter.location.period as SourceIsBroaderThanTarget. The mappings for Encounter.location.period do not cover the following types: Period. The mappings for Encounter.location.period do not cover the following types based on type expansion: end, start.

                                            Control0..1
                                            TypeExtension(DSTU2: period additional types) (Extension Type: Period)
                                            126. Encounter.serviceProvider
                                            128. Encounter.serviceProvider.extension
                                            Control0..*
                                            SlicingThis element introduces a set of slices on Encounter.serviceProvider.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 130. Encounter.serviceProvider.extension:serviceProvider
                                              Slice NameserviceProvider
                                              Definition

                                              DSTU2: Encounter.serviceProvider additional types from child elements (display, reference)

                                              ShortDSTU2: The custodian organization of this Encounter record additional types
                                              Comments

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

                                              Control0..1
                                              TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                              132. Encounter.partOf
                                              134. Encounter.partOf.extension
                                              Control0..*
                                              SlicingThis element introduces a set of slices on Encounter.partOf.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 136. Encounter.partOf.extension:partOf
                                                Slice NamepartOf
                                                Definition

                                                DSTU2: Encounter.partOf additional types from child elements (display, reference)

                                                ShortDSTU2: partOf additional types
                                                Comments

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

                                                Control0..1
                                                TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))

                                                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..*
                                                Is Modifierfalse
                                                Summaryfalse
                                                Alternate NamesVisit
                                                Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                                                dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                                                dom-6: A resource should have narrative for robust management (text.`div`.exists())
                                                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
                                                Is Modifierfalse
                                                Summarytrue
                                                4. Encounter.meta
                                                Definition

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

                                                ShortMetadata about the resource
                                                Control0..1
                                                TypeMeta
                                                Is Modifierfalse
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                6. Encounter.meta.id
                                                Definition

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

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                8. Encounter.meta.extension
                                                Definition

                                                An Extension

                                                ShortExtension
                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                SlicingThis element introduces a set of slices on Encounter.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 10. Encounter.meta.extension:meta
                                                  Slice Namemeta
                                                  Definition

                                                  DSTU2: Encounter.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

                                                  ShortDSTU2: meta additional types
                                                  Comments

                                                  Element Encounter.meta is mapped to FHIR R4 element Encounter.meta as SourceIsBroaderThanTarget. The mappings for Encounter.meta do not cover the following types: Meta. The mappings for Encounter.meta do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.

                                                  Control0..1
                                                  TypeExtension(DSTU2: meta additional types) (Extension Type: Meta)
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  12. Encounter.meta.versionId
                                                  Definition

                                                  The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

                                                  ShortVersion specific identifier
                                                  Comments

                                                  The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

                                                  Control0..1
                                                  Typeid
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  14. Encounter.meta.lastUpdated
                                                  Definition

                                                  When the resource last changed - e.g. when the version changed.

                                                  ShortWhen the resource version last changed
                                                  Comments

                                                  This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

                                                  Control0..1
                                                  Typeinstant
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  16. Encounter.meta.source
                                                  Definition

                                                  A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

                                                  ShortIdentifies where the resource comes from
                                                  Comments

                                                  In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

                                                  This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

                                                  Control0..1
                                                  Typeuri
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  18. Encounter.meta.profile
                                                  Definition

                                                  A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

                                                  ShortProfiles this resource claims to conform to
                                                  Comments

                                                  It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

                                                  Control0..*
                                                  Typecanonical(StructureDefinition)
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  20. Encounter.meta.security
                                                  Definition

                                                  Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

                                                  ShortSecurity Labels applied to this resource
                                                  Comments

                                                  The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

                                                  Control0..*
                                                  BindingUnless not suitable, these codes SHALL be taken from All Security Labels .
                                                  (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)

                                                  Security Labels from the Healthcare Privacy and Security Classification System.

                                                  TypeCoding
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  22. Encounter.meta.tag
                                                  Definition

                                                  Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

                                                  ShortTags applied to this resource
                                                  Comments

                                                  The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

                                                  Control0..*
                                                  BindingFor example codes, see CommonTags
                                                  (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

                                                  Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

                                                  TypeCoding
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  24. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                                                  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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                                                  Control0..1
                                                  Typeuri
                                                  Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  26. 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
                                                  BindingThe codes SHOULD be taken from CommonLanguages
                                                  (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

                                                  A human language.

                                                  Additional BindingsPurpose
                                                  AllLanguagesMax Binding
                                                  Typecode
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  28. Encounter.text
                                                  Definition

                                                  A human-readable narrative that contains a summary of the resource and can 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 information is added later.

                                                  Control0..1
                                                  TypeNarrative
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate Namesnarrative, html, xhtml, display
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  30. Encounter.text.id
                                                  Definition

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

                                                  ShortUnique id for inter-element referencing
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  32. Encounter.text.extension
                                                  Definition

                                                  An Extension

                                                  ShortExtension
                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  SlicingThis element introduces a set of slices on Encounter.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 34. Encounter.text.extension:text
                                                    Slice Nametext
                                                    Definition

                                                    DSTU2: Encounter.text additional types (Narrative) additional types from child elements (div, status)

                                                    ShortDSTU2: text additional types
                                                    Comments

                                                    Element Encounter.text is mapped to FHIR R4 element Encounter.text as SourceIsBroaderThanTarget. The mappings for Encounter.text do not cover the following types: Narrative. The mappings for Encounter.text do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

                                                    Control0..1
                                                    TypeExtension(DSTU2: text additional types) (Complex Extension)
                                                    Is Modifierfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    36. Encounter.text.status
                                                    Definition

                                                    The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

                                                    Shortgenerated | extensions | additional | empty
                                                    Control1..1
                                                    BindingThe codes SHALL be taken from NarrativeStatus
                                                    (required to http://hl7.org/fhir/ValueSet/narrative-status|4.0.1)

                                                    The status of a resource narrative.

                                                    Typecode
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    38. Encounter.text.div
                                                    Definition

                                                    The actual narrative content, a stripped down version of XHTML.

                                                    ShortLimited xhtml content
                                                    Comments

                                                    The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

                                                    Control1..1
                                                    Typexhtml
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (htmlChecks())
                                                    txt-2: The narrative SHALL have some non-whitespace content (htmlChecks())
                                                    40. 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

                                                    Control0..*
                                                    TypeResource
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Alternate Namesinline resources, anonymous resources, contained resources
                                                    42. Encounter.extension
                                                    Definition

                                                    An Extension

                                                    ShortExtension
                                                    Control0..*
                                                    TypeExtension
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    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
                                                    • 44. Encounter.extension:indication
                                                      Slice Nameindication
                                                      Definition

                                                      DSTU2: Encounter.indication additional types from child elements (display, reference)

                                                      ShortDSTU2: Reason the encounter takes place (resource) additional types
                                                      Comments

                                                      Element Encounter.indication is mapped to FHIR R4 element Encounter.reasonCode as SourceIsBroaderThanTarget. Element Encounter.indication is mapped to FHIR R4 element Encounter.diagnosis.condition as SourceIsBroaderThanTarget. The mappings for Encounter.indication do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Encounter.indication with unmapped reference targets: Condition, Procedure. 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(Alternate Reference) (Extension Type: Reference(Resource))
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      46. Encounter.extension:dischargeDiagnosis
                                                      Slice NamedischargeDiagnosis
                                                      Definition

                                                      DSTU2: Encounter.hospitalization.dischargeDiagnosis (new:Reference(Condition))

                                                      ShortDSTU2: The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete (new)
                                                      Comments

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

                                                      Control0..*
                                                      This element is affected by the following invariants: ele-1
                                                      TypeExtension(DSTU2: The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Condition for use in FHIR R4, Condition))
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      48. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.

                                                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                      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 Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                                                      Summaryfalse
                                                      Requirements

                                                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                      Alternate Namesextensions, user content
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      50. 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
                                                      Is Modifierfalse
                                                      Summarytrue
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      52. Encounter.identifier.id
                                                      Definition

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

                                                      ShortUnique id for inter-element referencing
                                                      Control0..1
                                                      Typestring
                                                      Is Modifierfalse
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      Summaryfalse
                                                      54. Encounter.identifier.extension
                                                      Definition

                                                      An Extension

                                                      ShortExtension
                                                      Control0..*
                                                      TypeExtension
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      SlicingThis element introduces a set of slices on Encounter.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                      • value @ url
                                                      • 56. Encounter.identifier.extension:identifier
                                                        Slice Nameidentifier
                                                        Definition

                                                        DSTU2: Encounter.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

                                                        ShortDSTU2: identifier additional types
                                                        Comments

                                                        Element Encounter.identifier is mapped to FHIR R4 element Encounter.identifier as SourceIsBroaderThanTarget. The mappings for Encounter.identifier do not cover the following types: Identifier. The mappings for Encounter.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

                                                        Control0..*
                                                        TypeExtension(DSTU2: identifier additional types) (Extension Type: Identifier)
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        58. Encounter.identifier.use
                                                        Definition

                                                        The purpose of this identifier.

                                                        Shortusual | official | temp | secondary | old (If known)
                                                        Comments

                                                        Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                                        Control0..1
                                                        BindingThe codes SHALL be taken from IdentifierUse
                                                        (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                                        Identifies the purpose for this identifier, if known .

                                                        Typecode
                                                        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Requirements

                                                        Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        60. Encounter.identifier.type
                                                        Definition

                                                        A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                                        ShortDescription of identifier
                                                        Comments

                                                        This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                                        Control0..1
                                                        BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                                        (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

                                                        A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                                        TypeCodeableConcept
                                                        Is Modifierfalse
                                                        Summarytrue
                                                        Requirements

                                                        Allows users to make use of identifiers when the identifier system is not known.

                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        62. Encounter.identifier.system
                                                        Definition

                                                        Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                                        ShortThe namespace for the identifier value
                                                        Comments

                                                        Identifier.system is always case sensitive.

                                                        Control0..1
                                                        Typeuri
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Requirements

                                                        There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                                        ExampleGeneral: http://www.acme.com/identifiers/patient
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        64. Encounter.identifier.value
                                                        Definition

                                                        The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                                        ShortThe value that is unique
                                                        Comments

                                                        If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                                        Control0..1
                                                        Typestring
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        ExampleGeneral: 123456
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        66. Encounter.identifier.period
                                                        Definition

                                                        Time period during which identifier is/was valid for use.

                                                        ShortTime period when id is/was valid for use
                                                        Control0..1
                                                        TypePeriod
                                                        Is Modifierfalse
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        68. Encounter.identifier.assigner
                                                        Definition

                                                        Organization that issued/manages the identifier.

                                                        ShortOrganization that issued id (may be just text)
                                                        Comments

                                                        The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                                        Control0..1
                                                        TypeReference(Organization)
                                                        Is Modifierfalse
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        70. 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 determine the appropriate transitions that may occur between statuses (and also classes).

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

                                                        Current state of the encounter.

                                                        Typecode
                                                        Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        72. 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
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        74. 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.

                                                        ShortUnique id for inter-element referencing
                                                        Control0..1
                                                        Typestring
                                                        Is Modifierfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        76. Encounter.statusHistory.extension
                                                        Definition

                                                        May be used to represent additional information that is not part of the basic definition of the element. 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 can 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
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Alternate Namesextensions, user content
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        78. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

                                                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                        ShortExtensions that cannot be ignored even if unrecognized
                                                        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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                        Summarytrue
                                                        Requirements

                                                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                        Alternate Namesextensions, user content, modifiers
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        80. 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|4.0.1)

                                                        Current state of the encounter.

                                                        Typecode
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summaryfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        82. 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
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        84. Encounter.statusHistory.period.id
                                                        Definition

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

                                                        ShortUnique id for inter-element referencing
                                                        Control0..1
                                                        Typestring
                                                        Is Modifierfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        86. Encounter.statusHistory.period.extension
                                                        Definition

                                                        An Extension

                                                        ShortExtension
                                                        Control0..*
                                                        TypeExtension
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        SlicingThis element introduces a set of slices on Encounter.statusHistory.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                        • value @ url
                                                        • 88. Encounter.statusHistory.period.extension:period
                                                          Slice Nameperiod
                                                          Definition

                                                          DSTU2: Encounter.statusHistory.period additional types (Period) additional types from child elements (end, start)

                                                          ShortDSTU2: period additional types
                                                          Comments

                                                          Element Encounter.statusHistory.period is mapped to FHIR R4 element Encounter.statusHistory.period as SourceIsBroaderThanTarget. The mappings for Encounter.statusHistory.period do not cover the following types: Period. The mappings for Encounter.statusHistory.period do not cover the following types based on type expansion: end, start.

                                                          Control1..1
                                                          TypeExtension(DSTU2: period additional types) (Extension Type: Period)
                                                          Is Modifierfalse
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                          90. Encounter.statusHistory.period.start
                                                          Definition

                                                          The start of the period. The boundary is inclusive.

                                                          ShortStarting time with inclusive boundary
                                                          Comments

                                                          If the low element is missing, the meaning is that the low boundary is not known.

                                                          Control0..1
                                                          This element is affected by the following invariants: per-1
                                                          TypedateTime
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          92. Encounter.statusHistory.period.end
                                                          Definition

                                                          The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                                                          ShortEnd time with inclusive boundary, if not ongoing
                                                          Comments

                                                          The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                                                          Control0..1
                                                          This element is affected by the following invariants: per-1
                                                          TypedateTime
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          94. Encounter.class
                                                          Definition

                                                          Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

                                                          ShortClassification of patient encounter
                                                          Control1..1
                                                          BindingUnless not suitable, these codes SHALL be taken from ActEncounterCode (3.0.0)
                                                          (extensible to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode|3.0.0)

                                                          Classification of the encounter.

                                                          TypeCoding
                                                          Is Modifierfalse
                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          96. Encounter.class.id
                                                          Definition

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

                                                          ShortUnique id for inter-element referencing
                                                          Control0..1
                                                          Typestring
                                                          Is Modifierfalse
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          Summaryfalse
                                                          98. Encounter.class.extension
                                                          Definition

                                                          An Extension

                                                          ShortExtension
                                                          Control0..*
                                                          TypeExtension
                                                          Is Modifierfalse
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                          SlicingThis element introduces a set of slices on Encounter.class.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ url
                                                          • 100. Encounter.class.extension:class
                                                            Slice Nameclass
                                                            Definition

                                                            DSTU2: Encounter.class additional codes

                                                            ShortDSTU2: inpatient | outpatient | ambulatory | emergency + additional codes
                                                            Comments

                                                            Element Encounter.class is mapped to FHIR R4 element Encounter.class as RelatedTo. The mappings for Encounter.class do not allow expression of the necessary codes, per the bindings on the source and target.

                                                            Control0..1
                                                            TypeExtension(DSTU2: inpatient | outpatient | ambulatory | emergency + additional codes) (Extension Type: code)
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            102. Encounter.class.system
                                                            Definition

                                                            The identification of the code system that defines the meaning of the symbol in the code.

                                                            ShortIdentity of the terminology system
                                                            Comments

                                                            The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                            Control0..1
                                                            Typeuri
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Requirements

                                                            Need to be unambiguous about the source of the definition of the symbol.

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            104. Encounter.class.version
                                                            Definition

                                                            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                            ShortVersion of the system - if relevant
                                                            Comments

                                                            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                            NoteThis is a business version Id, not a resource version Id (see discussion)
                                                            Control0..1
                                                            Typestring
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            106. Encounter.class.code
                                                            Definition

                                                            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                            ShortSymbol in syntax defined by the system
                                                            Control0..1
                                                            Typecode
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Requirements

                                                            Need to refer to a particular code in the system.

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            108. Encounter.class.display
                                                            Definition

                                                            A representation of the meaning of the code in the system, following the rules of the system.

                                                            ShortRepresentation defined by the system
                                                            Control0..1
                                                            Typestring
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Requirements

                                                            Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            110. Encounter.class.userSelected
                                                            Definition

                                                            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                            ShortIf this coding was chosen directly by the user
                                                            Comments

                                                            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                            Control0..1
                                                            Typeboolean
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Requirements

                                                            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            112. 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 transitions 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 kind of discharge from emergency to inpatient.

                                                            ShortList of past encounter classes
                                                            Control0..*
                                                            TypeBackboneElement
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            114. 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.

                                                            ShortUnique id for inter-element referencing
                                                            Control0..1
                                                            Typestring
                                                            Is Modifierfalse
                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                            Summaryfalse
                                                            116. Encounter.classHistory.extension
                                                            Definition

                                                            May be used to represent additional information that is not part of the basic definition of the element. 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 can 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
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Alternate Namesextensions, user content
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            118. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

                                                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                            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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                            Summarytrue
                                                            Requirements

                                                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                            Alternate Namesextensions, user content, modifiers
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            120. Encounter.classHistory.class
                                                            Definition

                                                            inpatient | outpatient | ambulatory | emergency +.

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

                                                            Classification of the encounter.

                                                            TypeCoding
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            122. 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
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            124. 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|4.0.1)

                                                            The type of encounter.

                                                            TypeCodeableConcept
                                                            Is Modifierfalse
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            126. Encounter.serviceType
                                                            Definition

                                                            Broad categorization of the service that is to be provided (e.g. cardiology).

                                                            ShortSpecific type of service
                                                            Control0..1
                                                            BindingFor example codes, see ServiceType
                                                            (example to http://hl7.org/fhir/ValueSet/service-type|4.0.1)

                                                            Broad categorization of the service that is to be provided.

                                                            TypeCodeableConcept
                                                            Is Modifierfalse
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            128. Encounter.priority
                                                            Definition

                                                            Indicates the urgency of the encounter.

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

                                                            Indicates the urgency of the encounter.

                                                            TypeCodeableConcept
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            130. Encounter.subject
                                                            Definition

                                                            The patient or group present at the encounter.

                                                            ShortThe patient or group present at the encounter
                                                            Comments

                                                            While the encounter is always about the patient, the patient might 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)
                                                            Is Modifierfalse
                                                            Summarytrue
                                                            Alternate Namespatient
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            132. Encounter.subject.id
                                                            Definition

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

                                                            ShortUnique id for inter-element referencing
                                                            Control0..1
                                                            Typestring
                                                            Is Modifierfalse
                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                            Summaryfalse
                                                            134. Encounter.subject.extension
                                                            Definition

                                                            An Extension

                                                            ShortExtension
                                                            Control0..*
                                                            TypeExtension
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            SlicingThis element introduces a set of slices on Encounter.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                            • value @ url
                                                            • 136. Encounter.subject.extension:patient
                                                              Slice Namepatient
                                                              Definition

                                                              DSTU2: Encounter.patient additional types from child elements (display, reference)

                                                              ShortDSTU2: The patient present at the encounter additional types
                                                              Comments

                                                              Element Encounter.patient is mapped to FHIR R4 element Encounter.subject as SourceIsBroaderThanTarget. The mappings for Encounter.patient do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Encounter.patient with unmapped reference targets: Patient. While the encounter is always about the patient, the patient may not actually be known in all contexts of use.

                                                              Control0..1
                                                              TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                              Is Modifierfalse
                                                              Summaryfalse
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                              138. Encounter.subject.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
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              140. Encounter.subject.type
                                                              Definition

                                                              The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                              The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                              ShortType the reference refers to (e.g. "Patient")
                                                              Comments

                                                              This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                              Control0..1
                                                              BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                              (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                                              Aa resource (or, for logical models, the URI of the logical model).

                                                              Typeuri
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              142. Encounter.subject.identifier
                                                              Definition

                                                              An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                              Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                              NoteThis is a business identifier, not a resource identifier (see discussion)
                                                              Control0..1
                                                              TypeIdentifier
                                                              Is Modifierfalse
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              144. Encounter.subject.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
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              146. 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)
                                                              Is Modifierfalse
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              148. Encounter.episodeOfCare.id
                                                              Definition

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

                                                              ShortUnique id for inter-element referencing
                                                              Control0..1
                                                              Typestring
                                                              Is Modifierfalse
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Summaryfalse
                                                              150. Encounter.episodeOfCare.extension
                                                              Definition

                                                              An Extension

                                                              ShortExtension
                                                              Control0..*
                                                              TypeExtension
                                                              Is Modifierfalse
                                                              Summaryfalse
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                              SlicingThis element introduces a set of slices on Encounter.episodeOfCare.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                              • value @ url
                                                              • 152. Encounter.episodeOfCare.extension:episodeOfCare
                                                                Slice NameepisodeOfCare
                                                                Definition

                                                                DSTU2: Encounter.episodeOfCare additional types from child elements (display, reference)

                                                                ShortDSTU2: episodeOfCare additional types
                                                                Comments

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

                                                                Control0..1
                                                                TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                                Is Modifierfalse
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                154. Encounter.episodeOfCare.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
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                156. Encounter.episodeOfCare.type
                                                                Definition

                                                                The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                ShortType the reference refers to (e.g. "Patient")
                                                                Comments

                                                                This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                Control0..1
                                                                BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                                (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                                                Aa resource (or, for logical models, the URI of the logical model).

                                                                Typeuri
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                158. Encounter.episodeOfCare.identifier
                                                                Definition

                                                                An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                                Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                Control0..1
                                                                TypeIdentifier
                                                                Is Modifierfalse
                                                                Summarytrue
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                160. Encounter.episodeOfCare.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
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                162. Encounter.basedOn
                                                                Definition

                                                                The request this encounter satisfies (e.g. incoming referral or procedure request).

                                                                ShortThe ServiceRequest that initiated this encounter
                                                                Control0..*
                                                                TypeReference(ServiceRequest)
                                                                Is Modifierfalse
                                                                Summaryfalse
                                                                Alternate NamesincomingReferral
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                164. Encounter.basedOn.id
                                                                Definition

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

                                                                ShortUnique id for inter-element referencing
                                                                Control0..1
                                                                Typestring
                                                                Is Modifierfalse
                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                Summaryfalse
                                                                166. Encounter.basedOn.extension
                                                                Definition

                                                                An Extension

                                                                ShortExtension
                                                                Control0..*
                                                                TypeExtension
                                                                Is Modifierfalse
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                SlicingThis element introduces a set of slices on Encounter.basedOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                • value @ url
                                                                • 168. Encounter.basedOn.extension:incomingReferral
                                                                  Slice NameincomingReferral
                                                                  Definition

                                                                  DSTU2: Encounter.incomingReferral additional types from child elements (display, reference)

                                                                  ShortDSTU2: The ReferralRequest that initiated this encounter additional types
                                                                  Comments

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

                                                                  Control0..1
                                                                  TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                                  Is Modifierfalse
                                                                  Summaryfalse
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                  170. Encounter.basedOn.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
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  172. Encounter.basedOn.type
                                                                  Definition

                                                                  The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                  The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                  ShortType the reference refers to (e.g. "Patient")
                                                                  Comments

                                                                  This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                  Control0..1
                                                                  BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                                  (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                                                  Aa resource (or, for logical models, the URI of the logical model).

                                                                  Typeuri
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  174. Encounter.basedOn.identifier
                                                                  Definition

                                                                  An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                                  Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                  Control0..1
                                                                  TypeIdentifier
                                                                  Is Modifierfalse
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  176. Encounter.basedOn.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
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  178. Encounter.participant
                                                                  Definition

                                                                  The list of people responsible for providing the service.

                                                                  ShortList of participants involved in the encounter
                                                                  Control0..*
                                                                  TypeBackboneElement
                                                                  Is Modifierfalse
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  180. 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.

                                                                  ShortUnique id for inter-element referencing
                                                                  Control0..1
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                  Summaryfalse
                                                                  182. Encounter.participant.extension
                                                                  Definition

                                                                  May be used to represent additional information that is not part of the basic definition of the element. 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 can 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
                                                                  Is Modifierfalse
                                                                  Summaryfalse
                                                                  Alternate Namesextensions, user content
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                  184. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

                                                                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                                  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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                  Summarytrue
                                                                  Requirements

                                                                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                  Alternate Namesextensions, user content, modifiers
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                  186. Encounter.participant.type
                                                                  Definition

                                                                  Role of participant in encounter.

                                                                  ShortRole of participant in encounter
                                                                  Comments

                                                                  The participant type indicates how an individual participates 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|4.0.1)

                                                                  Role of participant in encounter.

                                                                  TypeCodeableConcept
                                                                  Is Modifierfalse
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  188. 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
                                                                  Is Modifierfalse
                                                                  Summaryfalse
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  190. Encounter.participant.period.id
                                                                  Definition

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

                                                                  ShortUnique id for inter-element referencing
                                                                  Control0..1
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                  Summaryfalse
                                                                  192. Encounter.participant.period.extension
                                                                  Definition

                                                                  An Extension

                                                                  ShortExtension
                                                                  Control0..*
                                                                  TypeExtension
                                                                  Is Modifierfalse
                                                                  Summaryfalse
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                  SlicingThis element introduces a set of slices on Encounter.participant.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                  • value @ url
                                                                  • 194. Encounter.participant.period.extension:period
                                                                    Slice Nameperiod
                                                                    Definition

                                                                    DSTU2: Encounter.participant.period additional types (Period) additional types from child elements (end, start)

                                                                    ShortDSTU2: Period of time during the encounter participant was present additional types
                                                                    Comments

                                                                    Element Encounter.participant.period is mapped to FHIR R4 element Encounter.participant.period as SourceIsBroaderThanTarget. The mappings for Encounter.participant.period do not cover the following types: Period. The mappings for Encounter.participant.period do not cover the following types based on type expansion: end, start.

                                                                    Control0..1
                                                                    TypeExtension(DSTU2: Period of time during the encounter participant was present additional types) (Extension Type: Period)
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                    196. Encounter.participant.period.start
                                                                    Definition

                                                                    The start of the period. The boundary is inclusive.

                                                                    ShortStarting time with inclusive boundary
                                                                    Comments

                                                                    If the low element is missing, the meaning is that the low boundary is not known.

                                                                    Control0..1
                                                                    This element is affected by the following invariants: per-1
                                                                    TypedateTime
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summarytrue
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    198. Encounter.participant.period.end
                                                                    Definition

                                                                    The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                                                                    ShortEnd time with inclusive boundary, if not ongoing
                                                                    Comments

                                                                    The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                                                                    Control0..1
                                                                    This element is affected by the following invariants: per-1
                                                                    TypedateTime
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summarytrue
                                                                    Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    200. 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, PractitionerRole, RelatedPerson)
                                                                    Is Modifierfalse
                                                                    Summarytrue
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    202. 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.

                                                                    ShortUnique id for inter-element referencing
                                                                    Control0..1
                                                                    Typestring
                                                                    Is Modifierfalse
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Summaryfalse
                                                                    204. Encounter.participant.individual.extension
                                                                    Definition

                                                                    An Extension

                                                                    ShortExtension
                                                                    Control0..*
                                                                    TypeExtension
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                    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
                                                                    • 206. Encounter.participant.individual.extension:individual
                                                                      Slice Nameindividual
                                                                      Definition

                                                                      DSTU2: Encounter.participant.individual additional types from child elements (display, reference)

                                                                      ShortDSTU2: individual additional types
                                                                      Comments

                                                                      Element Encounter.participant.individual is mapped to FHIR R4 element Encounter.participant.individual as RelatedTo. The mappings for Encounter.participant.individual do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Encounter.participant.individual with unmapped reference targets: Practitioner, RelatedPerson.

                                                                      Control0..1
                                                                      TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                                      Is Modifierfalse
                                                                      Summaryfalse
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                      208. 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
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      210. Encounter.participant.individual.type
                                                                      Definition

                                                                      The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                      The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                      ShortType the reference refers to (e.g. "Patient")
                                                                      Comments

                                                                      This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                      Control0..1
                                                                      BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                                      (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                                                      Aa resource (or, for logical models, the URI of the logical model).

                                                                      Typeuri
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      212. Encounter.participant.individual.identifier
                                                                      Definition

                                                                      An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                                      Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                      Control0..1
                                                                      TypeIdentifier
                                                                      Is Modifierfalse
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      214. 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
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      216. Encounter.appointment
                                                                      Definition

                                                                      The appointment that scheduled this encounter.

                                                                      ShortThe appointment that scheduled this encounter
                                                                      Control0..*
                                                                      TypeReference(Appointment)
                                                                      Is Modifierfalse
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      218. Encounter.appointment.id
                                                                      Definition

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

                                                                      ShortUnique id for inter-element referencing
                                                                      Control0..1
                                                                      Typestring
                                                                      Is Modifierfalse
                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                      Summaryfalse
                                                                      220. Encounter.appointment.extension
                                                                      Definition

                                                                      An Extension

                                                                      ShortExtension
                                                                      Control0..*
                                                                      TypeExtension
                                                                      Is Modifierfalse
                                                                      Summaryfalse
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                      SlicingThis element introduces a set of slices on Encounter.appointment.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                      • value @ url
                                                                      • 222. Encounter.appointment.extension:appointment
                                                                        Slice Nameappointment
                                                                        Definition

                                                                        DSTU2: Encounter.appointment additional types from child elements (display, reference)

                                                                        ShortDSTU2: appointment additional types
                                                                        Comments

                                                                        Element Encounter.appointment is mapped to FHIR R4 element Encounter.appointment as RelatedTo. The mappings for Encounter.appointment do not cover the following types based on type expansion: display, reference. The standard extension alternate-reference has been mapped as the representation of FHIR DSTU2 element Encounter.appointment with unmapped reference targets: Appointment.

                                                                        Control0..1
                                                                        TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                                        Is Modifierfalse
                                                                        Summaryfalse
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                        224. Encounter.appointment.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
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Summarytrue
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        226. Encounter.appointment.type
                                                                        Definition

                                                                        The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                        The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                        ShortType the reference refers to (e.g. "Patient")
                                                                        Comments

                                                                        This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                        Control0..1
                                                                        BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                                        (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                                                        Aa resource (or, for logical models, the URI of the logical model).

                                                                        Typeuri
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Summarytrue
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        228. Encounter.appointment.identifier
                                                                        Definition

                                                                        An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                                        Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                        Control0..1
                                                                        TypeIdentifier
                                                                        Is Modifierfalse
                                                                        Summarytrue
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        230. Encounter.appointment.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
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Summarytrue
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        232. 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
                                                                        Is Modifierfalse
                                                                        Summaryfalse
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        234. Encounter.period.id
                                                                        Definition

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

                                                                        ShortUnique id for inter-element referencing
                                                                        Control0..1
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                        Summaryfalse
                                                                        236. Encounter.period.extension
                                                                        Definition

                                                                        An Extension

                                                                        ShortExtension
                                                                        Control0..*
                                                                        TypeExtension
                                                                        Is Modifierfalse
                                                                        Summaryfalse
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                        SlicingThis element introduces a set of slices on Encounter.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                        • value @ url
                                                                        • 238. Encounter.period.extension:period
                                                                          Slice Nameperiod
                                                                          Definition

                                                                          DSTU2: Encounter.period additional types (Period) additional types from child elements (end, start)

                                                                          ShortDSTU2: period additional types
                                                                          Comments

                                                                          Element Encounter.period is mapped to FHIR R4 element Encounter.period as SourceIsBroaderThanTarget. The mappings for Encounter.period do not cover the following types: Period. The mappings for Encounter.period do not cover the following types based on type expansion: end, start. If not (yet) known, the end of the Period may be omitted.

                                                                          Control0..1
                                                                          TypeExtension(DSTU2: period additional types) (Extension Type: Period)
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                          240. Encounter.period.start
                                                                          Definition

                                                                          The start of the period. The boundary is inclusive.

                                                                          ShortStarting time with inclusive boundary
                                                                          Comments

                                                                          If the low element is missing, the meaning is that the low boundary is not known.

                                                                          Control0..1
                                                                          This element is affected by the following invariants: per-1
                                                                          TypedateTime
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summarytrue
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          242. Encounter.period.end
                                                                          Definition

                                                                          The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                                                                          ShortEnd time with inclusive boundary, if not ongoing
                                                                          Comments

                                                                          The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                                                                          Control0..1
                                                                          This element is affected by the following invariants: per-1
                                                                          TypedateTime
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summarytrue
                                                                          Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          244. 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
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          246. Encounter.reasonCode
                                                                          Definition

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

                                                                          ShortCoded reason the encounter takes place
                                                                          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 EncounterReasonCodes
                                                                          (preferred to http://hl7.org/fhir/ValueSet/encounter-reason|4.0.1)

                                                                          Reason why the encounter takes place.

                                                                          TypeCodeableConcept
                                                                          Is Modifierfalse
                                                                          Summarytrue
                                                                          Alternate NamesIndication, Admission diagnosis
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          248. Encounter.reasonReference
                                                                          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 (reference)
                                                                          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..*
                                                                          TypeReference(Condition, Procedure, Observation, ImmunizationRecommendation)
                                                                          Is Modifierfalse
                                                                          Summarytrue
                                                                          Alternate NamesIndication, Admission diagnosis
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          250. Encounter.diagnosis
                                                                          Definition

                                                                          The list of diagnosis relevant to this encounter.

                                                                          ShortThe list of diagnosis relevant to this encounter
                                                                          Control0..*
                                                                          TypeBackboneElement
                                                                          Is Modifierfalse
                                                                          Summarytrue
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          252. 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.

                                                                          ShortUnique id for inter-element referencing
                                                                          Control0..1
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                          Summaryfalse
                                                                          254. Encounter.diagnosis.extension
                                                                          Definition

                                                                          May be used to represent additional information that is not part of the basic definition of the element. 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 can 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
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Alternate Namesextensions, user content
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                          256. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

                                                                          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                                          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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                          Summarytrue
                                                                          Requirements

                                                                          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                          Alternate Namesextensions, user content, modifiers
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                          258. 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.

                                                                          ShortThe diagnosis or procedure relevant to the encounter
                                                                          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)
                                                                          Is Modifierfalse
                                                                          Summarytrue
                                                                          Alternate NamesAdmission diagnosis, discharge diagnosis, indication
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          260. Encounter.diagnosis.condition.id
                                                                          Definition

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

                                                                          ShortUnique id for inter-element referencing
                                                                          Control0..1
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                          Summaryfalse
                                                                          262. Encounter.diagnosis.condition.extension
                                                                          Definition

                                                                          An Extension

                                                                          ShortExtension
                                                                          Control0..*
                                                                          TypeExtension
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                          SlicingThis element introduces a set of slices on Encounter.diagnosis.condition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                          • value @ url
                                                                          • 264. Encounter.diagnosis.condition.extension:admittingDiagnosis
                                                                            Slice NameadmittingDiagnosis
                                                                            Definition

                                                                            DSTU2: Encounter.hospitalization.admittingDiagnosis additional types from child elements (display, reference)

                                                                            ShortDSTU2: The admitting diagnosis as reported by admitting practitioner additional types
                                                                            Comments

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

                                                                            Control0..1
                                                                            TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            266. Encounter.diagnosis.condition.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
                                                                            Is Modifierfalse
                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                            Summarytrue
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            268. Encounter.diagnosis.condition.type
                                                                            Definition

                                                                            The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                            The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                            ShortType the reference refers to (e.g. "Patient")
                                                                            Comments

                                                                            This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                            Control0..1
                                                                            BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                                            (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                                                            Aa resource (or, for logical models, the URI of the logical model).

                                                                            Typeuri
                                                                            Is Modifierfalse
                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                            Summarytrue
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            270. Encounter.diagnosis.condition.identifier
                                                                            Definition

                                                                            An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                                            Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                            NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                            Control0..1
                                                                            TypeIdentifier
                                                                            Is Modifierfalse
                                                                            Summarytrue
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            272. Encounter.diagnosis.condition.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
                                                                            Is Modifierfalse
                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                            Summarytrue
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            274. Encounter.diagnosis.use
                                                                            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|4.0.1)

                                                                            The type of diagnosis this condition represents.

                                                                            TypeCodeableConcept
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            276. Encounter.diagnosis.rank
                                                                            Definition

                                                                            Ranking of the diagnosis (for each role type).

                                                                            ShortRanking of the diagnosis (for each role type)
                                                                            Control0..1
                                                                            TypepositiveInt
                                                                            Is Modifierfalse
                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                            Summaryfalse
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            278. 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)
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            280. 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
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            282. 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.

                                                                            ShortUnique id for inter-element referencing
                                                                            Control0..1
                                                                            Typestring
                                                                            Is Modifierfalse
                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                            Summaryfalse
                                                                            284. Encounter.hospitalization.extension
                                                                            Definition

                                                                            May be used to represent additional information that is not part of the basic definition of the element. 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 can 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
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Alternate Namesextensions, user content
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            286. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

                                                                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                                            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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                            Summarytrue
                                                                            Requirements

                                                                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                            Alternate Namesextensions, user content, modifiers
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            288. Encounter.hospitalization.preAdmissionIdentifier
                                                                            Definition

                                                                            Pre-admission identifier.

                                                                            ShortPre-admission identifier
                                                                            Control0..1
                                                                            TypeIdentifier
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            290. Encounter.hospitalization.preAdmissionIdentifier.id
                                                                            Definition

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

                                                                            ShortUnique id for inter-element referencing
                                                                            Control0..1
                                                                            Typestring
                                                                            Is Modifierfalse
                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                            Summaryfalse
                                                                            292. Encounter.hospitalization.preAdmissionIdentifier.extension
                                                                            Definition

                                                                            An Extension

                                                                            ShortExtension
                                                                            Control0..*
                                                                            TypeExtension
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            SlicingThis element introduces a set of slices on Encounter.hospitalization.preAdmissionIdentifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                            • value @ url
                                                                            • 294. Encounter.hospitalization.preAdmissionIdentifier.extension:preAdmissionIdentifier
                                                                              Slice NamepreAdmissionIdentifier
                                                                              Definition

                                                                              DSTU2: Encounter.hospitalization.preAdmissionIdentifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

                                                                              ShortDSTU2: preAdmissionIdentifier additional types
                                                                              Comments

                                                                              Element Encounter.hospitalization.preAdmissionIdentifier is mapped to FHIR R4 element Encounter.hospitalization.preAdmissionIdentifier as SourceIsBroaderThanTarget. The mappings for Encounter.hospitalization.preAdmissionIdentifier do not cover the following types: Identifier. The mappings for Encounter.hospitalization.preAdmissionIdentifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

                                                                              Control0..1
                                                                              TypeExtension(DSTU2: preAdmissionIdentifier additional types) (Extension Type: Identifier)
                                                                              Is Modifierfalse
                                                                              Summaryfalse
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                              296. Encounter.hospitalization.preAdmissionIdentifier.use
                                                                              Definition

                                                                              The purpose of this identifier.

                                                                              Shortusual | official | temp | secondary | old (If known)
                                                                              Comments

                                                                              Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                                                              Control0..1
                                                                              BindingThe codes SHALL be taken from IdentifierUse
                                                                              (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                                                              Identifies the purpose for this identifier, if known .

                                                                              Typecode
                                                                              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Requirements

                                                                              Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              298. Encounter.hospitalization.preAdmissionIdentifier.type
                                                                              Definition

                                                                              A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                                                              ShortDescription of identifier
                                                                              Comments

                                                                              This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                                                              Control0..1
                                                                              BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                                                              (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

                                                                              A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                                                              TypeCodeableConcept
                                                                              Is Modifierfalse
                                                                              Summarytrue
                                                                              Requirements

                                                                              Allows users to make use of identifiers when the identifier system is not known.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              300. Encounter.hospitalization.preAdmissionIdentifier.system
                                                                              Definition

                                                                              Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                                                              ShortThe namespace for the identifier value
                                                                              Comments

                                                                              Identifier.system is always case sensitive.

                                                                              Control0..1
                                                                              Typeuri
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Requirements

                                                                              There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                                                              ExampleGeneral: http://www.acme.com/identifiers/patient
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              302. Encounter.hospitalization.preAdmissionIdentifier.value
                                                                              Definition

                                                                              The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                                                              ShortThe value that is unique
                                                                              Comments

                                                                              If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                                                              Control0..1
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              ExampleGeneral: 123456
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              304. Encounter.hospitalization.preAdmissionIdentifier.period
                                                                              Definition

                                                                              Time period during which identifier is/was valid for use.

                                                                              ShortTime period when id is/was valid for use
                                                                              Control0..1
                                                                              TypePeriod
                                                                              Is Modifierfalse
                                                                              Summarytrue
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              306. Encounter.hospitalization.preAdmissionIdentifier.assigner
                                                                              Definition

                                                                              Organization that issued/manages the identifier.

                                                                              ShortOrganization that issued id (may be just text)
                                                                              Comments

                                                                              The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                                                              Control0..1
                                                                              TypeReference(Organization)
                                                                              Is Modifierfalse
                                                                              Summarytrue
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              308. Encounter.hospitalization.origin
                                                                              Definition

                                                                              The location/organization from which the patient came before admission.

                                                                              ShortThe location/organization from which the patient came before admission
                                                                              Control0..1
                                                                              TypeReference(Location, Organization)
                                                                              Is Modifierfalse
                                                                              Summaryfalse
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              310. 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.

                                                                              ShortUnique id for inter-element referencing
                                                                              Control0..1
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                              Summaryfalse
                                                                              312. Encounter.hospitalization.origin.extension
                                                                              Definition

                                                                              An Extension

                                                                              ShortExtension
                                                                              Control0..*
                                                                              TypeExtension
                                                                              Is Modifierfalse
                                                                              Summaryfalse
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                              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
                                                                              • 314. Encounter.hospitalization.origin.extension:origin
                                                                                Slice Nameorigin
                                                                                Definition

                                                                                DSTU2: Encounter.hospitalization.origin additional types from child elements (display, reference)

                                                                                ShortDSTU2: The location from which the patient came before admission additional types
                                                                                Comments

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

                                                                                Control0..1
                                                                                TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                316. 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
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Summarytrue
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                318. Encounter.hospitalization.origin.type
                                                                                Definition

                                                                                The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                                The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                                ShortType the reference refers to (e.g. "Patient")
                                                                                Comments

                                                                                This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                                Control0..1
                                                                                BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                                                (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                                                                Aa resource (or, for logical models, the URI of the logical model).

                                                                                Typeuri
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Summarytrue
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                320. Encounter.hospitalization.origin.identifier
                                                                                Definition

                                                                                An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                                                Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                Control0..1
                                                                                TypeIdentifier
                                                                                Is Modifierfalse
                                                                                Summarytrue
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                322. 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
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Summarytrue
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                324. 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|4.0.1)

                                                                                From where the patient was admitted.

                                                                                TypeCodeableConcept
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                326. 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 Hl7VSReAdmissionIndicator (3.0.0)
                                                                                (example to http://terminology.hl7.org/ValueSet/v2-0092|3.0.0)

                                                                                The reason for re-admission of this hospitalization encounter.

                                                                                TypeCodeableConcept
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                328. 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|4.0.1)

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

                                                                                TypeCodeableConcept
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                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.

                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                330. 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|4.0.1)

                                                                                Special courtesies.

                                                                                TypeCodeableConcept
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                332. 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|4.0.1)

                                                                                Special arrangements.

                                                                                TypeCodeableConcept
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                334. Encounter.hospitalization.destination
                                                                                Definition

                                                                                Location/organization to which the patient is discharged.

                                                                                ShortLocation/organization to which the patient is discharged
                                                                                Control0..1
                                                                                TypeReference(Location, Organization)
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                336. 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.

                                                                                ShortUnique id for inter-element referencing
                                                                                Control0..1
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                338. Encounter.hospitalization.destination.extension
                                                                                Definition

                                                                                An Extension

                                                                                ShortExtension
                                                                                Control0..*
                                                                                TypeExtension
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                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
                                                                                • 340. Encounter.hospitalization.destination.extension:destination
                                                                                  Slice Namedestination
                                                                                  Definition

                                                                                  DSTU2: Encounter.hospitalization.destination additional types from child elements (display, reference)

                                                                                  ShortDSTU2: Location to which the patient is discharged additional types
                                                                                  Comments

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

                                                                                  Control0..1
                                                                                  TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                                                  Is Modifierfalse
                                                                                  Summaryfalse
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                  342. 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
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Summarytrue
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  344. Encounter.hospitalization.destination.type
                                                                                  Definition

                                                                                  The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                                  The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                                  ShortType the reference refers to (e.g. "Patient")
                                                                                  Comments

                                                                                  This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                                  Control0..1
                                                                                  BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                                                  (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                                                                  Aa resource (or, for logical models, the URI of the logical model).

                                                                                  Typeuri
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Summarytrue
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  346. Encounter.hospitalization.destination.identifier
                                                                                  Definition

                                                                                  An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                                                  Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                  Control0..1
                                                                                  TypeIdentifier
                                                                                  Is Modifierfalse
                                                                                  Summarytrue
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  348. 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
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Summarytrue
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  350. 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|4.0.1)

                                                                                  Discharge Disposition.

                                                                                  TypeCodeableConcept
                                                                                  Is Modifierfalse
                                                                                  Summaryfalse
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  352. 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
                                                                                  Is Modifierfalse
                                                                                  Summaryfalse
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  354. 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.

                                                                                  ShortUnique id for inter-element referencing
                                                                                  Control0..1
                                                                                  Typestring
                                                                                  Is Modifierfalse
                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                  Summaryfalse
                                                                                  356. Encounter.location.extension
                                                                                  Definition

                                                                                  May be used to represent additional information that is not part of the basic definition of the element. 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 can 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
                                                                                  Is Modifierfalse
                                                                                  Summaryfalse
                                                                                  Alternate Namesextensions, user content
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                  358. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

                                                                                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                                  ShortExtensions that cannot be ignored even if unrecognized
                                                                                  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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                  Summarytrue
                                                                                  Requirements

                                                                                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                                  Alternate Namesextensions, user content, modifiers
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                  360. Encounter.location.location
                                                                                  Definition

                                                                                  The location where the encounter takes place.

                                                                                  ShortLocation the encounter takes place
                                                                                  Control1..1
                                                                                  TypeReference(Location)
                                                                                  Is Modifierfalse
                                                                                  Summaryfalse
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  362. Encounter.location.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.

                                                                                  ShortUnique id for inter-element referencing
                                                                                  Control0..1
                                                                                  Typestring
                                                                                  Is Modifierfalse
                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                  Summaryfalse
                                                                                  364. Encounter.location.location.extension
                                                                                  Definition

                                                                                  An Extension

                                                                                  ShortExtension
                                                                                  Control0..*
                                                                                  TypeExtension
                                                                                  Is Modifierfalse
                                                                                  Summaryfalse
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                  SlicingThis element introduces a set of slices on Encounter.location.location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                  • value @ url
                                                                                  • 366. Encounter.location.location.extension:location
                                                                                    Slice Namelocation
                                                                                    Definition

                                                                                    DSTU2: Encounter.location.location additional types from child elements (display, reference)

                                                                                    ShortDSTU2: location additional types
                                                                                    Comments

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

                                                                                    Control0..1
                                                                                    TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                                                    Is Modifierfalse
                                                                                    Summaryfalse
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                    368. Encounter.location.location.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
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summarytrue
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    370. Encounter.location.location.type
                                                                                    Definition

                                                                                    The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                                    The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                                    ShortType the reference refers to (e.g. "Patient")
                                                                                    Comments

                                                                                    This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                                    Control0..1
                                                                                    BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                                                    (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                                                                    Aa resource (or, for logical models, the URI of the logical model).

                                                                                    Typeuri
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summarytrue
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    372. Encounter.location.location.identifier
                                                                                    Definition

                                                                                    An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                                                    Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                                    NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                    Control0..1
                                                                                    TypeIdentifier
                                                                                    Is Modifierfalse
                                                                                    Summarytrue
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    374. Encounter.location.location.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
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summarytrue
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    376. Encounter.location.status
                                                                                    Definition

                                                                                    The status of the participants' presence at the specified location during the period specified. If the participant 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|4.0.1)

                                                                                    The status of the location.

                                                                                    Typecode
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summaryfalse
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    378. Encounter.location.physicalType
                                                                                    Definition

                                                                                    This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.

                                                                                    ShortThe physical type of the location (usually the level in the location hierachy - bed room ward etc.)
                                                                                    Comments

                                                                                    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
                                                                                    BindingFor example codes, see LocationType
                                                                                    (example to http://hl7.org/fhir/ValueSet/location-physical-type|4.0.1)

                                                                                    Physical form of the location.

                                                                                    TypeCodeableConcept
                                                                                    Is Modifierfalse
                                                                                    Summaryfalse
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    380. 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
                                                                                    Is Modifierfalse
                                                                                    Summaryfalse
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    382. Encounter.location.period.id
                                                                                    Definition

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

                                                                                    ShortUnique id for inter-element referencing
                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                    Summaryfalse
                                                                                    384. Encounter.location.period.extension
                                                                                    Definition

                                                                                    An Extension

                                                                                    ShortExtension
                                                                                    Control0..*
                                                                                    TypeExtension
                                                                                    Is Modifierfalse
                                                                                    Summaryfalse
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                    SlicingThis element introduces a set of slices on Encounter.location.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                    • value @ url
                                                                                    • 386. Encounter.location.period.extension:period
                                                                                      Slice Nameperiod
                                                                                      Definition

                                                                                      DSTU2: Encounter.location.period additional types (Period) additional types from child elements (end, start)

                                                                                      ShortDSTU2: period additional types
                                                                                      Comments

                                                                                      Element Encounter.location.period is mapped to FHIR R4 element Encounter.location.period as SourceIsBroaderThanTarget. The mappings for Encounter.location.period do not cover the following types: Period. The mappings for Encounter.location.period do not cover the following types based on type expansion: end, start.

                                                                                      Control0..1
                                                                                      TypeExtension(DSTU2: period additional types) (Extension Type: Period)
                                                                                      Is Modifierfalse
                                                                                      Summaryfalse
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                      388. Encounter.location.period.start
                                                                                      Definition

                                                                                      The start of the period. The boundary is inclusive.

                                                                                      ShortStarting time with inclusive boundary
                                                                                      Comments

                                                                                      If the low element is missing, the meaning is that the low boundary is not known.

                                                                                      Control0..1
                                                                                      This element is affected by the following invariants: per-1
                                                                                      TypedateTime
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Summarytrue
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      390. Encounter.location.period.end
                                                                                      Definition

                                                                                      The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                                                                                      ShortEnd time with inclusive boundary, if not ongoing
                                                                                      Comments

                                                                                      The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                                                                                      Control0..1
                                                                                      This element is affected by the following invariants: per-1
                                                                                      TypedateTime
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Summarytrue
                                                                                      Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      392. Encounter.serviceProvider
                                                                                      Definition

                                                                                      The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.

                                                                                      ShortThe organization (facility) responsible for this encounter
                                                                                      Control0..1
                                                                                      TypeReference(Organization)
                                                                                      Is Modifierfalse
                                                                                      Summaryfalse
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      394. Encounter.serviceProvider.id
                                                                                      Definition

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

                                                                                      ShortUnique id for inter-element referencing
                                                                                      Control0..1
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                      Summaryfalse
                                                                                      396. Encounter.serviceProvider.extension
                                                                                      Definition

                                                                                      An Extension

                                                                                      ShortExtension
                                                                                      Control0..*
                                                                                      TypeExtension
                                                                                      Is Modifierfalse
                                                                                      Summaryfalse
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                      SlicingThis element introduces a set of slices on Encounter.serviceProvider.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                      • value @ url
                                                                                      • 398. Encounter.serviceProvider.extension:serviceProvider
                                                                                        Slice NameserviceProvider
                                                                                        Definition

                                                                                        DSTU2: Encounter.serviceProvider additional types from child elements (display, reference)

                                                                                        ShortDSTU2: The custodian organization of this Encounter record additional types
                                                                                        Comments

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

                                                                                        Control0..1
                                                                                        TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                                                        Is Modifierfalse
                                                                                        Summaryfalse
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                        400. Encounter.serviceProvider.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
                                                                                        Is Modifierfalse
                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                        Summarytrue
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        402. Encounter.serviceProvider.type
                                                                                        Definition

                                                                                        The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                                        The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                                        ShortType the reference refers to (e.g. "Patient")
                                                                                        Comments

                                                                                        This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                                        Control0..1
                                                                                        BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                                                        (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                                                                        Aa resource (or, for logical models, the URI of the logical model).

                                                                                        Typeuri
                                                                                        Is Modifierfalse
                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                        Summarytrue
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        404. Encounter.serviceProvider.identifier
                                                                                        Definition

                                                                                        An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                                                        Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                        Control0..1
                                                                                        TypeIdentifier
                                                                                        Is Modifierfalse
                                                                                        Summarytrue
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        406. Encounter.serviceProvider.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
                                                                                        Is Modifierfalse
                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                        Summarytrue
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        408. 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)
                                                                                        Is Modifierfalse
                                                                                        Summaryfalse
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        410. Encounter.partOf.id
                                                                                        Definition

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

                                                                                        ShortUnique id for inter-element referencing
                                                                                        Control0..1
                                                                                        Typestring
                                                                                        Is Modifierfalse
                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                        Summaryfalse
                                                                                        412. Encounter.partOf.extension
                                                                                        Definition

                                                                                        An Extension

                                                                                        ShortExtension
                                                                                        Control0..*
                                                                                        TypeExtension
                                                                                        Is Modifierfalse
                                                                                        Summaryfalse
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                        SlicingThis element introduces a set of slices on Encounter.partOf.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                        • value @ url
                                                                                        • 414. Encounter.partOf.extension:partOf
                                                                                          Slice NamepartOf
                                                                                          Definition

                                                                                          DSTU2: Encounter.partOf additional types from child elements (display, reference)

                                                                                          ShortDSTU2: partOf additional types
                                                                                          Comments

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

                                                                                          Control0..1
                                                                                          TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                                                          Is Modifierfalse
                                                                                          Summaryfalse
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                          416. Encounter.partOf.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
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Summarytrue
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          418. Encounter.partOf.type
                                                                                          Definition

                                                                                          The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                                          The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                                          ShortType the reference refers to (e.g. "Patient")
                                                                                          Comments

                                                                                          This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                                          Control0..1
                                                                                          BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                                                          (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                                                                          Aa resource (or, for logical models, the URI of the logical model).

                                                                                          Typeuri
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Summarytrue
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          420. Encounter.partOf.identifier
                                                                                          Definition

                                                                                          An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                                                          Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                          Control0..1
                                                                                          TypeIdentifier
                                                                                          Is Modifierfalse
                                                                                          Summarytrue
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          422. Encounter.partOf.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
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Summarytrue
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))