FHIR Cross-Version Extensions package for FHIR R4B from FHIR R5
0.0.1-snapshot-2 - informative International flag

FHIR Cross-Version Extensions package for FHIR R4B from FHIR R5 - Version 0.0.1-snapshot-2. See the Directory of published versions

Extension: Ext_R5_EncounterHistory - Detailed Descriptions

Page standards status: Informative Maturity Level: 0

Definitions for the ext-R5-EncounterHistory extension.

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

0. Extension
Definition

A record of significant events/milestones key data throughout the history of an Encounter, often tracked for specific purposes such as billing.

ShortA record of significant events/milestones key data throughout the history of an Encounter
Control0..*
2. Extension.extension
Control2..*
SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Extension.extension:encounter
    Slice Nameencounter
    Definition

    This cross-version extension represents EncounterHistory.encounter from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

    ShortThe Encounter associated with this set of historic values
    Control0..1
    6. Extension.extension:encounter.url
    Control1..1
    Fixed Valueencounter
    8. Extension.extension:encounter.value[x]
    Definition

    This cross-version extension represents EncounterHistory.encounter from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

    ShortThe Encounter associated with this set of historic values
    TypeReference
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    10. Extension.extension:status
    Slice Namestatus
    Definition

    This cross-version extension represents EncounterHistory.status from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

    Shortplanned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
    Control1..1
    12. Extension.extension:status.url
    Control1..1
    Fixed Valuestatus
    14. Extension.extension:status.value[x]
    Definition

    This cross-version extension represents EncounterHistory.status from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

    Shortplanned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
    BindingThe codes SHALL be taken from R5_encounter_status_for_R4B (0.0.1-snapshot-2)
    (required to http://hl7.org/fhir/5.0/ValueSet/R5-encounter-status-for-R4B|0.0.1-snapshot-2)

    Current state of the encounter.

    Typecode
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. Extension.extension:class
    Slice Nameclass
    Definition

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

    ShortClassification of patient encounter
    Control1..1
    18. Extension.extension:class.url
    Control1..1
    Fixed Valueclass
    20. Extension.extension:class.value[x]
    Definition

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

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

    Classification of the encounter.

    TypeCodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    22. Extension.extension:type
    Slice Nametype
    Definition

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

    ShortSpecific type of encounter
    Control0..*
    24. Extension.extension:type.url
    Control1..1
    Fixed Valuetype
    26. Extension.extension:type.value[x]
    Definition

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

    ShortSpecific type of encounter
    BindingFor example codes, see EncounterType
    (example to http://hl7.org/fhir/ValueSet/encounter-type|4.3.0)

    A specific code indicating type of service provided

    TypeCodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    28. Extension.extension:serviceType
    Slice NameserviceType
    Definition

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

    ShortSpecific type of service
    Control0..*
    30. Extension.extension:serviceType.url
    Control1..1
    Fixed ValueserviceType
    32. Extension.extension:serviceType.value[x]
    Definition

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

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

    Broad categorization of the service that is to be provided.

    TypeCodeableReference
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    34. Extension.extension:subjectStatus
    Slice NamesubjectStatus
    Definition

    The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.

    ShortThe current status of the subject in relation to the Encounter
    Control0..1
    36. Extension.extension:subjectStatus.url
    Control1..1
    Fixed ValuesubjectStatus
    38. Extension.extension:subjectStatus.value[x]
    Definition

    The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.

    ShortThe current status of the subject in relation to the Encounter
    BindingFor example codes, see R5_encounter_subject_status_for_R4B (0.0.1-snapshot-2)
    (example to http://hl7.org/fhir/5.0/ValueSet/R5-encounter-subject-status-for-R4B|0.0.1-snapshot-2)

    Current status of the subject within the encounter.

    TypeCodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    40. Extension.extension:actualPeriod
    Slice NameactualPeriod
    Definition

    The start and end time associated with this set of values associated with the encounter, may be different to the planned times for various reasons.

    ShortThe actual start and end time associated with this set of values associated with the encounter
    Control0..1
    42. Extension.extension:actualPeriod.url
    Control1..1
    Fixed ValueactualPeriod
    44. Extension.extension:actualPeriod.value[x]
    Definition

    The start and end time associated with this set of values associated with the encounter, may be different to the planned times for various reasons.

    ShortThe actual start and end time associated with this set of values associated with the encounter
    TypePeriod
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    46. Extension.extension:plannedStartDate
    Slice NameplannedStartDate
    Definition

    This cross-version extension represents EncounterHistory.plannedStartDate from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

    ShortThe planned start date/time (or admission date) of the encounter
    Control0..1
    48. Extension.extension:plannedStartDate.url
    Control1..1
    Fixed ValueplannedStartDate
    50. Extension.extension:plannedStartDate.value[x]
    Definition

    This cross-version extension represents EncounterHistory.plannedStartDate from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

    ShortThe planned start date/time (or admission date) of the encounter
    TypedateTime
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    52. Extension.extension:plannedEndDate
    Slice NameplannedEndDate
    Definition

    This cross-version extension represents EncounterHistory.plannedEndDate from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

    ShortThe planned end date/time (or discharge date) of the encounter
    Control0..1
    54. Extension.extension:plannedEndDate.url
    Control1..1
    Fixed ValueplannedEndDate
    56. Extension.extension:plannedEndDate.value[x]
    Definition

    This cross-version extension represents EncounterHistory.plannedEndDate from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

    ShortThe planned end date/time (or discharge date) of the encounter
    TypedateTime
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    58. Extension.extension:length
    Slice Namelength
    Definition

    Actual quantity of time the encounter lasted. This excludes the time during leaves of absence.

    When missing it is the time in between the start and end values.

    ShortActual quantity of time the encounter lasted (less time absent)
    Control0..1
    60. Extension.extension:length.url
    Control1..1
    Fixed Valuelength
    62. Extension.extension:length.value[x]
    Definition

    Actual quantity of time the encounter lasted. This excludes the time during leaves of absence.

    When missing it is the time in between the start and end values.

    ShortActual quantity of time the encounter lasted (less time absent)
    TypeDuration
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    64. Extension.extension:location
    Slice Namelocation
    Definition

    The location of the patient at this point in the encounter, the multiple cardinality permits de-normalizing the levels of the location hierarchy, such as site/ward/room/bed.

    ShortLocation of the patient at this point in the encounter
    Control0..*
    66. Extension.extension:location.extension
    Control1..*
    SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
    • value @ url
    • 68. Extension.extension:location.extension:location
      Slice Namelocation
      Definition

      The location where the encounter takes place.

      ShortLocation the encounter takes place
      Control1..1
      70. Extension.extension:location.extension:location.url
      Control1..1
      Fixed Valuelocation
      72. Extension.extension:location.extension:location.value[x]
      Definition

      The location where the encounter takes place.

      ShortLocation the encounter takes place
      TypeReference
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      74. Extension.extension:location.extension:form
      Slice Nameform
      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 hierarchy - bed, room, ward, virtual etc.)
      Control0..1
      76. Extension.extension:location.extension:form.url
      Control1..1
      Fixed Valueform
      78. Extension.extension:location.extension:form.value[x]
      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 hierarchy - bed, room, ward, virtual etc.)
      BindingFor example codes, see R5_location_form_for_R4B (0.0.1-snapshot-2)
      (example to http://hl7.org/fhir/5.0/ValueSet/R5-location-form-for-R4B|0.0.1-snapshot-2)

      Physical form of the location.

      TypeCodeableConcept
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      80. Extension.extension:location.url
      Control1..1
      Fixed Valuelocation
      82. Extension.url
      Control1..1
      Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-EncounterHistory

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

      0. Extension
      Definition

      A record of significant events/milestones key data throughout the history of an Encounter, often tracked for specific purposes such as billing.


      Optional Extension Element - found in all resources.

      ShortA record of significant events/milestones key data throughout the history of an EncounterOptional Extensions Element
      Control0..*
      This element is affected by the following invariants: ele-1
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
      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 unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      2. Extension.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.

      Control20..*
      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 Extension.extension. The slices areUnordered and ClosedOpen, and can be differentiated using the following discriminators:
      • value @ url
      • 4. Extension.extension:encounter
        Slice Nameencounter
        Definition

        This cross-version extension represents EncounterHistory.encounter from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

        ShortThe Encounter associated with this set of historic valuesAdditional content defined by implementations
        Control0..1*
        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())
        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())
        6. Extension.extension:encounter.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 Valueencounter
        8. Extension.extension:encounter.value[x]
        Definition

        This cross-version extension represents EncounterHistory.encounter from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.


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

        ShortThe Encounter associated with this set of historic valuesValue of extension
        Control0..1
        TypeReference, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, 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, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, 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()))
        10. Extension.extension:status
        Slice Namestatus
        Definition

        This cross-version extension represents EncounterHistory.status from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

        Shortplanned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknownAdditional content defined by implementations
        Control10..1*
        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())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        12. Extension.extension:status.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 Valuestatus
        14. Extension.extension:status.value[x]
        Definition

        This cross-version extension represents EncounterHistory.status from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.


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

        Shortplanned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknownValue of extension
        Control0..1
        BindingThe codes SHALL be taken from For codes, see R5_encounter_status_for_R4B (0.0.1-snapshot-2)
        (required to http://hl7.org/fhir/5.0/ValueSet/R5-encounter-status-for-R4B|0.0.1-snapshot-2)

        Current state of the encounter.

        Typecode, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        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()))
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        16. Extension.extension:class
        Slice Nameclass
        Definition

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

        ShortClassification of patient encounterAdditional content defined by implementations
        Control10..1*
        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())
        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())
        18. Extension.extension:class.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 Valueclass
        20. Extension.extension:class.value[x]
        Definition

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


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

        ShortClassification of patient encounterValue of extension
        Control0..1
        BindingUnless not suitable, these codes SHALL be taken from For codes, see http://terminology.hl7.org/ValueSet/v3-ActEncounterCode|2.0.0
        (extensible to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode|2.0.0)

        Classification of the encounter.

        TypeCodeableConcept, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, 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()))
        22. Extension.extension:type
        Slice Nametype
        Definition

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

        ShortSpecific type of encounterAdditional content defined by implementations
        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())
        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())
        24. Extension.extension:type.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 Valuetype
        26. Extension.extension:type.value[x]
        Definition

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


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

        ShortSpecific type of encounterValue of extension
        Control0..1
        BindingFor example codes, see For codes, see EncounterType
        (example to http://hl7.org/fhir/ValueSet/encounter-type|4.3.0)

        A specific code indicating type of service provided

        TypeCodeableConcept, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, 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()))
        28. Extension.extension:serviceType
        Slice NameserviceType
        Definition

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

        ShortSpecific type of serviceAdditional content defined by implementations
        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())
        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())
        30. Extension.extension:serviceType.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 ValueserviceType
        32. Extension.extension:serviceType.value[x]
        Definition

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


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

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

        Broad categorization of the service that is to be provided.

        TypeCodeableReference, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, 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()))
        34. Extension.extension:subjectStatus
        Slice NamesubjectStatus
        Definition

        The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.

        ShortThe current status of the subject in relation to the EncounterAdditional content defined by implementations
        Control0..1*
        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())
        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())
        36. Extension.extension:subjectStatus.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 ValuesubjectStatus
        38. Extension.extension:subjectStatus.value[x]
        Definition

        The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.


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

        ShortThe current status of the subject in relation to the EncounterValue of extension
        Control0..1
        BindingFor example codes, see For codes, see R5_encounter_subject_status_for_R4B (0.0.1-snapshot-2)
        (example to http://hl7.org/fhir/5.0/ValueSet/R5-encounter-subject-status-for-R4B|0.0.1-snapshot-2)

        Current status of the subject within the encounter.

        TypeCodeableConcept, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, 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()))
        40. Extension.extension:actualPeriod
        Slice NameactualPeriod
        Definition

        The start and end time associated with this set of values associated with the encounter, may be different to the planned times for various reasons.

        ShortThe actual start and end time associated with this set of values associated with the encounterAdditional content defined by implementations
        Control0..1*
        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())
        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())
        42. Extension.extension:actualPeriod.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 ValueactualPeriod
        44. Extension.extension:actualPeriod.value[x]
        Definition

        The start and end time associated with this set of values associated with the encounter, may be different to the planned times for various reasons.


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

        ShortThe actual start and end time associated with this set of values associated with the encounterValue of extension
        Control0..1
        TypePeriod, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, 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, CodeableReference, 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()))
        46. Extension.extension:plannedStartDate
        Slice NameplannedStartDate
        Definition

        This cross-version extension represents EncounterHistory.plannedStartDate from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

        ShortThe planned start date/time (or admission date) of the encounterAdditional content defined by implementations
        Control0..1*
        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())
        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())
        48. Extension.extension:plannedStartDate.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 ValueplannedStartDate
        50. Extension.extension:plannedStartDate.value[x]
        Definition

        This cross-version extension represents EncounterHistory.plannedStartDate from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.


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

        ShortThe planned start date/time (or admission date) of the encounterValue of extension
        Control0..1
        TypedateTime, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        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()))
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        52. Extension.extension:plannedEndDate
        Slice NameplannedEndDate
        Definition

        This cross-version extension represents EncounterHistory.plannedEndDate from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

        ShortThe planned end date/time (or discharge date) of the encounterAdditional content defined by implementations
        Control0..1*
        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())
        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())
        54. Extension.extension:plannedEndDate.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 ValueplannedEndDate
        56. Extension.extension:plannedEndDate.value[x]
        Definition

        This cross-version extension represents EncounterHistory.plannedEndDate from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.


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

        ShortThe planned end date/time (or discharge date) of the encounterValue of extension
        Control0..1
        TypedateTime, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        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()))
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        58. Extension.extension:length
        Slice Namelength
        Definition

        Actual quantity of time the encounter lasted. This excludes the time during leaves of absence.

        When missing it is the time in between the start and end values.

        ShortActual quantity of time the encounter lasted (less time absent)Additional content defined by implementations
        Control0..1*
        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())
        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())
        60. Extension.extension:length.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 Valuelength
        62. Extension.extension:length.value[x]
        Definition

        Actual quantity of time the encounter lasted. This excludes the time during leaves of absence.

        When missing it is the time in between the start and end values.


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

        ShortActual quantity of time the encounter lasted (less time absent)Value of extension
        Control0..1
        TypeDuration, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, 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, CodeableReference, 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()))
        64. Extension.extension:location
        Slice Namelocation
        Definition

        The location of the patient at this point in the encounter, the multiple cardinality permits de-normalizing the levels of the location hierarchy, such as site/ward/room/bed.

        ShortLocation of the patient at this point in the encounterAdditional content defined by implementations
        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())
        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())
        66. Extension.extension:location.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.

        Control10..*
        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 Extension.extension.extension. The slices areUnordered and ClosedOpen, and can be differentiated using the following discriminators:
        • value @ url
        • 68. Extension.extension:location.extension:location
          Slice Namelocation
          Definition

          The location where the encounter takes place.

          ShortLocation the encounter takes placeAdditional content defined by implementations
          Control10..1*
          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())
          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())
          70. Extension.extension:location.extension:location.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 Valuelocation
          72. Extension.extension:location.extension:location.value[x]
          Definition

          The location where the encounter takes place.


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

          ShortLocation the encounter takes placeValue of extension
          Control0..1
          TypeReference, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, 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, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, 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()))
          74. Extension.extension:location.extension:form
          Slice Nameform
          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 hierarchy - bed, room, ward, virtual etc.)Additional content defined by implementations
          Control0..1*
          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())
          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())
          76. Extension.extension:location.extension:form.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 Valueform
          78. Extension.extension:location.extension:form.value[x]
          Definition

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


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

          ShortThe physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.)Value of extension
          Control0..1
          BindingFor example codes, see For codes, see R5_location_form_for_R4B (0.0.1-snapshot-2)
          (example to http://hl7.org/fhir/5.0/ValueSet/R5-location-form-for-R4B|0.0.1-snapshot-2)

          Physical form of the location.

          TypeCodeableConcept, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, 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()))
          80. Extension.extension:location.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 Valuelocation
          82. Extension.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/5.0/StructureDefinition/extension-EncounterHistory

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

          0. Extension
          Definition

          A record of significant events/milestones key data throughout the history of an Encounter, often tracked for specific purposes such as billing.

          ShortA record of significant events/milestones key data throughout the history of an Encounter
          Control0..*
          This element is affected by the following invariants: ele-1
          Is Modifierfalse
          Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          2. Extension.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
          Typeid
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          4. Extension.extension
          Definition

          An Extension

          ShortExtension
          Control2..*
          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 Extension.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
          • value @ url
          • 6. Extension.extension:encounter
            Slice Nameencounter
            Definition

            This cross-version extension represents EncounterHistory.encounter from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

            ShortThe Encounter associated with this set of historic values
            Control0..1
            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())
            8. Extension.extension:encounter.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
            Typeid
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            10. Extension.extension:encounter.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 12. Extension.extension:encounter.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 Valueencounter
              14. Extension.extension:encounter.value[x]
              Definition

              This cross-version extension represents EncounterHistory.encounter from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

              ShortThe Encounter associated with this set of historic values
              Control0..1
              TypeReference
              [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()))
              16. Extension.extension:status
              Slice Namestatus
              Definition

              This cross-version extension represents EncounterHistory.status from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

              Shortplanned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
              Control1..1
              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())
              18. Extension.extension:status.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
              Typeid
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              20. Extension.extension:status.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 22. Extension.extension:status.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 Valuestatus
                24. Extension.extension:status.value[x]
                Definition

                This cross-version extension represents EncounterHistory.status from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

                Shortplanned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
                Control0..1
                BindingThe codes SHALL be taken from R5_encounter_status_for_R4B (0.0.1-snapshot-2)
                (required to http://hl7.org/fhir/5.0/ValueSet/R5-encounter-status-for-R4B|0.0.1-snapshot-2)

                Current state of the encounter.

                Typecode
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                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()))
                26. Extension.extension:class
                Slice Nameclass
                Definition

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

                ShortClassification of patient encounter
                Control1..1
                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())
                28. Extension.extension:class.id
                Definition

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

                ShortUnique id for inter-element referencing
                Control0..1
                Typeid
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                30. Extension.extension:class.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 32. Extension.extension:class.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 Valueclass
                  34. Extension.extension:class.value[x]
                  Definition

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

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

                  Classification of the encounter.

                  TypeCodeableConcept
                  [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()))
                  36. Extension.extension:type
                  Slice Nametype
                  Definition

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

                  ShortSpecific type of encounter
                  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())
                  38. Extension.extension: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
                  Typeid
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  40. Extension.extension: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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 42. Extension.extension:type.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 Valuetype
                    44. Extension.extension:type.value[x]
                    Definition

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

                    ShortSpecific type of encounter
                    Control0..1
                    BindingFor example codes, see EncounterType
                    (example to http://hl7.org/fhir/ValueSet/encounter-type|4.3.0)

                    A specific code indicating type of service provided

                    TypeCodeableConcept
                    [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()))
                    46. Extension.extension:serviceType
                    Slice NameserviceType
                    Definition

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

                    ShortSpecific type of service
                    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())
                    48. Extension.extension:serviceType.id
                    Definition

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

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typeid
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    50. Extension.extension:serviceType.extension
                    Definition

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

                    ShortAdditional content defined by implementations
                    Comments

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

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

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

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

                      Broad categorization of the service that is to be provided.

                      TypeCodeableReference
                      [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()))
                      56. Extension.extension:subjectStatus
                      Slice NamesubjectStatus
                      Definition

                      The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.

                      ShortThe current status of the subject in relation to the Encounter
                      Control0..1
                      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())
                      58. Extension.extension:subjectStatus.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
                      Typeid
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      60. Extension.extension:subjectStatus.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 62. Extension.extension:subjectStatus.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 ValuesubjectStatus
                        64. Extension.extension:subjectStatus.value[x]
                        Definition

                        The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.

                        ShortThe current status of the subject in relation to the Encounter
                        Control0..1
                        BindingFor example codes, see R5_encounter_subject_status_for_R4B (0.0.1-snapshot-2)
                        (example to http://hl7.org/fhir/5.0/ValueSet/R5-encounter-subject-status-for-R4B|0.0.1-snapshot-2)

                        Current status of the subject within the encounter.

                        TypeCodeableConcept
                        [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()))
                        66. Extension.extension:actualPeriod
                        Slice NameactualPeriod
                        Definition

                        The start and end time associated with this set of values associated with the encounter, may be different to the planned times for various reasons.

                        ShortThe actual start and end time associated with this set of values associated with the encounter
                        Control0..1
                        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())
                        68. Extension.extension:actualPeriod.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
                        Typeid
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        70. Extension.extension:actualPeriod.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 72. Extension.extension:actualPeriod.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 ValueactualPeriod
                          74. Extension.extension:actualPeriod.value[x]
                          Definition

                          The start and end time associated with this set of values associated with the encounter, may be different to the planned times for various reasons.

                          ShortThe actual start and end time associated with this set of values associated with the encounter
                          Control0..1
                          TypePeriod
                          [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()))
                          76. Extension.extension:plannedStartDate
                          Slice NameplannedStartDate
                          Definition

                          This cross-version extension represents EncounterHistory.plannedStartDate from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

                          ShortThe planned start date/time (or admission date) of the encounter
                          Control0..1
                          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())
                          78. Extension.extension:plannedStartDate.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
                          Typeid
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          80. Extension.extension:plannedStartDate.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 82. Extension.extension:plannedStartDate.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 ValueplannedStartDate
                            84. Extension.extension:plannedStartDate.value[x]
                            Definition

                            This cross-version extension represents EncounterHistory.plannedStartDate from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

                            ShortThe planned start date/time (or admission date) of the encounter
                            Control0..1
                            TypedateTime
                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                            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()))
                            86. Extension.extension:plannedEndDate
                            Slice NameplannedEndDate
                            Definition

                            This cross-version extension represents EncounterHistory.plannedEndDate from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

                            ShortThe planned end date/time (or discharge date) of the encounter
                            Control0..1
                            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())
                            88. Extension.extension:plannedEndDate.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
                            Typeid
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            90. Extension.extension:plannedEndDate.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 92. Extension.extension:plannedEndDate.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 ValueplannedEndDate
                              94. Extension.extension:plannedEndDate.value[x]
                              Definition

                              This cross-version extension represents EncounterHistory.plannedEndDate from http://hl7.org/fhir/StructureDefinition/EncounterHistory|5.0.0 for use in FHIR R4B.

                              ShortThe planned end date/time (or discharge date) of the encounter
                              Control0..1
                              TypedateTime
                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                              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()))
                              96. Extension.extension:length
                              Slice Namelength
                              Definition

                              Actual quantity of time the encounter lasted. This excludes the time during leaves of absence.

                              When missing it is the time in between the start and end values.

                              ShortActual quantity of time the encounter lasted (less time absent)
                              Control0..1
                              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())
                              98. Extension.extension:length.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
                              Typeid
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              100. Extension.extension:length.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 102. Extension.extension:length.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 Valuelength
                                104. Extension.extension:length.value[x]
                                Definition

                                Actual quantity of time the encounter lasted. This excludes the time during leaves of absence.

                                When missing it is the time in between the start and end values.

                                ShortActual quantity of time the encounter lasted (less time absent)
                                Control0..1
                                TypeDuration
                                [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()))
                                106. Extension.extension:location
                                Slice Namelocation
                                Definition

                                The location of the patient at this point in the encounter, the multiple cardinality permits de-normalizing the levels of the location hierarchy, such as site/ward/room/bed.

                                ShortLocation of the patient at this point in the encounter
                                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())
                                108. Extension.extension: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
                                Typeid
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                110. Extension.extension:location.extension
                                Definition

                                An Extension

                                ShortExtension
                                Control1..*
                                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 Extension.extension.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                • value @ url
                                • 112. Extension.extension:location.extension:location
                                  Slice Namelocation
                                  Definition

                                  The location where the encounter takes place.

                                  ShortLocation the encounter takes place
                                  Control1..1
                                  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())
                                  114. Extension.extension:location.extension: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
                                  Typeid
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  116. Extension.extension:location.extension: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())
                                  SlicingThis element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 118. Extension.extension:location.extension:location.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 Valuelocation
                                    120. Extension.extension:location.extension:location.value[x]
                                    Definition

                                    The location where the encounter takes place.

                                    ShortLocation the encounter takes place
                                    Control0..1
                                    TypeReference
                                    [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()))
                                    122. Extension.extension:location.extension:form
                                    Slice Nameform
                                    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 hierarchy - bed, room, ward, virtual etc.)
                                    Control0..1
                                    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())
                                    124. Extension.extension:location.extension:form.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
                                    Typeid
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    126. Extension.extension:location.extension:form.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 Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 128. Extension.extension:location.extension:form.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 Valueform
                                      130. Extension.extension:location.extension:form.value[x]
                                      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 hierarchy - bed, room, ward, virtual etc.)
                                      Control0..1
                                      BindingFor example codes, see R5_location_form_for_R4B (0.0.1-snapshot-2)
                                      (example to http://hl7.org/fhir/5.0/ValueSet/R5-location-form-for-R4B|0.0.1-snapshot-2)

                                      Physical form of the location.

                                      TypeCodeableConcept
                                      [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()))
                                      132. Extension.extension:location.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 Valuelocation
                                      134. Extension.extension:location.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
                                      Control0..1
                                      TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                      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()))
                                      136. Extension.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/5.0/StructureDefinition/extension-EncounterHistory
                                      138. Extension.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
                                      Control0..1
                                      TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                      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()))