Draft PH Core Implementation Guide
0.2.0 - ci-build Philippines flag

Draft PH Core Implementation Guide - Local Development build (v0.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: PHCoreEncounter - Detailed Descriptions

Draft as of 2026-04-10

Definitions for the ph-core-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())
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()))
4. 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())
6. 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
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. 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
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. 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 ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode
(extensible to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode)

Classification of the encounter.

TypeCoding
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. 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 EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-type|4.0.1
(example to http://hl7.org/fhir/ValueSet/encounter-type|4.0.1)

The type of encounter.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. 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 ServiceTypehttp://hl7.org/fhir/ValueSet/service-type|4.0.1
(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
Must Supporttrue
Obligations
    ObligationsActor
    SHALL:handlePH Core Server
    SHALL:handlePH Core Consumer
    MAY:able-to-populatePH Core Creator
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Encounter.serviceType.coding
    Definition

    A reference to a code defined by a terminology system.

    ShortCode defined by a terminology system
    Comments

    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

    Control0..*
    TypeCoding
    Is Modifierfalse
    Must Supporttrue
    Obligations
      ObligationsActor
      SHALL:handlePH Core Server
      SHALL:handlePH Core Consumer
      MAY:able-to-populatePH Core Creator
      Summarytrue
      Requirements

      Allows for alternative encodings within a code system, and translations to other code systems.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      18. Encounter.serviceType.text
      Definition

      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      ShortPlain text representation of the concept
      Comments

      Very often the text is the same as a displayName of one of the codings.

      Control0..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Obligations
        ObligationsActor
        SHALL:handlePH Core Server
        SHALL:handlePH Core Consumer
        MAY:able-to-populatePH Core Creator
        Summarytrue
        Requirements

        The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

        Indicates the urgency of the encounter.

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

        Indicates the urgency of the encounter.

        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Obligations
          ObligationsActor
          SHALL:handlePH Core Server
          SHALL:handlePH Core Consumer
          MAY:able-to-populatePH Core Creator
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          22. Encounter.priority.coding
          Definition

          A reference to a code defined by a terminology system.

          ShortCode defined by a terminology system
          Comments

          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

          Control0..*
          TypeCoding
          Is Modifierfalse
          Must Supporttrue
          Obligations
            ObligationsActor
            SHALL:handlePH Core Server
            SHALL:handlePH Core Consumer
            MAY:able-to-populatePH Core Creator
            Summarytrue
            Requirements

            Allows for alternative encodings within a code system, and translations to other code systems.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            24. Encounter.priority.text
            Definition

            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

            ShortPlain text representation of the concept
            Comments

            Very often the text is the same as a displayName of one of the codings.

            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Obligations
              ObligationsActor
              SHALL:handlePH Core Server
              SHALL:handlePH Core Consumer
              MAY:able-to-populatePH Core Creator
              Summarytrue
              Requirements

              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

              Control10..1
              TypeReference(PH Core Patient, Group, Patient, Group)
              Is Modifierfalse
              Must Supporttrue
              Must Support TypesNo must-support rules about the choice of types/profiles
              Summarytrue
              Alternate Namespatient
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              28. Encounter.participant
              Definition

              The list of people responsible for providing the service.

              ShortList of participants involved in the encounter
              Control0..*
              TypeBackboneElement
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              30. 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())
              32. 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 ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type|4.0.1
              (extensible to http://hl7.org/fhir/ValueSet/encounter-participant-type|4.0.1)

              Role of participant in encounter.

              TypeCodeableConcept
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              34. 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(PH Core Practitioner, PH Core RelatedPerson, PH Core PractitionerRole, Practitioner, PractitionerRole, RelatedPerson)
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              36. 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
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              38. 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
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              40. 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 EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason|4.0.1
              (preferred to http://hl7.org/fhir/ValueSet/encounter-reason|4.0.1)

              Reason why the encounter takes place.

              TypeCodeableConcept
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Alternate NamesIndication, Admission diagnosis
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              42. 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, PH Core Observation, PH Core Procedure, ImmunizationRecommendation, Condition, Procedure, Observation, ImmunizationRecommendation)
              Is Modifierfalse
              Must Supporttrue
              Must Support TypesNo must-support rules about the choice of types/profiles
              Summarytrue
              Alternate NamesIndication, Admission diagnosis
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              44. 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()))
              46. 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())
              48. 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, PH Core Procedure, 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()))
              50. 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 DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role|4.0.1
              (preferred to http://hl7.org/fhir/ValueSet/diagnosis-role|4.0.1)

              The type of diagnosis this condition represents.

              TypeCodeableConcept
              Is Modifierfalse
              Must Supporttrue
              Obligations
                ObligationsActor
                SHALL:handlePH Core Server
                SHALL:handlePH Core Consumer
                MAY:able-to-populatePH Core Creator
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                52. Encounter.diagnosis.use.coding
                Definition

                A reference to a code defined by a terminology system.

                ShortCode defined by a terminology system
                Comments

                Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                Control0..*
                TypeCoding
                Is Modifierfalse
                Must Supporttrue
                Obligations
                  ObligationsActor
                  SHALL:handlePH Core Server
                  SHALL:handlePH Core Consumer
                  MAY:able-to-populatePH Core Creator
                  Summarytrue
                  Requirements

                  Allows for alternative encodings within a code system, and translations to other code systems.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  54. Encounter.diagnosis.use.text
                  Definition

                  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                  ShortPlain text representation of the concept
                  Comments

                  Very often the text is the same as a displayName of one of the codings.

                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Obligations
                    ObligationsActor
                    SHALL:handlePH Core Server
                    SHALL:handlePH Core Consumer
                    MAY:able-to-populatePH Core Creator
                    Summarytrue
                    Requirements

                    The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    56. 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
                    Must Supporttrue
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    58. 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())
                    60. 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(PH Core Location, PH Core Organization, Location, Organization)
                    Is Modifierfalse
                    Must Supporttrue
                    Must Support TypesNo must-support rules about the choice of types/profiles
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    62. 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 AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source|4.0.1
                    (preferred to http://hl7.org/fhir/ValueSet/encounter-admit-source|4.0.1)

                    From where the patient was admitted.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Must Supporttrue
                    Obligations
                      ObligationsActor
                      SHALL:handlePH Core Server
                      SHALL:handlePH Core Consumer
                      MAY:able-to-populatePH Core Creator
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      64. Encounter.hospitalization.admitSource.coding
                      Definition

                      A reference to a code defined by a terminology system.

                      ShortCode defined by a terminology system
                      Comments

                      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                      Control0..*
                      TypeCoding
                      Is Modifierfalse
                      Must Supporttrue
                      Obligations
                        ObligationsActor
                        SHALL:handlePH Core Server
                        SHALL:handlePH Core Consumer
                        MAY:able-to-populatePH Core Creator
                        Summarytrue
                        Requirements

                        Allows for alternative encodings within a code system, and translations to other code systems.

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

                        A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                        ShortPlain text representation of the concept
                        Comments

                        Very often the text is the same as a displayName of one of the codings.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Obligations
                          ObligationsActor
                          SHALL:handlePH Core Server
                          SHALL:handlePH Core Consumer
                          MAY:able-to-populatePH Core Creator
                          Summarytrue
                          Requirements

                          The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          68. 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 hl7VS-re-admissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092
                          (example to http://terminology.hl7.org/ValueSet/v2-0092)

                          The reason for re-admission of this hospitalization encounter.

                          TypeCodeableConcept
                          Is Modifierfalse
                          Must Supporttrue
                          Obligations
                            ObligationsActor
                            SHALL:handlePH Core Server
                            SHALL:handlePH Core Consumer
                            MAY:able-to-populatePH Core Creator
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            70. Encounter.hospitalization.reAdmission.coding
                            Definition

                            A reference to a code defined by a terminology system.

                            ShortCode defined by a terminology system
                            Comments

                            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                            Control0..*
                            TypeCoding
                            Is Modifierfalse
                            Must Supporttrue
                            Obligations
                              ObligationsActor
                              SHALL:handlePH Core Server
                              SHALL:handlePH Core Consumer
                              MAY:able-to-populatePH Core Creator
                              Summarytrue
                              Requirements

                              Allows for alternative encodings within a code system, and translations to other code systems.

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

                              A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                              ShortPlain text representation of the concept
                              Comments

                              Very often the text is the same as a displayName of one of the codings.

                              Control0..1
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supporttrue
                              Obligations
                                ObligationsActor
                                SHALL:handlePH Core Server
                                SHALL:handlePH Core Consumer
                                MAY:able-to-populatePH Core Creator
                                Summarytrue
                                Requirements

                                The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                74. 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 Diethttp://hl7.org/fhir/ValueSet/encounter-diet|4.0.1
                                (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
                                Must Supporttrue
                                Obligations
                                  ObligationsActor
                                  SHALL:handlePH Core Server
                                  SHALL:handlePH Core Consumer
                                  MAY:able-to-populatePH Core Creator
                                  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()))
                                  76. Encounter.hospitalization.dietPreference.coding
                                  Definition

                                  A reference to a code defined by a terminology system.

                                  ShortCode defined by a terminology system
                                  Comments

                                  Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                  Control0..*
                                  TypeCoding
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Obligations
                                    ObligationsActor
                                    SHALL:handlePH Core Server
                                    SHALL:handlePH Core Consumer
                                    MAY:able-to-populatePH Core Creator
                                    Summarytrue
                                    Requirements

                                    Allows for alternative encodings within a code system, and translations to other code systems.

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

                                    A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                    ShortPlain text representation of the concept
                                    Comments

                                    Very often the text is the same as a displayName of one of the codings.

                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Obligations
                                      ObligationsActor
                                      SHALL:handlePH Core Server
                                      SHALL:handlePH Core Consumer
                                      MAY:able-to-populatePH Core Creator
                                      Summarytrue
                                      Requirements

                                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

                                      Special courtesies (VIP, board member).

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

                                      Special courtesies.

                                      TypeCodeableConcept
                                      Is Modifierfalse
                                      Must Supporttrue
                                      Obligations
                                        ObligationsActor
                                        SHALL:handlePH Core Server
                                        SHALL:handlePH Core Consumer
                                        MAY:able-to-populatePH Core Creator
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        82. Encounter.hospitalization.specialCourtesy.coding
                                        Definition

                                        A reference to a code defined by a terminology system.

                                        ShortCode defined by a terminology system
                                        Comments

                                        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                        Control0..*
                                        TypeCoding
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Obligations
                                          ObligationsActor
                                          SHALL:handlePH Core Server
                                          SHALL:handlePH Core Consumer
                                          MAY:able-to-populatePH Core Creator
                                          Summarytrue
                                          Requirements

                                          Allows for alternative encodings within a code system, and translations to other code systems.

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

                                          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                          ShortPlain text representation of the concept
                                          Comments

                                          Very often the text is the same as a displayName of one of the codings.

                                          Control0..1
                                          Typestring
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Obligations
                                            ObligationsActor
                                            SHALL:handlePH Core Server
                                            SHALL:handlePH Core Consumer
                                            MAY:able-to-populatePH Core Creator
                                            Summarytrue
                                            Requirements

                                            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            86. 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 SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements|4.0.1
                                            (preferred to http://hl7.org/fhir/ValueSet/encounter-special-arrangements|4.0.1)

                                            Special arrangements.

                                            TypeCodeableConcept
                                            Is Modifierfalse
                                            Must Supporttrue
                                            Obligations
                                              ObligationsActor
                                              SHALL:handlePH Core Server
                                              SHALL:handlePH Core Consumer
                                              MAY:able-to-populatePH Core Creator
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              88. Encounter.hospitalization.specialArrangement.coding
                                              Definition

                                              A reference to a code defined by a terminology system.

                                              ShortCode defined by a terminology system
                                              Comments

                                              Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                              Control0..*
                                              TypeCoding
                                              Is Modifierfalse
                                              Must Supporttrue
                                              Obligations
                                                ObligationsActor
                                                SHALL:handlePH Core Server
                                                SHALL:handlePH Core Consumer
                                                MAY:able-to-populatePH Core Creator
                                                Summarytrue
                                                Requirements

                                                Allows for alternative encodings within a code system, and translations to other code systems.

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

                                                A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                ShortPlain text representation of the concept
                                                Comments

                                                Very often the text is the same as a displayName of one of the codings.

                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supporttrue
                                                Obligations
                                                  ObligationsActor
                                                  SHALL:handlePH Core Server
                                                  SHALL:handlePH Core Consumer
                                                  MAY:able-to-populatePH Core Creator
                                                  Summarytrue
                                                  Requirements

                                                  The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

                                                  Category or kind of location after discharge.

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

                                                  Discharge Disposition.

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

                                                  The location where the encounter takes place.

                                                  ShortLocation the encounter takes place
                                                  Control1..1
                                                  TypeReference(PH Core Location, Location)
                                                  Is Modifierfalse
                                                  Must Supporttrue
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  100. 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 LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type|4.0.1
                                                  (example to http://hl7.org/fhir/ValueSet/location-physical-type|4.0.1)

                                                  Physical form of the location.

                                                  TypeCodeableConcept
                                                  Is Modifierfalse
                                                  Must Supporttrue
                                                  Obligations
                                                    ObligationsActor
                                                    SHALL:handlePH Core Server
                                                    SHALL:handlePH Core Consumer
                                                    MAY:able-to-populatePH Core Creator
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    102. Encounter.location.physicalType.coding
                                                    Definition

                                                    A reference to a code defined by a terminology system.

                                                    ShortCode defined by a terminology system
                                                    Comments

                                                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                    Control0..*
                                                    TypeCoding
                                                    Is Modifierfalse
                                                    Must Supporttrue
                                                    Obligations
                                                      ObligationsActor
                                                      SHALL:handlePH Core Server
                                                      SHALL:handlePH Core Consumer
                                                      MAY:able-to-populatePH Core Creator
                                                      Summarytrue
                                                      Requirements

                                                      Allows for alternative encodings within a code system, and translations to other code systems.

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

                                                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                      ShortPlain text representation of the concept
                                                      Comments

                                                      Very often the text is the same as a displayName of one of the codings.

                                                      Control0..1
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supporttrue
                                                      Obligations
                                                        ObligationsActor
                                                        SHALL:handlePH Core Server
                                                        SHALL:handlePH Core Consumer
                                                        MAY:able-to-populatePH Core Creator
                                                        Summarytrue
                                                        Requirements

                                                        The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        106. 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(PH Core Organization, Organization)
                                                        Is Modifierfalse
                                                        Must Supporttrue
                                                        Summaryfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

                                                        0. Encounter
                                                        2. Encounter.identifier
                                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                                        Must Supporttrue
                                                        4. Encounter.status
                                                        Must Supporttrue
                                                        6. Encounter.class
                                                        Must Supporttrue
                                                        8. Encounter.type
                                                        Must Supporttrue
                                                        10. Encounter.serviceType
                                                        Must Supporttrue
                                                        Obligations
                                                          ObligationsActor
                                                          SHALL:handlePH Core Server
                                                          SHALL:handlePH Core Consumer
                                                          MAY:able-to-populatePH Core Creator
                                                          12. Encounter.serviceType.coding
                                                          Must Supporttrue
                                                          Obligations
                                                            ObligationsActor
                                                            SHALL:handlePH Core Server
                                                            SHALL:handlePH Core Consumer
                                                            MAY:able-to-populatePH Core Creator
                                                            14. Encounter.serviceType.text
                                                            Must Supporttrue
                                                            Obligations
                                                              ObligationsActor
                                                              SHALL:handlePH Core Server
                                                              SHALL:handlePH Core Consumer
                                                              MAY:able-to-populatePH Core Creator
                                                              16. Encounter.priority
                                                              Must Supporttrue
                                                              Obligations
                                                                ObligationsActor
                                                                SHALL:handlePH Core Server
                                                                SHALL:handlePH Core Consumer
                                                                MAY:able-to-populatePH Core Creator
                                                                18. Encounter.priority.coding
                                                                Must Supporttrue
                                                                Obligations
                                                                  ObligationsActor
                                                                  SHALL:handlePH Core Server
                                                                  SHALL:handlePH Core Consumer
                                                                  MAY:able-to-populatePH Core Creator
                                                                  20. Encounter.priority.text
                                                                  Must Supporttrue
                                                                  Obligations
                                                                    ObligationsActor
                                                                    SHALL:handlePH Core Server
                                                                    SHALL:handlePH Core Consumer
                                                                    MAY:able-to-populatePH Core Creator
                                                                    22. Encounter.subject
                                                                    Control1..?
                                                                    TypeReference(PH Core Patient, Group)
                                                                    Must Supporttrue
                                                                    Must Support TypesNo must-support rules about the choice of types/profiles
                                                                    24. Encounter.participant
                                                                    Must Supporttrue
                                                                    26. Encounter.participant.type
                                                                    Must Supporttrue
                                                                    28. Encounter.participant.individual
                                                                    TypeReference(PH Core Practitioner, PH Core RelatedPerson, PH Core PractitionerRole)
                                                                    30. Encounter.period
                                                                    Must Supporttrue
                                                                    32. Encounter.period.start
                                                                    Must Supporttrue
                                                                    34. Encounter.reasonCode
                                                                    Must Supporttrue
                                                                    36. Encounter.reasonReference
                                                                    TypeReference(Condition, PH Core Observation, PH Core Procedure, ImmunizationRecommendation)
                                                                    Must Supporttrue
                                                                    Must Support TypesNo must-support rules about the choice of types/profiles
                                                                    38. Encounter.diagnosis
                                                                    40. Encounter.diagnosis.condition
                                                                    TypeReference(Condition, PH Core Procedure)
                                                                    42. Encounter.diagnosis.use
                                                                    Must Supporttrue
                                                                    Obligations
                                                                      ObligationsActor
                                                                      SHALL:handlePH Core Server
                                                                      SHALL:handlePH Core Consumer
                                                                      MAY:able-to-populatePH Core Creator
                                                                      44. Encounter.diagnosis.use.coding
                                                                      Must Supporttrue
                                                                      Obligations
                                                                        ObligationsActor
                                                                        SHALL:handlePH Core Server
                                                                        SHALL:handlePH Core Consumer
                                                                        MAY:able-to-populatePH Core Creator
                                                                        46. Encounter.diagnosis.use.text
                                                                        Must Supporttrue
                                                                        Obligations
                                                                          ObligationsActor
                                                                          SHALL:handlePH Core Server
                                                                          SHALL:handlePH Core Consumer
                                                                          MAY:able-to-populatePH Core Creator
                                                                          48. Encounter.hospitalization
                                                                          Must Supporttrue
                                                                          50. Encounter.hospitalization.origin
                                                                          TypeReference(PH Core Location, PH Core Organization)
                                                                          Must Supporttrue
                                                                          Must Support TypesNo must-support rules about the choice of types/profiles
                                                                          52. Encounter.hospitalization.admitSource
                                                                          Must Supporttrue
                                                                          Obligations
                                                                            ObligationsActor
                                                                            SHALL:handlePH Core Server
                                                                            SHALL:handlePH Core Consumer
                                                                            MAY:able-to-populatePH Core Creator
                                                                            54. Encounter.hospitalization.admitSource.coding
                                                                            Must Supporttrue
                                                                            Obligations
                                                                              ObligationsActor
                                                                              SHALL:handlePH Core Server
                                                                              SHALL:handlePH Core Consumer
                                                                              MAY:able-to-populatePH Core Creator
                                                                              56. Encounter.hospitalization.admitSource.text
                                                                              Must Supporttrue
                                                                              Obligations
                                                                                ObligationsActor
                                                                                SHALL:handlePH Core Server
                                                                                SHALL:handlePH Core Consumer
                                                                                MAY:able-to-populatePH Core Creator
                                                                                58. Encounter.hospitalization.reAdmission
                                                                                Must Supporttrue
                                                                                Obligations
                                                                                  ObligationsActor
                                                                                  SHALL:handlePH Core Server
                                                                                  SHALL:handlePH Core Consumer
                                                                                  MAY:able-to-populatePH Core Creator
                                                                                  60. Encounter.hospitalization.reAdmission.coding
                                                                                  Must Supporttrue
                                                                                  Obligations
                                                                                    ObligationsActor
                                                                                    SHALL:handlePH Core Server
                                                                                    SHALL:handlePH Core Consumer
                                                                                    MAY:able-to-populatePH Core Creator
                                                                                    62. Encounter.hospitalization.reAdmission.text
                                                                                    Must Supporttrue
                                                                                    Obligations
                                                                                      ObligationsActor
                                                                                      SHALL:handlePH Core Server
                                                                                      SHALL:handlePH Core Consumer
                                                                                      MAY:able-to-populatePH Core Creator
                                                                                      64. Encounter.hospitalization.dietPreference
                                                                                      Must Supporttrue
                                                                                      Obligations
                                                                                        ObligationsActor
                                                                                        SHALL:handlePH Core Server
                                                                                        SHALL:handlePH Core Consumer
                                                                                        MAY:able-to-populatePH Core Creator
                                                                                        66. Encounter.hospitalization.dietPreference.coding
                                                                                        Must Supporttrue
                                                                                        Obligations
                                                                                          ObligationsActor
                                                                                          SHALL:handlePH Core Server
                                                                                          SHALL:handlePH Core Consumer
                                                                                          MAY:able-to-populatePH Core Creator
                                                                                          68. Encounter.hospitalization.dietPreference.text
                                                                                          Must Supporttrue
                                                                                          Obligations
                                                                                            ObligationsActor
                                                                                            SHALL:handlePH Core Server
                                                                                            SHALL:handlePH Core Consumer
                                                                                            MAY:able-to-populatePH Core Creator
                                                                                            70. Encounter.hospitalization.specialCourtesy
                                                                                            Must Supporttrue
                                                                                            Obligations
                                                                                              ObligationsActor
                                                                                              SHALL:handlePH Core Server
                                                                                              SHALL:handlePH Core Consumer
                                                                                              MAY:able-to-populatePH Core Creator
                                                                                              72. Encounter.hospitalization.specialCourtesy.coding
                                                                                              Must Supporttrue
                                                                                              Obligations
                                                                                                ObligationsActor
                                                                                                SHALL:handlePH Core Server
                                                                                                SHALL:handlePH Core Consumer
                                                                                                MAY:able-to-populatePH Core Creator
                                                                                                74. Encounter.hospitalization.specialCourtesy.text
                                                                                                Must Supporttrue
                                                                                                Obligations
                                                                                                  ObligationsActor
                                                                                                  SHALL:handlePH Core Server
                                                                                                  SHALL:handlePH Core Consumer
                                                                                                  MAY:able-to-populatePH Core Creator
                                                                                                  76. Encounter.hospitalization.specialArrangement
                                                                                                  Must Supporttrue
                                                                                                  Obligations
                                                                                                    ObligationsActor
                                                                                                    SHALL:handlePH Core Server
                                                                                                    SHALL:handlePH Core Consumer
                                                                                                    MAY:able-to-populatePH Core Creator
                                                                                                    78. Encounter.hospitalization.specialArrangement.coding
                                                                                                    Must Supporttrue
                                                                                                    Obligations
                                                                                                      ObligationsActor
                                                                                                      SHALL:handlePH Core Server
                                                                                                      SHALL:handlePH Core Consumer
                                                                                                      MAY:able-to-populatePH Core Creator
                                                                                                      80. Encounter.hospitalization.specialArrangement.text
                                                                                                      Must Supporttrue
                                                                                                      Obligations
                                                                                                        ObligationsActor
                                                                                                        SHALL:handlePH Core Server
                                                                                                        SHALL:handlePH Core Consumer
                                                                                                        MAY:able-to-populatePH Core Creator
                                                                                                        82. Encounter.hospitalization.dischargeDisposition
                                                                                                        Must Supporttrue
                                                                                                        84. Encounter.location
                                                                                                        Must Supporttrue
                                                                                                        86. Encounter.location.location
                                                                                                        TypeReference(PH Core Location)
                                                                                                        Must Supporttrue
                                                                                                        88. Encounter.location.physicalType
                                                                                                        Must Supporttrue
                                                                                                        Obligations
                                                                                                          ObligationsActor
                                                                                                          SHALL:handlePH Core Server
                                                                                                          SHALL:handlePH Core Consumer
                                                                                                          MAY:able-to-populatePH Core Creator
                                                                                                          90. Encounter.location.physicalType.coding
                                                                                                          Must Supporttrue
                                                                                                          Obligations
                                                                                                            ObligationsActor
                                                                                                            SHALL:handlePH Core Server
                                                                                                            SHALL:handlePH Core Consumer
                                                                                                            MAY:able-to-populatePH Core Creator
                                                                                                            92. Encounter.location.physicalType.text
                                                                                                            Must Supporttrue
                                                                                                            Obligations
                                                                                                              ObligationsActor
                                                                                                              SHALL:handlePH Core Server
                                                                                                              SHALL:handlePH Core Consumer
                                                                                                              MAY:able-to-populatePH Core Creator
                                                                                                              94. Encounter.serviceProvider
                                                                                                              TypeReference(PH Core Organization)
                                                                                                              Must Supporttrue

                                                                                                              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.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()))
                                                                                                              8. Encounter.language
                                                                                                              Definition

                                                                                                              The base language in which the resource is written.

                                                                                                              ShortLanguage of the resource content
                                                                                                              Comments

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

                                                                                                              Control0..1
                                                                                                              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()))
                                                                                                              10. 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()))
                                                                                                              12. Encounter.contained
                                                                                                              Definition

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

                                                                                                              ShortContained, inline Resources
                                                                                                              Comments

                                                                                                              This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. 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
                                                                                                              14. Encounter.extension
                                                                                                              Definition

                                                                                                              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.

                                                                                                              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())
                                                                                                              16. 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())
                                                                                                              18. 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
                                                                                                              Must Supporttrue
                                                                                                              Summarytrue
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              20. 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
                                                                                                              Must Supporttrue
                                                                                                              Summarytrue
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              22. 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()))
                                                                                                              24. 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
                                                                                                              26. 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())
                                                                                                              28. 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())
                                                                                                              30. 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()))
                                                                                                              32. 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()))
                                                                                                              34. 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
                                                                                                              (extensible to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode)

                                                                                                              Classification of the encounter.

                                                                                                              TypeCoding
                                                                                                              Is Modifierfalse
                                                                                                              Must Supporttrue
                                                                                                              Summarytrue
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              36. 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()))
                                                                                                              38. 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
                                                                                                              40. 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())
                                                                                                              42. 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())
                                                                                                              44. Encounter.classHistory.class
                                                                                                              Definition

                                                                                                              inpatient | outpatient | ambulatory | emergency +.

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

                                                                                                              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()))
                                                                                                              46. 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()))
                                                                                                              48. 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
                                                                                                              Must Supporttrue
                                                                                                              Summarytrue
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              50. 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
                                                                                                              Must Supporttrue
                                                                                                              Obligations
                                                                                                                ObligationsActor
                                                                                                                SHALL:handlePH Core Server
                                                                                                                SHALL:handlePH Core Consumer
                                                                                                                MAY:able-to-populatePH Core Creator
                                                                                                                Summarytrue
                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                52. Encounter.serviceType.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.serviceType.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())
                                                                                                                SlicingThis element introduces a set of slices on Encounter.serviceType.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                • value @ url
                                                                                                                • 56. Encounter.serviceType.coding
                                                                                                                  Definition

                                                                                                                  A reference to a code defined by a terminology system.

                                                                                                                  ShortCode defined by a terminology system
                                                                                                                  Comments

                                                                                                                  Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                  Control0..*
                                                                                                                  TypeCoding
                                                                                                                  Is Modifierfalse
                                                                                                                  Must Supporttrue
                                                                                                                  Obligations
                                                                                                                    ObligationsActor
                                                                                                                    SHALL:handlePH Core Server
                                                                                                                    SHALL:handlePH Core Consumer
                                                                                                                    MAY:able-to-populatePH Core Creator
                                                                                                                    Summarytrue
                                                                                                                    Requirements

                                                                                                                    Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    58. Encounter.serviceType.text
                                                                                                                    Definition

                                                                                                                    A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                    ShortPlain text representation of the concept
                                                                                                                    Comments

                                                                                                                    Very often the text is the same as a displayName of one of the codings.

                                                                                                                    Control0..1
                                                                                                                    Typestring
                                                                                                                    Is Modifierfalse
                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                    Must Supporttrue
                                                                                                                    Obligations
                                                                                                                      ObligationsActor
                                                                                                                      SHALL:handlePH Core Server
                                                                                                                      SHALL:handlePH Core Consumer
                                                                                                                      MAY:able-to-populatePH Core Creator
                                                                                                                      Summarytrue
                                                                                                                      Requirements

                                                                                                                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

                                                                                                                      Indicates the urgency of the encounter.

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

                                                                                                                      Indicates the urgency of the encounter.

                                                                                                                      TypeCodeableConcept
                                                                                                                      Is Modifierfalse
                                                                                                                      Must Supporttrue
                                                                                                                      Obligations
                                                                                                                        ObligationsActor
                                                                                                                        SHALL:handlePH Core Server
                                                                                                                        SHALL:handlePH Core Consumer
                                                                                                                        MAY:able-to-populatePH Core Creator
                                                                                                                        Summaryfalse
                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                        62. Encounter.priority.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
                                                                                                                        64. Encounter.priority.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())
                                                                                                                        SlicingThis element introduces a set of slices on Encounter.priority.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                        • value @ url
                                                                                                                        • 66. Encounter.priority.coding
                                                                                                                          Definition

                                                                                                                          A reference to a code defined by a terminology system.

                                                                                                                          ShortCode defined by a terminology system
                                                                                                                          Comments

                                                                                                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                          Control0..*
                                                                                                                          TypeCoding
                                                                                                                          Is Modifierfalse
                                                                                                                          Must Supporttrue
                                                                                                                          Obligations
                                                                                                                            ObligationsActor
                                                                                                                            SHALL:handlePH Core Server
                                                                                                                            SHALL:handlePH Core Consumer
                                                                                                                            MAY:able-to-populatePH Core Creator
                                                                                                                            Summarytrue
                                                                                                                            Requirements

                                                                                                                            Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                            68. Encounter.priority.text
                                                                                                                            Definition

                                                                                                                            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                            ShortPlain text representation of the concept
                                                                                                                            Comments

                                                                                                                            Very often the text is the same as a displayName of one of the codings.

                                                                                                                            Control0..1
                                                                                                                            Typestring
                                                                                                                            Is Modifierfalse
                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                            Must Supporttrue
                                                                                                                            Obligations
                                                                                                                              ObligationsActor
                                                                                                                              SHALL:handlePH Core Server
                                                                                                                              SHALL:handlePH Core Consumer
                                                                                                                              MAY:able-to-populatePH Core Creator
                                                                                                                              Summarytrue
                                                                                                                              Requirements

                                                                                                                              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

                                                                                                                              Control1..1
                                                                                                                              TypeReference(PH Core Patient, Group)
                                                                                                                              Is Modifierfalse
                                                                                                                              Must Supporttrue
                                                                                                                              Must Support TypesNo must-support rules about the choice of types/profiles
                                                                                                                              Summarytrue
                                                                                                                              Alternate Namespatient
                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                              72. 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()))
                                                                                                                              74. 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()))
                                                                                                                              76. Encounter.participant
                                                                                                                              Definition

                                                                                                                              The list of people responsible for providing the service.

                                                                                                                              ShortList of participants involved in the encounter
                                                                                                                              Control0..*
                                                                                                                              TypeBackboneElement
                                                                                                                              Is Modifierfalse
                                                                                                                              Must Supporttrue
                                                                                                                              Summarytrue
                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                              78. 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
                                                                                                                              80. 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())
                                                                                                                              82. 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())
                                                                                                                              84. 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
                                                                                                                              Must Supporttrue
                                                                                                                              Summarytrue
                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                              86. 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()))
                                                                                                                              88. 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(PH Core Practitioner, PH Core RelatedPerson, PH Core PractitionerRole)
                                                                                                                              Is Modifierfalse
                                                                                                                              Summarytrue
                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                              90. 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()))
                                                                                                                              92. 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
                                                                                                                              Must Supporttrue
                                                                                                                              Summaryfalse
                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                              94. 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
                                                                                                                              96. Encounter.period.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())
                                                                                                                              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
                                                                                                                              • 98. 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
                                                                                                                                Must Supporttrue
                                                                                                                                Summarytrue
                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                100. 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()))
                                                                                                                                102. 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()))
                                                                                                                                104. 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
                                                                                                                                Must Supporttrue
                                                                                                                                Summarytrue
                                                                                                                                Alternate NamesIndication, Admission diagnosis
                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                106. 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, PH Core Observation, PH Core Procedure, ImmunizationRecommendation)
                                                                                                                                Is Modifierfalse
                                                                                                                                Must Supporttrue
                                                                                                                                Must Support TypesNo must-support rules about the choice of types/profiles
                                                                                                                                Summarytrue
                                                                                                                                Alternate NamesIndication, Admission diagnosis
                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                108. 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()))
                                                                                                                                110. Encounter.diagnosis.id
                                                                                                                                Definition

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

                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                Control0..1
                                                                                                                                Typestring
                                                                                                                                Is Modifierfalse
                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                Summaryfalse
                                                                                                                                112. 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())
                                                                                                                                114. Encounter.diagnosis.modifierExtension
                                                                                                                                Definition

                                                                                                                                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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())
                                                                                                                                116. Encounter.diagnosis.condition
                                                                                                                                Definition

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

                                                                                                                                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, PH Core 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()))
                                                                                                                                118. 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
                                                                                                                                Must Supporttrue
                                                                                                                                Obligations
                                                                                                                                  ObligationsActor
                                                                                                                                  SHALL:handlePH Core Server
                                                                                                                                  SHALL:handlePH Core Consumer
                                                                                                                                  MAY:able-to-populatePH Core Creator
                                                                                                                                  Summaryfalse
                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                  120. Encounter.diagnosis.use.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
                                                                                                                                  122. Encounter.diagnosis.use.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())
                                                                                                                                  SlicingThis element introduces a set of slices on Encounter.diagnosis.use.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                  • value @ url
                                                                                                                                  • 124. Encounter.diagnosis.use.coding
                                                                                                                                    Definition

                                                                                                                                    A reference to a code defined by a terminology system.

                                                                                                                                    ShortCode defined by a terminology system
                                                                                                                                    Comments

                                                                                                                                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                    Control0..*
                                                                                                                                    TypeCoding
                                                                                                                                    Is Modifierfalse
                                                                                                                                    Must Supporttrue
                                                                                                                                    Obligations
                                                                                                                                      ObligationsActor
                                                                                                                                      SHALL:handlePH Core Server
                                                                                                                                      SHALL:handlePH Core Consumer
                                                                                                                                      MAY:able-to-populatePH Core Creator
                                                                                                                                      Summarytrue
                                                                                                                                      Requirements

                                                                                                                                      Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      126. Encounter.diagnosis.use.text
                                                                                                                                      Definition

                                                                                                                                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                      ShortPlain text representation of the concept
                                                                                                                                      Comments

                                                                                                                                      Very often the text is the same as a displayName of one of the codings.

                                                                                                                                      Control0..1
                                                                                                                                      Typestring
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Must Supporttrue
                                                                                                                                      Obligations
                                                                                                                                        ObligationsActor
                                                                                                                                        SHALL:handlePH Core Server
                                                                                                                                        SHALL:handlePH Core Consumer
                                                                                                                                        MAY:able-to-populatePH Core Creator
                                                                                                                                        Summarytrue
                                                                                                                                        Requirements

                                                                                                                                        The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        128. 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()))
                                                                                                                                        130. 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()))
                                                                                                                                        132. 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
                                                                                                                                        Must Supporttrue
                                                                                                                                        Summaryfalse
                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        134. 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
                                                                                                                                        136. 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())
                                                                                                                                        138. 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())
                                                                                                                                        140. 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()))
                                                                                                                                        142. 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(PH Core Location, PH Core Organization)
                                                                                                                                        Is Modifierfalse
                                                                                                                                        Must Supporttrue
                                                                                                                                        Must Support TypesNo must-support rules about the choice of types/profiles
                                                                                                                                        Summaryfalse
                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        144. 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
                                                                                                                                        Must Supporttrue
                                                                                                                                        Obligations
                                                                                                                                          ObligationsActor
                                                                                                                                          SHALL:handlePH Core Server
                                                                                                                                          SHALL:handlePH Core Consumer
                                                                                                                                          MAY:able-to-populatePH Core Creator
                                                                                                                                          Summaryfalse
                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                          146. Encounter.hospitalization.admitSource.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
                                                                                                                                          148. Encounter.hospitalization.admitSource.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())
                                                                                                                                          SlicingThis element introduces a set of slices on Encounter.hospitalization.admitSource.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                          • value @ url
                                                                                                                                          • 150. Encounter.hospitalization.admitSource.coding
                                                                                                                                            Definition

                                                                                                                                            A reference to a code defined by a terminology system.

                                                                                                                                            ShortCode defined by a terminology system
                                                                                                                                            Comments

                                                                                                                                            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                            Control0..*
                                                                                                                                            TypeCoding
                                                                                                                                            Is Modifierfalse
                                                                                                                                            Must Supporttrue
                                                                                                                                            Obligations
                                                                                                                                              ObligationsActor
                                                                                                                                              SHALL:handlePH Core Server
                                                                                                                                              SHALL:handlePH Core Consumer
                                                                                                                                              MAY:able-to-populatePH Core Creator
                                                                                                                                              Summarytrue
                                                                                                                                              Requirements

                                                                                                                                              Allows for alternative encodings within a code system, and translations to other code systems.

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

                                                                                                                                              A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                              ShortPlain text representation of the concept
                                                                                                                                              Comments

                                                                                                                                              Very often the text is the same as a displayName of one of the codings.

                                                                                                                                              Control0..1
                                                                                                                                              Typestring
                                                                                                                                              Is Modifierfalse
                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                              Must Supporttrue
                                                                                                                                              Obligations
                                                                                                                                                ObligationsActor
                                                                                                                                                SHALL:handlePH Core Server
                                                                                                                                                SHALL:handlePH Core Consumer
                                                                                                                                                MAY:able-to-populatePH Core Creator
                                                                                                                                                Summarytrue
                                                                                                                                                Requirements

                                                                                                                                                The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                154. 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 hl7VS-re-admissionIndicator
                                                                                                                                                (example to http://terminology.hl7.org/ValueSet/v2-0092)

                                                                                                                                                The reason for re-admission of this hospitalization encounter.

                                                                                                                                                TypeCodeableConcept
                                                                                                                                                Is Modifierfalse
                                                                                                                                                Must Supporttrue
                                                                                                                                                Obligations
                                                                                                                                                  ObligationsActor
                                                                                                                                                  SHALL:handlePH Core Server
                                                                                                                                                  SHALL:handlePH Core Consumer
                                                                                                                                                  MAY:able-to-populatePH Core Creator
                                                                                                                                                  Summaryfalse
                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                  156. Encounter.hospitalization.reAdmission.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
                                                                                                                                                  158. Encounter.hospitalization.reAdmission.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())
                                                                                                                                                  SlicingThis element introduces a set of slices on Encounter.hospitalization.reAdmission.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                  • value @ url
                                                                                                                                                  • 160. Encounter.hospitalization.reAdmission.coding
                                                                                                                                                    Definition

                                                                                                                                                    A reference to a code defined by a terminology system.

                                                                                                                                                    ShortCode defined by a terminology system
                                                                                                                                                    Comments

                                                                                                                                                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                    Control0..*
                                                                                                                                                    TypeCoding
                                                                                                                                                    Is Modifierfalse
                                                                                                                                                    Must Supporttrue
                                                                                                                                                    Obligations
                                                                                                                                                      ObligationsActor
                                                                                                                                                      SHALL:handlePH Core Server
                                                                                                                                                      SHALL:handlePH Core Consumer
                                                                                                                                                      MAY:able-to-populatePH Core Creator
                                                                                                                                                      Summarytrue
                                                                                                                                                      Requirements

                                                                                                                                                      Allows for alternative encodings within a code system, and translations to other code systems.

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

                                                                                                                                                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                                      ShortPlain text representation of the concept
                                                                                                                                                      Comments

                                                                                                                                                      Very often the text is the same as a displayName of one of the codings.

                                                                                                                                                      Control0..1
                                                                                                                                                      Typestring
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                      Must Supporttrue
                                                                                                                                                      Obligations
                                                                                                                                                        ObligationsActor
                                                                                                                                                        SHALL:handlePH Core Server
                                                                                                                                                        SHALL:handlePH Core Consumer
                                                                                                                                                        MAY:able-to-populatePH Core Creator
                                                                                                                                                        Summarytrue
                                                                                                                                                        Requirements

                                                                                                                                                        The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                        164. 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
                                                                                                                                                        Must Supporttrue
                                                                                                                                                        Obligations
                                                                                                                                                          ObligationsActor
                                                                                                                                                          SHALL:handlePH Core Server
                                                                                                                                                          SHALL:handlePH Core Consumer
                                                                                                                                                          MAY:able-to-populatePH Core Creator
                                                                                                                                                          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()))
                                                                                                                                                          166. Encounter.hospitalization.dietPreference.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
                                                                                                                                                          168. Encounter.hospitalization.dietPreference.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())
                                                                                                                                                          SlicingThis element introduces a set of slices on Encounter.hospitalization.dietPreference.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                          • value @ url
                                                                                                                                                          • 170. Encounter.hospitalization.dietPreference.coding
                                                                                                                                                            Definition

                                                                                                                                                            A reference to a code defined by a terminology system.

                                                                                                                                                            ShortCode defined by a terminology system
                                                                                                                                                            Comments

                                                                                                                                                            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                            Control0..*
                                                                                                                                                            TypeCoding
                                                                                                                                                            Is Modifierfalse
                                                                                                                                                            Must Supporttrue
                                                                                                                                                            Obligations
                                                                                                                                                              ObligationsActor
                                                                                                                                                              SHALL:handlePH Core Server
                                                                                                                                                              SHALL:handlePH Core Consumer
                                                                                                                                                              MAY:able-to-populatePH Core Creator
                                                                                                                                                              Summarytrue
                                                                                                                                                              Requirements

                                                                                                                                                              Allows for alternative encodings within a code system, and translations to other code systems.

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

                                                                                                                                                              A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                                              ShortPlain text representation of the concept
                                                                                                                                                              Comments

                                                                                                                                                              Very often the text is the same as a displayName of one of the codings.

                                                                                                                                                              Control0..1
                                                                                                                                                              Typestring
                                                                                                                                                              Is Modifierfalse
                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                              Must Supporttrue
                                                                                                                                                              Obligations
                                                                                                                                                                ObligationsActor
                                                                                                                                                                SHALL:handlePH Core Server
                                                                                                                                                                SHALL:handlePH Core Consumer
                                                                                                                                                                MAY:able-to-populatePH Core Creator
                                                                                                                                                                Summarytrue
                                                                                                                                                                Requirements

                                                                                                                                                                The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                174. 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
                                                                                                                                                                Must Supporttrue
                                                                                                                                                                Obligations
                                                                                                                                                                  ObligationsActor
                                                                                                                                                                  SHALL:handlePH Core Server
                                                                                                                                                                  SHALL:handlePH Core Consumer
                                                                                                                                                                  MAY:able-to-populatePH Core Creator
                                                                                                                                                                  Summaryfalse
                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                  176. Encounter.hospitalization.specialCourtesy.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
                                                                                                                                                                  178. Encounter.hospitalization.specialCourtesy.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())
                                                                                                                                                                  SlicingThis element introduces a set of slices on Encounter.hospitalization.specialCourtesy.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                  • value @ url
                                                                                                                                                                  • 180. Encounter.hospitalization.specialCourtesy.coding
                                                                                                                                                                    Definition

                                                                                                                                                                    A reference to a code defined by a terminology system.

                                                                                                                                                                    ShortCode defined by a terminology system
                                                                                                                                                                    Comments

                                                                                                                                                                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                                    Control0..*
                                                                                                                                                                    TypeCoding
                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                    Obligations
                                                                                                                                                                      ObligationsActor
                                                                                                                                                                      SHALL:handlePH Core Server
                                                                                                                                                                      SHALL:handlePH Core Consumer
                                                                                                                                                                      MAY:able-to-populatePH Core Creator
                                                                                                                                                                      Summarytrue
                                                                                                                                                                      Requirements

                                                                                                                                                                      Allows for alternative encodings within a code system, and translations to other code systems.

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

                                                                                                                                                                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                                                      ShortPlain text representation of the concept
                                                                                                                                                                      Comments

                                                                                                                                                                      Very often the text is the same as a displayName of one of the codings.

                                                                                                                                                                      Control0..1
                                                                                                                                                                      Typestring
                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                      Obligations
                                                                                                                                                                        ObligationsActor
                                                                                                                                                                        SHALL:handlePH Core Server
                                                                                                                                                                        SHALL:handlePH Core Consumer
                                                                                                                                                                        MAY:able-to-populatePH Core Creator
                                                                                                                                                                        Summarytrue
                                                                                                                                                                        Requirements

                                                                                                                                                                        The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                        184. 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
                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                        Obligations
                                                                                                                                                                          ObligationsActor
                                                                                                                                                                          SHALL:handlePH Core Server
                                                                                                                                                                          SHALL:handlePH Core Consumer
                                                                                                                                                                          MAY:able-to-populatePH Core Creator
                                                                                                                                                                          Summaryfalse
                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                          186. Encounter.hospitalization.specialArrangement.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
                                                                                                                                                                          188. Encounter.hospitalization.specialArrangement.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())
                                                                                                                                                                          SlicingThis element introduces a set of slices on Encounter.hospitalization.specialArrangement.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                          • value @ url
                                                                                                                                                                          • 190. Encounter.hospitalization.specialArrangement.coding
                                                                                                                                                                            Definition

                                                                                                                                                                            A reference to a code defined by a terminology system.

                                                                                                                                                                            ShortCode defined by a terminology system
                                                                                                                                                                            Comments

                                                                                                                                                                            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                                            Control0..*
                                                                                                                                                                            TypeCoding
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                            Obligations
                                                                                                                                                                              ObligationsActor
                                                                                                                                                                              SHALL:handlePH Core Server
                                                                                                                                                                              SHALL:handlePH Core Consumer
                                                                                                                                                                              MAY:able-to-populatePH Core Creator
                                                                                                                                                                              Summarytrue
                                                                                                                                                                              Requirements

                                                                                                                                                                              Allows for alternative encodings within a code system, and translations to other code systems.

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

                                                                                                                                                                              A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                                                              ShortPlain text representation of the concept
                                                                                                                                                                              Comments

                                                                                                                                                                              Very often the text is the same as a displayName of one of the codings.

                                                                                                                                                                              Control0..1
                                                                                                                                                                              Typestring
                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                              Obligations
                                                                                                                                                                                ObligationsActor
                                                                                                                                                                                SHALL:handlePH Core Server
                                                                                                                                                                                SHALL:handlePH Core Consumer
                                                                                                                                                                                MAY:able-to-populatePH Core Creator
                                                                                                                                                                                Summarytrue
                                                                                                                                                                                Requirements

                                                                                                                                                                                The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                194. 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()))
                                                                                                                                                                                196. 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
                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                198. 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
                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                200. 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
                                                                                                                                                                                202. 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())
                                                                                                                                                                                204. 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())
                                                                                                                                                                                206. Encounter.location.location
                                                                                                                                                                                Definition

                                                                                                                                                                                The location where the encounter takes place.

                                                                                                                                                                                ShortLocation the encounter takes place
                                                                                                                                                                                Control1..1
                                                                                                                                                                                TypeReference(PH Core Location)
                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                208. 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()))
                                                                                                                                                                                210. 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
                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                Obligations
                                                                                                                                                                                  ObligationsActor
                                                                                                                                                                                  SHALL:handlePH Core Server
                                                                                                                                                                                  SHALL:handlePH Core Consumer
                                                                                                                                                                                  MAY:able-to-populatePH Core Creator
                                                                                                                                                                                  Summaryfalse
                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                  212. Encounter.location.physicalType.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
                                                                                                                                                                                  214. Encounter.location.physicalType.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())
                                                                                                                                                                                  SlicingThis element introduces a set of slices on Encounter.location.physicalType.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                  • value @ url
                                                                                                                                                                                  • 216. Encounter.location.physicalType.coding
                                                                                                                                                                                    Definition

                                                                                                                                                                                    A reference to a code defined by a terminology system.

                                                                                                                                                                                    ShortCode defined by a terminology system
                                                                                                                                                                                    Comments

                                                                                                                                                                                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                                                    Control0..*
                                                                                                                                                                                    TypeCoding
                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                    Obligations
                                                                                                                                                                                      ObligationsActor
                                                                                                                                                                                      SHALL:handlePH Core Server
                                                                                                                                                                                      SHALL:handlePH Core Consumer
                                                                                                                                                                                      MAY:able-to-populatePH Core Creator
                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                      Requirements

                                                                                                                                                                                      Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                      218. Encounter.location.physicalType.text
                                                                                                                                                                                      Definition

                                                                                                                                                                                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                                                                      ShortPlain text representation of the concept
                                                                                                                                                                                      Comments

                                                                                                                                                                                      Very often the text is the same as a displayName of one of the codings.

                                                                                                                                                                                      Control0..1
                                                                                                                                                                                      Typestring
                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                      Obligations
                                                                                                                                                                                        ObligationsActor
                                                                                                                                                                                        SHALL:handlePH Core Server
                                                                                                                                                                                        SHALL:handlePH Core Consumer
                                                                                                                                                                                        MAY:able-to-populatePH Core Creator
                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                        Requirements

                                                                                                                                                                                        The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                        220. 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()))
                                                                                                                                                                                        222. 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(PH Core Organization)
                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                        224. 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()))