Administrative Incubator
0.1.0 - STU 1 World

Administrative Incubator, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/admin-incubator/ and changes regularly. See the Directory of published versions

Resource: EncounterHistory - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the EncounterHistory resource

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

0. EncounterHistory
Definition

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


A resource that includes narrative, extensions, and contained resources.

ShortA record of significant events/milestones key data throughout the history of an EncounterA resource with narrative, extensions, and contained resources
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. EncounterHistory.id
Definition

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

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resource id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. EncounterHistory.meta
Definition

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

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

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the additionalImplicitRules extension.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

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

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

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

Control0..1
BindingThe codes SHALL be taken from AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot5
(required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot5)

IETF language tag for a human language

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

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

ShortText summary of the resource, for human interpretation
Comments

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

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. EncounterHistory.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. EncounterHistory.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, 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
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on EncounterHistory.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 16. EncounterHistory.modifierExtension
    Definition

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

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

    ShortExtensions that cannot be ignored
    Comments

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

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Must Supportfalse
    Summarytrue
    Requirements

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

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on EncounterHistory.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 18. EncounterHistory.encounter
      Definition

      The Encounter associated with this set of historic values.

      ShortThe Encounter associated with this set of historic values
      Comments

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

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

      Control0..1
      TypeReference(Encounter)
      20. EncounterHistory.identifier
      Definition

      Identifier(s) by which this encounter is known.

      ShortIdentifier(s) by which this encounter is known
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      TypeIdentifier
      Summarytrue
      22. EncounterHistory.status
      Shortplanned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
      Comments

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

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

      Current state of the encounter.

      Typecode
      Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      24. EncounterHistory.class
      Definition

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

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

      Classification of the encounter.

      TypeCodeableConcept
      Summarytrue
      26. EncounterHistory.type
      Definition

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

      ShortSpecific type of encounter
      Comments

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

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

      A specific code indicating type of service provided

      TypeCodeableConcept
      Summarytrue
      28. EncounterHistory.serviceType
      Definition

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

      ShortSpecific type of service
      Control0..*
      BindingFor example codes, see ServiceTypehttp://hl7.org/fhir/ValueSet/service-type
      (example to http://hl7.org/fhir/ValueSet/service-type)

      Broad categorization of the service that is to be provided.

      TypeCodeableReference(HealthcareService)
      Summarytrue
      30. EncounterHistory.subject
      Definition

      The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.

      ShortThe patient or group related to this encounter
      Comments

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

      Control0..1
      TypeReference(Patient, Group)
      Summarytrue
      Alternate Namespatient
      32. EncounterHistory.subjectStatus
      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 EncounterSubjectStatushttp://hl7.org/fhir/ValueSet/encounter-subject-status
      (example to http://hl7.org/fhir/ValueSet/encounter-subject-status)

      Current status of the subject within the encounter.

      TypeCodeableConcept
      34. EncounterHistory.actualPeriod
      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
      36. EncounterHistory.plannedStartDate
      Definition

      The planned start date/time (or admission date) of the encounter.

      ShortThe planned start date/time (or admission date) of the encounter
      Control0..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      38. EncounterHistory.plannedEndDate
      Definition

      The planned end date/time (or discharge date) of the encounter.

      ShortThe planned end date/time (or discharge date) of the encounter
      Control0..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      40. EncounterHistory.length
      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)
      Comments

      If the precision on these values is low (e.g. to the day only) then this may be considered was an all day (or multi-day) encounter, unless the duration is included, where that amount of time occurred sometime during the interval.

      May differ from the time in Encounter.period due to leave of absence(s).

      Control0..1
      TypeDuration
      42. EncounterHistory.location
      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
      Comments

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

      Control0..*
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
      44. EncounterHistory.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
      This element is affected by the following invariants: ele-1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      46. EncounterHistory.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 managable, 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()))
      SlicingThis element introduces a set of slices on EncounterHistory.location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 48. EncounterHistory.location.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

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

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

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

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on EncounterHistory.location.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 50. EncounterHistory.location.location
          Definition

          The location where the encounter takes place.

          ShortLocation the encounter takes place
          Control1..1
          TypeReference(Location)
          52. EncounterHistory.location.form
          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.)
          Comments

          This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query.

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

          Control0..1
          BindingFor example codes, see LocationFormhttp://hl7.org/fhir/ValueSet/location-form
          (example to http://hl7.org/fhir/ValueSet/location-form)

          Physical form of the location.

          TypeCodeableConcept

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

          0. EncounterHistory
          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. EncounterHistory.encounter
          Definition

          The Encounter associated with this set of historic values.

          ShortThe Encounter associated with this set of historic values
          Comments

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

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

          Control0..1
          TypeReference(Encounter)
          4. EncounterHistory.identifier
          Definition

          Identifier(s) by which this encounter is known.

          ShortIdentifier(s) by which this encounter is known
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..*
          TypeIdentifier
          6. EncounterHistory.status
          Shortplanned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
          Comments

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

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

          Current state of the encounter.

          Typecode
          Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          8. EncounterHistory.class
          Definition

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

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

          Classification of the encounter.

          TypeCodeableConcept
          10. EncounterHistory.type
          Definition

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

          ShortSpecific type of encounter
          Comments

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

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

          A specific code indicating type of service provided

          TypeCodeableConcept
          12. EncounterHistory.serviceType
          Definition

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

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

          Broad categorization of the service that is to be provided.

          TypeCodeableReference(HealthcareService)
          14. EncounterHistory.subject
          Definition

          The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.

          ShortThe patient or group related to this encounter
          Comments

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

          Control0..1
          TypeReference(Patient, Group)
          Alternate Namespatient
          16. EncounterHistory.subjectStatus
          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 EncounterSubjectStatus
          (example to http://hl7.org/fhir/ValueSet/encounter-subject-status)

          Current status of the subject within the encounter.

          TypeCodeableConcept
          18. EncounterHistory.actualPeriod
          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
          20. EncounterHistory.plannedStartDate
          Definition

          The planned start date/time (or admission date) of the encounter.

          ShortThe planned start date/time (or admission date) of the encounter
          Control0..1
          TypedateTime
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          22. EncounterHistory.plannedEndDate
          Definition

          The planned end date/time (or discharge date) of the encounter.

          ShortThe planned end date/time (or discharge date) of the encounter
          Control0..1
          TypedateTime
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          24. EncounterHistory.length
          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)
          Comments

          If the precision on these values is low (e.g. to the day only) then this may be considered was an all day (or multi-day) encounter, unless the duration is included, where that amount of time occurred sometime during the interval.

          May differ from the time in Encounter.period due to leave of absence(s).

          Control0..1
          TypeDuration
          26. EncounterHistory.location
          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
          Comments

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

          Control0..*
          TypeBackboneElement
          28. EncounterHistory.location.location
          Definition

          The location where the encounter takes place.

          ShortLocation the encounter takes place
          Control1..1
          TypeReference(Location)
          30. EncounterHistory.location.form
          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.)
          Comments

          This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query.

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

          Control0..1
          BindingFor example codes, see LocationForm
          (example to http://hl7.org/fhir/ValueSet/location-form)

          Physical form of the location.

          TypeCodeableConcept

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

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

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

          ShortLogical id of this artifact
          Comments

          Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resource id depends on the given use case.

          Control0..1
          Typeid
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          4. EncounterHistory.meta
          Definition

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

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

          A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the additionalImplicitRules extension.

          ShortA set of rules under which this content was created
          Comments

          Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

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

          The base language in which the resource is written.

          ShortLanguage of the resource content
          Comments

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

          Control0..1
          BindingThe codes SHALL be taken from AllLanguages
          (required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot5)

          IETF language tag for a human language

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

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

          ShortText summary of the resource, for human interpretation
          Comments

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

          Control0..1
          This element is affected by the following invariants: dom-6
          TypeNarrative
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate Namesnarrative, html, xhtml, display
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          12. EncounterHistory.contained
          Definition

          These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

          ShortContained, inline Resources
          Comments

          This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

          Control0..*
          This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
          TypeResource
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate Namesinline resources, anonymous resources, contained resources
          14. EncounterHistory.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, 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
          Must Supportfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          SlicingThis element introduces a set of slices on EncounterHistory.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 16. EncounterHistory.modifierExtension
            Definition

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

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

            ShortExtensions that cannot be ignored
            Comments

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

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
            Must Supportfalse
            Summarytrue
            Requirements

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

            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on EncounterHistory.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 18. EncounterHistory.encounter
              Definition

              The Encounter associated with this set of historic values.

              ShortThe Encounter associated with this set of historic values
              Comments

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

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

              Control0..1
              TypeReference(Encounter)
              20. EncounterHistory.identifier
              Definition

              Identifier(s) by which this encounter is known.

              ShortIdentifier(s) by which this encounter is known
              NoteThis is a business identifier, not a resource identifier (see discussion)
              Control0..*
              TypeIdentifier
              Summarytrue
              22. EncounterHistory.status
              Shortplanned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown
              Comments

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

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

              Current state of the encounter.

              Typecode
              Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              24. EncounterHistory.class
              Definition

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

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

              Classification of the encounter.

              TypeCodeableConcept
              Summarytrue
              26. EncounterHistory.type
              Definition

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

              ShortSpecific type of encounter
              Comments

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

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

              A specific code indicating type of service provided

              TypeCodeableConcept
              Summarytrue
              28. EncounterHistory.serviceType
              Definition

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

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

              Broad categorization of the service that is to be provided.

              TypeCodeableReference(HealthcareService)
              Summarytrue
              30. EncounterHistory.subject
              Definition

              The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.

              ShortThe patient or group related to this encounter
              Comments

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

              Control0..1
              TypeReference(Patient, Group)
              Summarytrue
              Alternate Namespatient
              32. EncounterHistory.subjectStatus
              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 EncounterSubjectStatus
              (example to http://hl7.org/fhir/ValueSet/encounter-subject-status)

              Current status of the subject within the encounter.

              TypeCodeableConcept
              34. EncounterHistory.actualPeriod
              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
              36. EncounterHistory.plannedStartDate
              Definition

              The planned start date/time (or admission date) of the encounter.

              ShortThe planned start date/time (or admission date) of the encounter
              Control0..1
              TypedateTime
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              38. EncounterHistory.plannedEndDate
              Definition

              The planned end date/time (or discharge date) of the encounter.

              ShortThe planned end date/time (or discharge date) of the encounter
              Control0..1
              TypedateTime
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              40. EncounterHistory.length
              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)
              Comments

              If the precision on these values is low (e.g. to the day only) then this may be considered was an all day (or multi-day) encounter, unless the duration is included, where that amount of time occurred sometime during the interval.

              May differ from the time in Encounter.period due to leave of absence(s).

              Control0..1
              TypeDuration
              42. EncounterHistory.location
              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
              Comments

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

              Control0..*
              TypeBackboneElement
              Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
              44. EncounterHistory.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
              This element is affected by the following invariants: ele-1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              46. EncounterHistory.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 managable, 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()))
              SlicingThis element introduces a set of slices on EncounterHistory.location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 48. EncounterHistory.location.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                ShortExtensions that cannot be ignored even if unrecognized
                Comments

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

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                Summarytrue
                Requirements

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

                Alternate Namesextensions, user content, modifiers
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                SlicingThis element introduces a set of slices on EncounterHistory.location.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 50. EncounterHistory.location.location
                  Definition

                  The location where the encounter takes place.

                  ShortLocation the encounter takes place
                  Control1..1
                  TypeReference(Location)
                  52. EncounterHistory.location.form
                  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.)
                  Comments

                  This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query.

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

                  Control0..1
                  BindingFor example codes, see LocationForm
                  (example to http://hl7.org/fhir/ValueSet/location-form)

                  Physical form of the location.

                  TypeCodeableConcept