IL Core Implementation Guide
0.18.0 - draft Israel flag

This page is part of the IL-Core IG (v0.18.0: draft-1 Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: ILCoreEncounter - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 1

Definitions for the il-core-encounter resource profile.

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

0. Encounter
Definition

Israel Core proposed constraints and extensions on the Encounter resource profile.

ShortILCore Encounter Profile
2. Encounter.extension
SlicingThis element introduces a set of slices on Encounter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Encounter.extension:modeOfArrival
    Slice NamemodeOfArrival
    Control0..1
    TypeExtension(Encounter Mode Of Arrival) (Extension Type: Coding)
    6. Encounter.extension:modeOfArrival.value[x]
    BindingFor example codes, see Patient Mode of Arrival MoH
    (example to http://fhir.health.gov.il/ValueSet/patient-mode-of-arrival-moh)
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    8. Encounter.extension:paying-entity
    Slice Namepaying-entity
    Definition

    Paying Entity for the Encounter

    ShortExtension: Encounter Paying Entity
    Control0..*
    TypeExtension(Ext: Encounter Paying Entity) (Extension Type: CodeableConcept)
    10. Encounter.extension:movement-number
    Slice Namemovement-number
    Definition

    Extension: Movement Sequence-Number

    ShortExt: Movement Sequence-Number
    Control0..1
    TypeExtension(Ext: Movement Sequence-Number) (Extension Type: string)
    12. Encounter.identifier
    Definition

    Must support - <b>receiving system SHOULD store the value</b>

    NoteThis is a business identifier, not a resource identifier (see discussion)
    Must Supporttrue
    14. Encounter.status
    Definition

    Must support - <b>receiving system SHALL either store the value as-is or SHALL be able to translate it into internal state and SHALL be able to reconstruct the value when requested to retrieve data</b>

    Must Supporttrue
    16. Encounter.class
    Definition

    Must support - <b>receiving system SHALL either store the value as-is or SHALL be able to translate it into internal state and SHALL be able to reconstruct the value when requested to retrieve data</b>

    BindingUnless not suitable, these codes SHALL be taken from IL Core Encounter Class Codes
    (extensible to http://fhir.health.gov.il/ValueSet/il-core-encounter-class)
    Must Supporttrue
    18. Encounter.classHistory
    20. Encounter.classHistory.class
    BindingUnless not suitable, these codes SHALL be taken from IL Core Encounter Class Codes
    (extensible to http://fhir.health.gov.il/ValueSet/il-core-encounter-class)
    22. Encounter.type
    Definition

    Specific type of encounter that is orthogonal to class and serviceType (e.g. e-mail consultation)

    SlicingThis element introduces a set of slices on Encounter.type. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • pattern @ $this
    • 24. Encounter.type:virtual-encounters
      Slice Namevirtual-encounters
      Control0..*
      BindingThe codes SHALL be taken from IL Core Virtual encounter Type Codes
      (required to http://fhir.health.gov.il/ValueSet/il-core-virtual-type)
      26. Encounter.type:doctor-to-doctor-consultation
      Slice Namedoctor-to-doctor-consultation
      Control0..*
      BindingThe codes SHALL be taken from IL Core Doctor To Doctor Codes
      (required to http://fhir.health.gov.il/ValueSet/il-core-doctor-to-doctor)
      28. Encounter.serviceType
      BindingUnless not suitable, these codes SHALL be taken from IL Core Service type
      (extensible to http://fhir.health.gov.il/ValueSet/il-core-service-type)
      30. Encounter.subject
      Definition

      Must support - <b>receiving system SHALL either store the value as-is or SHALL be able to translate it into internal state and SHALL be able to reconstruct the value when requested to retrieve data</b>

      Control1..?
      TypeReference(ILCore Patient Profile, ILCore Group Profile)
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      32. Encounter.subject.extension:visitor-type
      Slice Namevisitor-type
      Definition

      Classification of the visitor type (סוג מבקר/סוג כניסה) for the Encounter

      ShortExtension: Israeli CORE Encounter Visitor Type
      Control0..1
      TypeExtension(Ext: Encounter Visitor Type) (Extension Type: CodeableConcept)
      34. Encounter.basedOn
      TypeReference(ILCore ServiceRequest Profile)
      36. Encounter.participant
      SlicingThis element introduces a set of slices on Encounter.participant. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ type
      • 38. Encounter.participant.individual
        TypeReference(ILCore Practitioner Profile, ILCore PractitionerRole Profile, ILCore RelatedPerson Profile)
        40. Encounter.participant:primary-performer
        Slice Nameprimary-performer
        Definition

        Must support - <b>receiving system SHALL either store the value as-is or SHALL be able to translate it into internal state and SHALL be able to reconstruct the value when requested to retrieve data</b>

        Control0..*
        Must Supporttrue
        42. Encounter.participant:primary-performer.type
        Control1..1
        Must Supporttrue
        44. Encounter.participant:primary-performer.type.coding
        46. Encounter.participant:primary-performer.type.coding.system
        Fixed Valuehttp://terminology.hl7.org/CodeSystem/v3-ParticipationType
        48. Encounter.participant:primary-performer.type.coding.code
        Fixed ValuePPRF
        50. Encounter.participant:primary-performer.period
        Must Supporttrue
        52. Encounter.participant:primary-performer.individual
        Control1..?
        TypeReference(ILCore Practitioner Profile, ILCore PractitionerRole Profile, ILCore RelatedPerson Profile)
        Must Supporttrue
        Must Support TypesNo must-support rules about the choice of types/profiles
        54. Encounter.period
        Definition

        Must support - <b>receiving system SHALL either store the value as-is or SHALL be able to translate it into internal state and SHALL be able to reconstruct the value when requested to retrieve data</b>

        Must Supporttrue
        56. Encounter.reasonCode
        SlicingThis element introduces a set of slices on Encounter.reasonCode. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • pattern @ $this
        • 58. Encounter.reasonCode:moh-reason-code
          Slice Namemoh-reason-code
          Control0..*
          BindingThe codes SHOULD be taken from Patient Visit Reason MoH
          (preferred to http://fhir.health.gov.il/ValueSet/patient-visit-reason-moh)
          60. Encounter.reasonReference
          TypeReference(ILCore Condition Profile, ILCore Procedure Profile, ILCore Observation Profile, ImmunizationRecommendation)
          62. Encounter.diagnosis
          64. Encounter.diagnosis.condition
          TypeReference(ILCore Condition Profile, ILCore Procedure Profile)
          66. Encounter.hospitalization
          68. Encounter.hospitalization.origin
          TypeReference(ILCore Location Profile, ILCore Organization Profile)
          70. Encounter.hospitalization.admitSource
          BindingThe codes SHOULD be taken from Patient Admit Source MoH
          (preferred to http://fhir.health.gov.il/ValueSet/patient-admit-source-moh)
          72. Encounter.hospitalization.destination
          TypeReference(ILCore Location Profile, ILCore Organization Profile)
          74. Encounter.hospitalization.dischargeDisposition
          BindingFor example codes, see Patient Realease Type MoH
          (example to http://fhir.health.gov.il/ValueSet/patient-release-type-moh)
          76. Encounter.location
          78. Encounter.location.location
          TypeReference(ILCore Location Profile)
          80. Encounter.serviceProvider
          Definition

          Must support - <b>receiving system SHALL either store the value as-is or SHALL be able to translate it into internal state and SHALL be able to reconstruct the value when requested to retrieve data</b>

          TypeReference(ILCore Organization Profile)
          Must Supporttrue
          82. Encounter.partOf
          TypeReference(ILCore Encounter Profile)

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

          0. Encounter
          Definition

          Israel Core proposed constraints and extensions on the Encounter resource profile.


          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.

          ShortILCore Encounter ProfileAn 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.extension
          Definition

          An Extension


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

          ShortExtensionAdditional content defined by implementations
          Comments

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

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

            Identifies whether a patient arrives at the reporting facility via ambulance and the type of ambulance that was used.

            ShortThe method of arrival of the patient into the facility
            Control0..1
            TypeExtension(Encounter Mode Of Arrival) (Extension Type: Coding)
            Is Modifierfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            8. Encounter.extension:modeOfArrival.extension
            Definition

            An Extension


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

            ShortExtensionAdditional content defined by implementations
            Comments

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

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

              Source of the definition for the extension code - a logical name or a URL.

              Shortidentifies the meaning of the extension
              Comments

              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

              Control1..1
              Typeuri
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              Fixed Valuehttp://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival
              12. Encounter.extension:modeOfArrival.value[x]
              Definition

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).


              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

              ShortValue of extension
              Control10..1
              This element is affected by the following invariants: ext-1
              BindingFor example codes, see For codes, see Patient Mode of Arrival MoH
              (example to http://fhir.health.gov.il/ValueSet/patient-mode-of-arrival-moh)
              TypeCoding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              14. Encounter.extension:paying-entity
              Slice Namepaying-entity
              Definition

              Paying Entity for the Encounter

              ShortExtension: Encounter Paying Entity
              Control0..*
              This element is affected by the following invariants: ele-1
              TypeExtension(Ext: Encounter Paying Entity) (Extension Type: CodeableConcept)
              Is Modifierfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              16. Encounter.extension:movement-number
              Slice Namemovement-number
              Definition

              Extension: Movement Sequence-Number

              ShortExt: Movement Sequence-Number
              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(Ext: Movement Sequence-Number) (Extension Type: string)
              Is Modifierfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              18. 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())
              20. Encounter.identifier
              Definition

              Must support - <b>receiving system SHOULD store the value</b>


              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()))
              22. Encounter.status
              Definition

              Must support - <b>receiving system SHALL either store the value as-is or SHALL be able to translate it into internal state and SHALL be able to reconstruct the value when requested to retrieve data</b>


              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()))
              24. Encounter.class
              Definition

              Must support - <b>receiving system SHALL either store the value as-is or SHALL be able to translate it into internal state and SHALL be able to reconstruct the value when requested to retrieve data</b>


              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 IL Core Encounter Class Codeshttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode
              (extensible to http://fhir.health.gov.il/ValueSet/il-core-encounter-class)
              TypeCoding
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              26. Encounter.type
              Definition

              Specific type of encounter that is orthogonal to class and serviceType (e.g. e-mail consultation)


              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
              (example to http://hl7.org/fhir/ValueSet/encounter-type)

              The type of encounter.

              TypeCodeableConcept
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              SlicingThis element introduces a set of slices on Encounter.type. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • pattern @ $this
              • 28. Encounter.type:virtual-encounters
                Slice Namevirtual-encounters
                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..*
                BindingThe codes SHALL be taken from For example codes, see IL Core Virtual encounter Type Codeshttp://hl7.org/fhir/ValueSet/encounter-type
                (required to http://fhir.health.gov.il/ValueSet/il-core-virtual-type)
                TypeCodeableConcept
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                30. Encounter.type:doctor-to-doctor-consultation
                Slice Namedoctor-to-doctor-consultation
                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..*
                BindingThe codes SHALL be taken from For example codes, see IL Core Doctor To Doctor Codeshttp://hl7.org/fhir/ValueSet/encounter-type
                (required to http://fhir.health.gov.il/ValueSet/il-core-doctor-to-doctor)
                TypeCodeableConcept
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                32. Encounter.serviceType
                Definition

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

                ShortSpecific type of service
                Control0..1
                BindingUnless not suitable, these codes SHALL be taken from For example codes, see IL Core Service typehttp://hl7.org/fhir/ValueSet/service-type
                (extensible to http://fhir.health.gov.il/ValueSet/il-core-service-type)
                TypeCodeableConcept
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                34. Encounter.subject
                Definition

                Must support - <b>receiving system SHALL either store the value as-is or SHALL be able to translate it into internal state and SHALL be able to reconstruct the value when requested to retrieve data</b>


                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(ILCore Patient Profile, ILCore Group Profile, 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()))
                36. Encounter.subject.extension:visitor-type
                Slice Namevisitor-type
                Definition

                Classification of the visitor type (סוג מבקר/סוג כניסה) for the Encounter

                ShortExtension: Israeli CORE Encounter Visitor Type
                Control0..1
                TypeExtension(Ext: Encounter Visitor Type) (Extension Type: CodeableConcept)
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                38. Encounter.basedOn
                Definition

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

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

                The list of people responsible for providing the service.

                ShortList of participants involved in the encounter
                Control0..*
                TypeBackboneElement
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                SlicingThis element introduces a set of slices on Encounter.participant. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ type
                • 42. 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())
                  44. 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(ILCore Practitioner Profile, ILCore PractitionerRole Profile, ILCore RelatedPerson Profile, Practitioner, PractitionerRole, RelatedPerson)
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  46. Encounter.participant:primary-performer
                  Slice Nameprimary-performer
                  Definition

                  Must support - <b>receiving system SHALL either store the value as-is or SHALL be able to translate it into internal state and SHALL be able to reconstruct the value when requested to retrieve data</b>


                  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()))
                  48. Encounter.participant:primary-performer.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())
                  50. Encounter.participant:primary-performer.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.

                  Control10..1*
                  BindingUnless not suitable, these codes SHALL be taken from ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type
                  (extensible to http://hl7.org/fhir/ValueSet/encounter-participant-type)

                  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()))
                  52. Encounter.participant:primary-performer.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
                  Must Supporttrue
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  54. Encounter.participant:primary-performer.individual
                  Definition

                  Persons involved in the encounter other than the patient.

                  ShortPersons involved in the encounter other than the patient
                  Control10..1
                  TypeReference(ILCore Practitioner Profile, ILCore PractitionerRole Profile, ILCore RelatedPerson Profile, Practitioner, PractitionerRole, RelatedPerson)
                  Is Modifierfalse
                  Must Supporttrue
                  Must Support TypesNo must-support rules about the choice of types/profiles
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  56. Encounter.period
                  Definition

                  Must support - <b>receiving system SHALL either store the value as-is or SHALL be able to translate it into internal state and SHALL be able to reconstruct the value when requested to retrieve data</b>


                  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()))
                  58. 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
                  (preferred to http://hl7.org/fhir/ValueSet/encounter-reason)

                  Reason why the encounter takes place.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Summarytrue
                  Alternate NamesIndication, Admission diagnosis
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  SlicingThis element introduces a set of slices on Encounter.reasonCode. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • pattern @ $this
                  • 60. Encounter.reasonCode:moh-reason-code
                    Slice Namemoh-reason-code
                    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 Patient Visit Reason MoHhttp://hl7.org/fhir/ValueSet/encounter-reason
                    (preferred to http://fhir.health.gov.il/ValueSet/patient-visit-reason-moh)
                    TypeCodeableConcept
                    Is Modifierfalse
                    Summarytrue
                    Alternate NamesIndication, Admission diagnosis
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    62. 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(ILCore Condition Profile, ILCore Procedure Profile, ILCore Observation Profile, ImmunizationRecommendation, Condition, Procedure, Observation)
                    Is Modifierfalse
                    Summarytrue
                    Alternate NamesIndication, Admission diagnosis
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    64. Encounter.serviceProvider
                    Definition

                    Must support - <b>receiving system SHALL either store the value as-is or SHALL be able to translate it into internal state and SHALL be able to reconstruct the value when requested to retrieve data</b>


                    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(ILCore Organization Profile, Organization)
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    66. 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(ILCore Encounter Profile, Encounter)
                    Is Modifierfalse
                    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 found here

                    0. Encounter
                    Definition

                    Israel Core proposed constraints and extensions on the Encounter resource profile.

                    ShortILCore Encounter Profile
                    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)

                    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

                    An Extension

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

                      Identifies whether a patient arrives at the reporting facility via ambulance and the type of ambulance that was used.

                      ShortThe method of arrival of the patient into the facility
                      Control0..1
                      TypeExtension(Encounter Mode Of Arrival) (Extension Type: Coding)
                      Is Modifierfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      18. Encounter.extension:modeOfArrival.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
                      This element is affected by the following invariants: ele-1
                      Typeid
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      20. Encounter.extension:modeOfArrival.extension
                      Definition

                      An Extension

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

                        Source of the definition for the extension code - a logical name or a URL.

                        Shortidentifies the meaning of the extension
                        Comments

                        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                        Control1..1
                        Typeuri
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        Fixed Valuehttp://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival
                        24. Encounter.extension:modeOfArrival.value[x]
                        Definition

                        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                        ShortValue of extension
                        Control1..1
                        This element is affected by the following invariants: ext-1
                        BindingFor example codes, see Patient Mode of Arrival MoH
                        (example to http://fhir.health.gov.il/ValueSet/patient-mode-of-arrival-moh)
                        TypeCoding
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        26. Encounter.extension:paying-entity
                        Slice Namepaying-entity
                        Definition

                        Paying Entity for the Encounter

                        ShortExtension: Encounter Paying Entity
                        Control0..*
                        This element is affected by the following invariants: ele-1
                        TypeExtension(Ext: Encounter Paying Entity) (Extension Type: CodeableConcept)
                        Is Modifierfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        28. Encounter.extension:movement-number
                        Slice Namemovement-number
                        Definition

                        Extension: Movement Sequence-Number

                        ShortExt: Movement Sequence-Number
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(Ext: Movement Sequence-Number) (Extension Type: string)
                        Is Modifierfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        30. 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())
                        32. Encounter.identifier
                        Definition

                        Must support - <b>receiving system SHOULD store the value</b>

                        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()))
                        34. Encounter.status
                        Definition

                        Must support - <b>receiving system SHALL either store the value as-is or SHALL be able to translate it into internal state and SHALL be able to reconstruct the value when requested to retrieve data</b>

                        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()))
                        36. 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()))
                        38. 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
                        40. 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())
                        42. 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())
                        44. 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()))
                        46. 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()))
                        48. Encounter.class
                        Definition

                        Must support - <b>receiving system SHALL either store the value as-is or SHALL be able to translate it into internal state and SHALL be able to reconstruct the value when requested to retrieve data</b>

                        ShortClassification of patient encounter
                        Control1..1
                        BindingUnless not suitable, these codes SHALL be taken from IL Core Encounter Class Codes
                        (extensible to http://fhir.health.gov.il/ValueSet/il-core-encounter-class)
                        TypeCoding
                        Is Modifierfalse
                        Must Supporttrue
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        50. 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()))
                        52. 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
                        54. 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())
                        56. 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())
                        58. Encounter.classHistory.class
                        Definition

                        inpatient | outpatient | ambulatory | emergency +.

                        Shortinpatient | outpatient | ambulatory | emergency +
                        Control1..1
                        BindingUnless not suitable, these codes SHALL be taken from IL Core Encounter Class Codes
                        (extensible to http://fhir.health.gov.il/ValueSet/il-core-encounter-class)
                        TypeCoding
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        60. 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()))
                        62. Encounter.type
                        Definition

                        Specific type of encounter that is orthogonal to class and serviceType (e.g. e-mail consultation)

                        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)

                        The type of encounter.

                        TypeCodeableConcept
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        SlicingThis element introduces a set of slices on Encounter.type. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • pattern @ $this
                        • 64. Encounter.type:virtual-encounters
                          Slice Namevirtual-encounters
                          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..*
                          BindingThe codes SHALL be taken from IL Core Virtual encounter Type Codes
                          (required to http://fhir.health.gov.il/ValueSet/il-core-virtual-type)
                          TypeCodeableConcept
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          66. Encounter.type:doctor-to-doctor-consultation
                          Slice Namedoctor-to-doctor-consultation
                          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..*
                          BindingThe codes SHALL be taken from IL Core Doctor To Doctor Codes
                          (required to http://fhir.health.gov.il/ValueSet/il-core-doctor-to-doctor)
                          TypeCodeableConcept
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          68. Encounter.serviceType
                          Definition

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

                          ShortSpecific type of service
                          Control0..1
                          BindingUnless not suitable, these codes SHALL be taken from IL Core Service type
                          (extensible to http://fhir.health.gov.il/ValueSet/il-core-service-type)
                          TypeCodeableConcept
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          70. 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
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          72. Encounter.subject
                          Definition

                          Must support - <b>receiving system SHALL either store the value as-is or SHALL be able to translate it into internal state and SHALL be able to reconstruct the value when requested to retrieve data</b>

                          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(ILCore Patient Profile, ILCore Group Profile)
                          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()))
                          74. Encounter.subject.id
                          Definition

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

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          76. Encounter.subject.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.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 78. Encounter.subject.extension:visitor-type
                            Slice Namevisitor-type
                            Definition

                            Classification of the visitor type (סוג מבקר/סוג כניסה) for the Encounter

                            ShortExtension: Israeli CORE Encounter Visitor Type
                            Control0..1
                            TypeExtension(Ext: Encounter Visitor Type) (Extension Type: CodeableConcept)
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            80. Encounter.subject.reference
                            Definition

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

                            ShortLiteral reference, Relative, internal or absolute URL
                            Comments

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

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

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

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

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

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

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

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

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

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

                            ShortLogical reference, when literal reference is not known
                            Comments

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

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

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

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

                            NoteThis is a business identifier, not a resource identifier (see discussion)
                            Control0..1
                            TypeIdentifier
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            86. Encounter.subject.display
                            Definition

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

                            ShortText alternative for the resource
                            Comments

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

                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            88. 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()))
                            90. Encounter.basedOn
                            Definition

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

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

                            The list of people responsible for providing the service.

                            ShortList of participants involved in the encounter
                            Control0..*
                            TypeBackboneElement
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            SlicingThis element introduces a set of slices on Encounter.participant. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ type
                            • 94. 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
                              96. 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())
                              98. 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())
                              100. 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)

                              Role of participant in encounter.

                              TypeCodeableConcept
                              Is Modifierfalse
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              102. 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()))
                              104. 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(ILCore Practitioner Profile, ILCore PractitionerRole Profile, ILCore RelatedPerson Profile)
                              Is Modifierfalse
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              106. Encounter.participant:primary-performer
                              Slice Nameprimary-performer
                              Definition

                              Must support - <b>receiving system SHALL either store the value as-is or SHALL be able to translate it into internal state and SHALL be able to reconstruct the value when requested to retrieve data</b>

                              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()))
                              108. Encounter.participant:primary-performer.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
                              110. Encounter.participant:primary-performer.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())
                              112. Encounter.participant:primary-performer.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())
                              114. Encounter.participant:primary-performer.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.

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

                              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()))
                              116. Encounter.participant:primary-performer.type.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
                              118. Encounter.participant:primary-performer.type.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.participant.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 120. Encounter.participant:primary-performer.type.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
                                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()))
                                122. Encounter.participant:primary-performer.type.coding.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
                                124. Encounter.participant:primary-performer.type.coding.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.participant.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 126. Encounter.participant:primary-performer.type.coding.system
                                  Definition

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

                                  ShortIdentity of the terminology system
                                  Comments

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

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

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

                                  Fixed Valuehttp://terminology.hl7.org/CodeSystem/v3-ParticipationType
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  128. Encounter.participant:primary-performer.type.coding.version
                                  Definition

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

                                  ShortVersion of the system - if relevant
                                  Comments

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

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

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

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

                                  Need to refer to a particular code in the system.

                                  Fixed ValuePPRF
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  132. Encounter.participant:primary-performer.type.coding.display
                                  Definition

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

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

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

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  134. Encounter.participant:primary-performer.type.coding.userSelected
                                  Definition

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

                                  ShortIf this coding was chosen directly by the user
                                  Comments

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

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

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

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  136. Encounter.participant:primary-performer.type.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
                                  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()))
                                  138. Encounter.participant:primary-performer.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
                                  Must Supporttrue
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  140. Encounter.participant:primary-performer.individual
                                  Definition

                                  Persons involved in the encounter other than the patient.

                                  ShortPersons involved in the encounter other than the patient
                                  Control1..1
                                  TypeReference(ILCore Practitioner Profile, ILCore PractitionerRole Profile, ILCore RelatedPerson Profile)
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Must Support TypesNo must-support rules about the choice of types/profiles
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  142. 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()))
                                  144. Encounter.period
                                  Definition

                                  Must support - <b>receiving system SHALL either store the value as-is or SHALL be able to translate it into internal state and SHALL be able to reconstruct the value when requested to retrieve data</b>

                                  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()))
                                  146. 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()))
                                  148. 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)

                                  Reason why the encounter takes place.

                                  TypeCodeableConcept
                                  Is Modifierfalse
                                  Summarytrue
                                  Alternate NamesIndication, Admission diagnosis
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  SlicingThis element introduces a set of slices on Encounter.reasonCode. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • pattern @ $this
                                  • 150. Encounter.reasonCode:moh-reason-code
                                    Slice Namemoh-reason-code
                                    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 Patient Visit Reason MoH
                                    (preferred to http://fhir.health.gov.il/ValueSet/patient-visit-reason-moh)
                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Summarytrue
                                    Alternate NamesIndication, Admission diagnosis
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    152. 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(ILCore Condition Profile, ILCore Procedure Profile, ILCore Observation Profile, ImmunizationRecommendation)
                                    Is Modifierfalse
                                    Summarytrue
                                    Alternate NamesIndication, Admission diagnosis
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    154. 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()))
                                    156. 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
                                    158. 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())
                                    160. 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())
                                    162. 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(ILCore Condition Profile, ILCore Procedure Profile)
                                    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()))
                                    164. 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)

                                    The type of diagnosis this condition represents.

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

                                    Details about the admission to a healthcare service.

                                    ShortDetails about the admission to a healthcare service
                                    Comments

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

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

                                    Control0..1
                                    TypeBackboneElement
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    172. 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
                                    174. 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())
                                    176. 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())
                                    178. 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()))
                                    180. 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(ILCore Location Profile, ILCore Organization Profile)
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    182. 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 Patient Admit Source MoH
                                    (preferred to http://fhir.health.gov.il/ValueSet/patient-admit-source-moh)
                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    184. 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
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    186. 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)

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

                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Summaryfalse
                                    Requirements

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

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

                                    Special courtesies.

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

                                    Special arrangements.

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

                                    Location/organization to which the patient is discharged.

                                    ShortLocation/organization to which the patient is discharged
                                    Control0..1
                                    TypeReference(ILCore Location Profile, ILCore Organization Profile)
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    194. Encounter.hospitalization.dischargeDisposition
                                    Definition

                                    Category or kind of location after discharge.

                                    ShortCategory or kind of location after discharge
                                    Control0..1
                                    BindingFor example codes, see Patient Realease Type MoH
                                    (example to http://fhir.health.gov.il/ValueSet/patient-release-type-moh)
                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    196. Encounter.location
                                    Definition

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

                                    ShortList of locations where the patient has been
                                    Comments

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

                                    Control0..*
                                    TypeBackboneElement
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    198. 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
                                    200. 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())
                                    202. 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())
                                    204. Encounter.location.location
                                    Definition

                                    The location where the encounter takes place.

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

                                    Physical form of the location.

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

                                    Must support - <b>receiving system SHALL either store the value as-is or SHALL be able to translate it into internal state and SHALL be able to reconstruct the value when requested to retrieve data</b>

                                    ShortThe organization (facility) responsible for this encounter
                                    Control0..1
                                    TypeReference(ILCore Organization Profile)
                                    Is Modifierfalse
                                    Must Supporttrue
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    214. 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(ILCore Encounter Profile)
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))