CH ORF (R4)
2.0.0-ballot - ballot Switzerland flag

This page is part of the CH ORF (R4) (v2.0.0-ballot: STU 2 Ballot 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: ChOrfRequestedEncounter - Detailed Descriptions

Active as of 2023-06-29

Definitions for the ch-orf-encounter resource profile.

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

1. Encounter
2. Encounter.extension
SlicingThis element introduces a set of slices on Encounter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3. Encounter.extension:desiredAccomodation
SliceNamedesiredAccomodation
Control0..1
TypeExtension(ChOrfDesiredAccommodation) (Extension Type: Coding)
Must Supporttrue
4. Encounter.status
Must Supporttrue
5. Encounter.class
BindingThe codes SHALL be taken from Encounter ClassThe codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable
Must Supporttrue
6. Encounter.subject
Must Supporttrue

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

1. Encounter
Definition

This is basic constraint on Encounter for use in CH Core resources.

An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

Control0..*
Summaryfalse
Alternate NamesVisit
InvariantsDefined on this element
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (: text.`div`.exists())
2. Encounter.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. Encounter.extension
Definition

An Extension

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

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Encounter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Encounter.extension:desiredAccomodation
SliceNamedesiredAccomodation
Definition

Desired Accommodation during the Requested Encounter.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ChOrfDesiredAccommodation) (Extension Type: Coding)
Must Supporttrue
InvariantsDefined on this element
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())
5. Encounter.modifierExtension
Definition

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

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

Control0..*
TypeExtension
Is Modifiertrue
Summaryfalse
Requirements

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

Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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. Encounter.identifier
Definition

Identifier(s) by which this encounter is known.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Encounter.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ $this
7. Encounter.identifier:VisitNumber
SliceNameVisitNumber
Definition

Identifier(s) by which this encounter is known.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
Pattern Value<valueIdentifier xmlns="http://hl7.org/fhir">
  <type>
    <coding>
      <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
      <code value="VN"/>
    </coding>
  </type>
</valueIdentifier>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. Encounter.identifier:VisitNumber.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Encounter.identifier:VisitNumber.system
Definition

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

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

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

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. Encounter.identifier:VisitNumber.value
Definition

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

Control10..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

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

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Encounter.status
Definition

planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

Control1..1
BindingThe codes SHALL be taken from EncounterStatus

Current state of the encounter.

Typecode
Is Modifiertrue
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Encounter.class
Definition

See mapping from BFS Medizinische Statistik BFS Encounter Class to FHIR mapping

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

Control1..1
BindingThe codes SHALL be taken from Encounter ClassThe codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable
TypeCoding
Must Supporttrue
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Encounter.subject
Definition

The patient or group present at the encounter.

Control10..1
TypeReference(CHCorePatient|Patient|Group)
Must Supporttrue
Summarytrue
Alternate Namespatient
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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

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

1. Encounter
Definition

This is basic constraint on Encounter for use in CH Core resources.

Control0..*
Summaryfalse
Alternate NamesVisit
2. Encounter.id
Definition

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

Control0..1
Typeid
Summarytrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. Encounter.meta
Definition

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

Control0..1
TypeMeta
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. Encounter.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Encounter.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages A human language
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Encounter.text
Definition

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

Control0..1
TypeNarrative
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Encounter.contained
Definition

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

Control0..*
TypeResource
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained 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.

8. Encounter.extension
Definition

An Extension

Control0..*
TypeExtension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Encounter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. Encounter.extension:desiredAccomodation
SliceNamedesiredAccomodation
Definition

Desired Accommodation during the Requested Encounter.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ChOrfDesiredAccommodation) (Extension Type: Coding)
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Encounter.modifierExtension
Definition

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

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

Control0..*
TypeExtension
Is Modifiertrue
Summaryfalse
Requirements

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

Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
11. Encounter.identifier
Definition

Identifier(s) by which this encounter is known.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Encounter.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ $this
12. Encounter.identifier:VisitNumber
SliceNameVisitNumber
Definition

Identifier(s) by which this encounter is known.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
Pattern Value<valueIdentifier xmlns="http://hl7.org/fhir">
  <type>
    <coding>
      <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
      <code value="VN"/>
    </coding>
  </type>
</valueIdentifier>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Encounter.identifier:VisitNumber.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
14. Encounter.identifier:VisitNumber.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.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Encounter.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
15. Encounter.identifier:VisitNumber.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Encounter.identifier:VisitNumber.type
Definition

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

Control0..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Summarytrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Encounter.identifier:VisitNumber.system
Definition

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

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

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

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. Encounter.identifier:VisitNumber.value
Definition

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

Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

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

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Encounter.identifier:VisitNumber.period
Definition

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

Control0..1
TypePeriod
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. Encounter.identifier:VisitNumber.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Summarytrue
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. Encounter.status
Definition

planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

Control1..1
BindingThe codes SHALL be taken from EncounterStatus Current state of the encounter
Typecode
Is Modifiertrue
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Encounter.statusHistory
Definition

The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.

Control0..*
TypeBackboneElement
Obligations
Obligations
??
Summaryfalse
Comments

The current status is always found in the current version of the resource, not the status history.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Encounter.statusHistory.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
24. Encounter.statusHistory.extension
Definition

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

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
25. Encounter.statusHistory.modifierExtension
Definition

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

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

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
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())
26. Encounter.statusHistory.status
Definition

planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

Control1..1
BindingThe codes SHALL be taken from EncounterStatus Current state of the encounter
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Encounter.statusHistory.period
Definition

The time that the episode was in the specified status.

Control1..1
TypePeriod
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Encounter.class
Definition

See mapping from BFS Medizinische Statistik BFS Encounter Class to FHIR mapping

Control1..1
BindingThe codes SHALL be taken from Encounter Class
TypeCoding
Must Supporttrue
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Encounter.classHistory
Definition

The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.

Control0..*
TypeBackboneElement
Obligations
Obligations
??
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. Encounter.classHistory.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
31. Encounter.classHistory.extension
Definition

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

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
32. Encounter.classHistory.modifierExtension
Definition

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

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

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
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())
33. Encounter.classHistory.class
Definition

inpatient | outpatient | ambulatory | emergency +.

Control1..1
BindingThe codes SHALL be taken from ActEncounterCode; other codes may be used where these codes are not suitable Classification of the encounter
TypeCoding
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. Encounter.classHistory.period
Definition

The time that the episode was in the specified class.

Control1..1
TypePeriod
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Encounter.type
Definition

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

Control0..*
BindingFor example codes, see EncounterType The type of encounter
TypeCodeableConcept
Summarytrue
Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Encounter.serviceType
Definition

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

Control0..1
BindingFor example codes, see ServiceType Broad categorization of the service that is to be provided
TypeCodeableConcept
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. Encounter.priority
Definition

Indicates the urgency of the encounter.

Control0..1
BindingThe codes SHALL be taken from BFS Medizinische Statistik - 18 1.2.V03 - Eintrittsart / Mode d’admission / Genere di ricovero; other codes may be used where these codes are not suitable
TypeCodeableConcept
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. Encounter.subject
Definition

The patient or group present at the encounter.

Control1..1
TypeReference(CHCorePatient)
Must Supporttrue
Summarytrue
Alternate Namespatient
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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. Encounter.episodeOfCare
Definition

Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).

Control0..*
TypeReference(EpisodeOfCare)
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. Encounter.basedOn
Definition

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

Control0..*
TypeReference(ServiceRequest)
Summaryfalse
Alternate NamesincomingReferral
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. Encounter.participant
Definition

The list of people responsible for providing the service.

Control0..*
TypeBackboneElement
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. Encounter.participant.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
43. Encounter.participant.extension
Definition

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

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
44. Encounter.participant.modifierExtension
Definition

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

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

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
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())
45. Encounter.participant.type
Definition

Role of participant in encounter.

Control0..*
BindingThe codes SHALL be taken from ChCoreEncounterParticipationType; other codes may be used where these codes are not suitable
TypeCodeableConcept
Summarytrue
Comments

The participant type indicates how an individual participates in an encounter. It includes non-practitioner participants, and for practitioners this is to describe the action type in the context of this encounter (e.g. Admitting Dr, Attending Dr, Translator, Consulting Dr). This is different to the practitioner roles which are functional roles, derived from terms of employment, education, licensing, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. Encounter.participant.period
Definition

The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.

Control0..1
TypePeriod
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. Encounter.participant.individual
Definition

Persons involved in the encounter other than the patient.

Control0..1
TypeReference(CHCorePractitioner)
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. Encounter.appointment
Definition

The appointment that scheduled this encounter.

Control0..*
TypeReference(Appointment)
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. Encounter.period
Definition

The start and end time of the encounter.

Control0..1
TypePeriod
Summaryfalse
Comments

If not (yet) known, the end of the Period may be omitted.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. Encounter.length
Definition

Quantity of time the encounter lasted. This excludes the time during leaves of absence.

Control0..1
TypeDuration
Summaryfalse
Comments

May differ from the time the Encounter.period lasted because of leave of absence.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. Encounter.reasonCode
Definition

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

Control0..*
BindingThe codes SHOULD be taken from EncounterReasonCodes Reason why the encounter takes place
TypeCodeableConcept
Summarytrue
Alternate NamesIndication, Admission diagnosis
Comments

For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. Encounter.reasonReference
Definition

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

Control0..*
TypeReference(Condition|Procedure|Observation|ImmunizationRecommendation)
Summarytrue
Alternate NamesIndication, Admission diagnosis
Comments

For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
53. Encounter.diagnosis
Definition

The list of diagnosis relevant to this encounter.

Control0..*
TypeBackboneElement
Obligations
Obligations
??
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. Encounter.diagnosis.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
55. Encounter.diagnosis.extension
Definition

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

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
56. Encounter.diagnosis.modifierExtension
Definition

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

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

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
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())
57. Encounter.diagnosis.condition
Definition

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

Control1..1
TypeReference(Condition|Procedure)
Summarytrue
Alternate NamesAdmission diagnosis, discharge diagnosis, indication
Comments

For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
58. Encounter.diagnosis.use
Definition

Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).

Control0..1
BindingThe codes SHOULD be taken from DiagnosisRole The type of diagnosis this condition represents
TypeCodeableConcept
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. Encounter.diagnosis.rank
Definition

Ranking of the diagnosis (for each role type).

Control0..1
TypepositiveInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
60. Encounter.account
Definition

The set of accounts that may be used for billing for this Encounter.

Control0..*
TypeReference(Account)
Summaryfalse
Comments

The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. Encounter.hospitalization
Definition

Details about the admission to a healthcare service.

Control0..1
TypeBackboneElement
Summaryfalse
Comments

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. Encounter.hospitalization.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
63. Encounter.hospitalization.extension
Definition

An Extension

Control0..*
TypeExtension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Encounter.hospitalization.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
64. Encounter.hospitalization.extension:BfsAdmitRole
SliceNameBfsAdmitRole
Definition

An Extension

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(BfsMsAdmitRole) (Extension Type: Coding)
InvariantsDefined on this element
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())
65. Encounter.hospitalization.extension:accident
SliceNameaccident
Definition

Extension to define an encounter is caused by an accident and at which time the accident happened

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Accident) (Complex Extension)
InvariantsDefined on this element
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. Encounter.hospitalization.extension:readmission
SliceNamereadmission
Definition

Optional Extension Element - found in all resources.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(EncounterSupsectedReadmission) (Extension Type: boolean)
InvariantsDefined on this element
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())
67. Encounter.hospitalization.extension:BfsDischargeDecision
SliceNameBfsDischargeDecision
Definition

An Extension

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(BfsDischargeDecision) (Extension Type: Coding)
InvariantsDefined on this element
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())
68. Encounter.hospitalization.extension:BfsDischargeDestination
SliceNameBfsDischargeDestination
Definition

An Extension

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(BfsDischargeDestination) (Extension Type: Coding)
InvariantsDefined on this element
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())
69. Encounter.hospitalization.modifierExtension
Definition

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

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

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
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. Encounter.hospitalization.preAdmissionIdentifier
Definition

Pre-admission identifier.

Control0..1
TypeIdentifier
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
71. Encounter.hospitalization.origin
Definition

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

Control0..1
TypeReference(CHCoreLocation|CHCoreOrganization)
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
72. Encounter.hospitalization.admitSource
Definition

From where patient was admitted (physician referral, transfer).

Control0..1
BindingThe codes SHALL be taken from BFS Medizinische Statistik - 17 1.2.V02 - Aufenthaltsort vor dem Eintritt / Séjour avant l’admission / Luogo di soggiorno prima dell’ammissione; other codes may be used where these codes are not suitable
TypeCodeableConcept
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
73. Encounter.hospitalization.reAdmission
Definition

Whether this hospitalization is a readmission and why if known.

Control0..1
BindingFor example codes, see hl7VS-re-admissionIndicator The reason for re-admission of this hospitalization encounter
TypeCodeableConcept
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
74. Encounter.hospitalization.dietPreference
Definition

Diet preferences reported by the patient.

Control0..*
BindingFor example codes, see Diet Medical, cultural or ethical food preferences to help with catering requirements
TypeCodeableConcept
Summaryfalse
Requirements

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

Comments

For example, a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
75. Encounter.hospitalization.specialCourtesy
Definition

Special courtesies (VIP, board member).

Control0..*
BindingThe codes SHOULD be taken from SpecialCourtesy Special courtesies
TypeCodeableConcept
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
76. Encounter.hospitalization.specialArrangement
Definition

Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.

Control0..*
BindingThe codes SHOULD be taken from SpecialArrangements Special arrangements
TypeCodeableConcept
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
77. Encounter.hospitalization.destination
Definition

Location/organization to which the patient is discharged.

Control0..1
TypeReference(CHCoreLocation|CHCoreOrganization)
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
78. Encounter.hospitalization.dischargeDisposition
Definition

Category or kind of location after discharge.

Control0..1
BindingThe codes SHOULD be taken from BFS Medizinische Statistik - 29 1.5.V04 - Behandlung nach Austritt / Prise en charge après la sortie / Trattamento dopo l’uscita BFS Medizinische Statistik - Behandlung nach Austrit
TypeCodeableConcept
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
79. Encounter.location
Definition

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

Control0..*
TypeBackboneElement
Summaryfalse
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".

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
80. Encounter.location.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
81. Encounter.location.extension
Definition

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

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
82. Encounter.location.modifierExtension
Definition

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

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

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
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())
83. Encounter.location.location
Definition

The location where the encounter takes place.

Control1..1
TypeReference(CHCoreLocation)
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
84. Encounter.location.status
Definition

The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time.

Control0..1
BindingThe codes SHALL be taken from EncounterLocationStatus The status of the location
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Comments

When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
85. Encounter.location.physicalType
Definition

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

Control0..1
BindingFor example codes, see LocationType Physical form of the location
TypeCodeableConcept
Summaryfalse
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
86. Encounter.location.period
Definition

Time period during which the patient was present at the location.

Control0..1
TypePeriod
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
87. Encounter.serviceProvider
Definition

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

Control0..1
TypeReference(CHCoreOrganization)
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
88. Encounter.partOf
Definition

Another Encounter of which this encounter is a part of (administratively or in time).

Control0..1
TypeReference(CHCoreEncounter)
Summaryfalse
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))