| LzEncounter (Encounter) | C | | Zib Encounter | There are no (further) constraints on this element Element idEncounter Short descriptionEncounter Alternate namesVisit, Contact DefinitionAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
Data typeZib Encounter Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty() Mappings- rim: Entity. Role, or Act
- rim: Encounter[@moodCode='EVN']
- w5: workflow.encounter
- hcim-encounter-v1.2-2015EN: NL-CM:15.1.1
- hcim-encounter-v3.0-2016EN: NL-CM:15.1.1
- hcim-encounter-v3.1-2017EN: NL-CM:15.1.1
|
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idEncounter.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data typeid ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idEncounter.meta Short descriptionMetadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Data typeMeta ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idEncounter.implicitRules Short descriptionA set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
CommentsAsserting 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.
This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idEncounter.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
CommentsLanguage 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).
Data typecode BindingA human language. Common Languages (extensible) Binding extensionsConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idEncounter.text Short descriptionText summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource, and may 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.
CommentsContained 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 in formation is added later.
Data typeNarrative ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, dom-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- rim: N/A
- rim: Act.text?
|
| contained | | 0..* | Resource | There are no (further) constraints on this element Element idEncounter.contained Short descriptionContained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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.
CommentsThis 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.
Data typeResource Mappings- rim: Entity. Role, or Act
- rim: N/A
|
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. Usually modifier elements provide negation or qualification. In order 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idEncounter.identifier Short descriptionIdentifier(s) by which this encounter is known DefinitionIdentifier(s) by which this encounter is known.
Data typeIdentifier ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd: Identifier
- v2: PV1-19
- rim: .id
- w5: id
- hcim-basicelements-v1.0-2017EN: NL-CM:0.0.6
|
| status | Σ ?! | 1..1 | codeBinding | Element idEncounter.status Short descriptionplanned | arrived | triaged | in-progress | onleave | finished | cancelled + Definitionplanned | arrived | triaged | in-progress | onleave | finished | cancelled +.
CommentsThis element is implictly mapped to the zib concepts NL-CM:15.1.3 (StartDateTime) and NL-CM:15.1.4 (EndDateTime), with the exception that the StartDateTime may attain a value in the future (which functionally is a pre-adopt of zib release 2020). Unless the status is explicitly recorded, the following guidance applies:
- When StartDateTime is in the future,
.status will usually be set to planned.
- When StartDateTime is in the past and EndDateTime is present and in the future,
.status will usually be set to in-progress.
- When EndDateTime is present and in the past,
.status will usually be set to finished.
- When EndDateTime is not present, this means it was a point-in-time encounter and
.status will usually be set to finished.
- When a system is unable to infer the status from the StartDateTime and EndDateTime,
.status will be set to unknown.
The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the procedure.
This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Data typecode BindingCurrent state of the encounter EncounterStatus (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: No clear equivalent in HL7 v2; active/finished could be inferred from PV1-44, PV1-45, PV2-24; inactive could be inferred from PV2-16
- rim: .statusCode
- w5: status
- hcim-encounter-v3.1-2017EN: NL-CM:15.1.3
- hcim-encounter-v3.1-2017EN: NL-CM:15.1.4
|
| statusHistory | | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.statusHistory Short descriptionList of past encounter statuses DefinitionThe 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.
CommentsThe current status is always found in the current version of the resource, not the status history.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idEncounter.statusHistory.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.statusHistory.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.statusHistory.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
CommentsThere 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.
Data typeExtension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| status | | 1..1 | codeBinding | There are no (further) constraints on this element Element idEncounter.statusHistory.status Short descriptionplanned | arrived | triaged | in-progress | onleave | finished | cancelled + Definitionplanned | arrived | triaged | in-progress | onleave | finished | cancelled +.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typecode BindingCurrent state of the encounter EncounterStatus (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| period | C | 1..1 | Period | There are no (further) constraints on this element Element idEncounter.statusHistory.period Short descriptionThe time that the episode was in the specified status DefinitionThe time that the episode was in the specified status.
CommentsThis is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
Data typePeriod ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end) Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
|
| class | Σ | 1..1 | CodingBinding | There are no (further) constraints on this element Element idEncounter.class Short descriptionContactType Alternate namesContactType DefinitionCommentsCodes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.
Data typeCoding BindingContactTypeCodelijst ContactTypeCodelijst (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
- v2: PV1-2
- rim: .inboundRelationship[typeCode=SUBJ].source[classCode=LIST].code
- w5: class
- hcim-encounter-v1.2-2015EN: NL-CM:15.1.2
- hcim-encounter-v3.0-2016EN: NL-CM:15.1.2
- hcim-encounter-v3.1-2017EN: NL-CM:15.1.2
|
| classHistory | | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.classHistory Short descriptionList of past encounter classes DefinitionThe 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 transisions 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 kindof discharge from emergency to inpatient.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idEncounter.classHistory.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.classHistory.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.classHistory.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
CommentsThere 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.
Data typeExtension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| class | | 1..1 | CodingBinding | There are no (further) constraints on this element Element idEncounter.classHistory.class Short descriptioninpatient | outpatient | ambulatory | emergency + Definitioninpatient | outpatient | ambulatory | emergency +.
CommentsCodes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.
Data typeCoding BindingClassification of the encounter ActEncounterCode (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
|
| period | C | 1..1 | Period | There are no (further) constraints on this element Element idEncounter.classHistory.period Short descriptionThe time that the episode was in the specified class DefinitionThe time that the episode was in the specified class.
CommentsThis is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
Data typePeriod ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end) Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
|
| type | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idEncounter.type Short descriptionSpecific type of encounter DefinitionSpecific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
CommentsSince there are many ways to further classify encounters, this element is 0..*.
Data typeCodeableConcept BindingThe type of encounter EncounterType (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: PV1-4 / PV1-18
- rim: .code
- w5: class
|
| priority | | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.priority Short descriptionIndicates the urgency of the encounter DefinitionIndicates the urgency of the encounter.
CommentsNot all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data typeCodeableConcept BindingIndicates the urgency of the encounter. v3 Code System ActPriority (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: PV2-25
- rim: .priorityCode
- w5: grade
|
| subject | Σ C | 1..1 | Reference(nl-core-patient) | There are no (further) constraints on this element Element idEncounter.subject Short descriptionThe patient ro group present at the encounter Alternate namespatient DefinitionThe patient ro group present at the encounter.
CommentsWhile the encounter is always about the patient, the patient may 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).
Data typeReference(nl-core-patient) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: PID-3
- rim: .participation[typeCode=SBJ]/role[classCode=PAT]
- w5: who.focus
- hcim-basicelements-v1.0-2017EN: NL-CM:0.0.11
|
| episodeOfCare | Σ C | 0..* | Reference(nl-core-episodeofcare) | There are no (further) constraints on this element Element idEncounter.episodeOfCare Short descriptionEpisode(s) of care that this encounter should be recorded against DefinitionWhere 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).
CommentsReferences SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data typeReference(nl-core-episodeofcare) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: PV1-54, PV1-53
- w5: context
|
| incomingReferral | C | 0..* | Reference(ReferralRequest) | There are no (further) constraints on this element Element idEncounter.incomingReferral Short descriptionThe ReferralRequest that initiated this encounter DefinitionThe referral request this encounter satisfies (incoming referral).
CommentsReferences SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data typeReference(ReferralRequest) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- rim: .reason.ClinicalDocument
|
| participant | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.participant Short descriptionList of participants involved in the encounter DefinitionThe list of people responsible for providing the service.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: ROL
- rim: .participation[typeCode=PFM]
- hcim-basicelements-v1.0-2017EN: NL-CM:0.0.7
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idEncounter.participant.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.participant.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.participant.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
CommentsThere 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.
Data typeExtension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| type | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.participant.type Short descriptionRole of participant in encounter DefinitionRole of participant in encounter.
CommentsThe participant type indicates how an individual partitipates 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.
Data typeCodeableConcept BindingRole of participant in encounter ParticipantType (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: ROL-3 (or maybe PRT-4)
- rim: .functionCode
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idEncounter.participant.type.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.participant.type.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idEncounter.participant.type.coding Short descriptionCode defined by a terminology system DefinitionA reference to a code defined by a terminology system.
RequirementsAllows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
CommentsCodes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Data typeCoding SlicingUnordered, Open, by $this(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
- v2: C*E.1-8, C*E.10-22
- rim: union(., ./translation)
- orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
|
| healthProfessionalRole | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idEncounter.participant.type.coding:healthProfessionalRole Short descriptionHealthProfessionalRole Alternate namesZorgverlenerRol DefinitionThe role the healthcare provider fulfils in the healthcare process. For healthcare providers, this could be for example main practitioner, referrer or general practitioner.
RequirementsAllows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
CommentsCodes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Data typeCoding BindingZorgverlenerRolCodelijst (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
- v2: C*E.1-8, C*E.10-22
- rim: union(., ./translation)
- orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
- hcim-healthprofessional-v1.2.1-2015EN: NL-CM:17.1.5
- hcim-healthprofessional-v3.0-2016EN: NL-CM:17.1.5
- hcim-healthprofessional-v3.2-2017EN: NL-CM:17.1.5
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.participant.type.text Short descriptionPlain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
RequirementsThe codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
CommentsVery often the text is the same as a displayName of one of the codings.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: C*E.9. But note many systems use C*E.2 for this
- rim: ./originalText[mediaType/code="text/plain"]/data
- orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
|
| period | C | 0..1 | Period | There are no (further) constraints on this element Element idEncounter.participant.period Short descriptionPeriod of time during the encounter that the participant participated DefinitionThe period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.
CommentsThis is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
Data typePeriod ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end) Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: ROL-5, ROL-6 (or maybe PRT-5)
- rim: .time
|
| individual | Σ C | 0..1 | Reference(nl-core-practitioner | nl-core-relatedperson) | There are no (further) constraints on this element Element idEncounter.participant.individual Short descriptionContactWith Alternate namesContactMet DefinitionThe healthcare provider with whom the contact took place. The specialty and role of the healthcare provider can be entered in the HealthcareProvider information model as well.
CommentsReferences SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data typeReference(nl-core-practitioner | nl-core-relatedperson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: ROL-4
- rim: .role
- w5: who
- hcim-encounter-v1.2-2015EN: NL-CM:15.1.7
- hcim-encounter-v3.0-2016EN: NL-CM:15.1.7
- hcim-encounter-v3.1-2017EN: NL-CM:15.1.7
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idEncounter.participant.individual.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.participant.individual.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| practitionerRole | C | 0..1 | Extension(Reference(nl-core-practitionerrole)) | There are no (further) constraints on this element Element idEncounter.participant.individual.extension:practitionerRole Short descriptionOptional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources.
CommentsThere 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.
Data typeExtension(Reference(nl-core-practitionerrole)) Extension URLhttp://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idEncounter.participant.individual.reference Short descriptionLiteral reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
CommentsUsing absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idEncounter.participant.individual.identifier Short descriptionLogical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
CommentsWhen an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Data typeIdentifier ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd: Identifier
- rim: .identifier
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.participant.individual.display Short descriptionText alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
CommentsThis is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| appointment | Σ C | 0..1 | Reference(Appointment) | There are no (further) constraints on this element Element idEncounter.appointment Short descriptionThe appointment that scheduled this encounter DefinitionThe appointment that scheduled this encounter.
CommentsReferences SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data typeReference(Appointment) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: SCH-1 / SCH-2
- rim: .outboundRelationship[typeCode=FLFS].target[classCode=ENC, moodCode=APT]
|
| period | C | 0..1 | Period | There are no (further) constraints on this element Element idEncounter.period Short descriptionThe start and end time of the encounter DefinitionThe start and end time of the encounter.
CommentsIf not (yet) known, the end of the Period may be omitted.
Data typePeriod ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end) Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: PV1-44, PV1-45
- rim: .effectiveTime (low & high)
- w5: when.done
- hcim-basicelements-v1.0-2017EN: NL-CM:0.0.14
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idEncounter.period.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.period.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| start | Σ C | 1..1 | dateTime | Element idEncounter.period.start Short descriptionStartDateTime Alternate namesBeginDatumTijd DefinitionThe date and time at which the contact took or will take place.
CommentsNote that this element may attain a value in the future (which functionally is a pre-adopt of zib release 2020), contrary to the zib-Encounter profile.
Data typedateTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: DR.1
- rim: ./low
- hcim-encounter-v1.2-2015EN: NL-CM:15.1.3
- hcim-encounter-v3.0-2016EN: NL-CM:15.1.3
- hcim-encounter-v3.1-2017EN: NL-CM:15.1.3
|
| end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idEncounter.period.end Short descriptionEndDateTime Alternate namesEindDatumTijd DefinitionThe date and time at which the contact ended. If the contact takes place over a period of time, this indicates the end of the period, in the case of an admission, for example.
If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
CommentsThe high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.
Meaning when missingIf the end of the period is missing, it means that the period is ongoing
Data typedateTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: DR.2
- rim: ./high
- hcim-encounter-v1.2-2015EN: NL-CM:15.1.4
- hcim-encounter-v3.0-2016EN: NL-CM:15.1.4
- hcim-encounter-v3.1-2017EN: NL-CM:15.1.4
|
| length | C | 0..1 | Duration | There are no (further) constraints on this element Element idEncounter.length Short descriptionQuantity of time the encounter lasted (less time absent) DefinitionQuantity of time the encounter lasted. This excludes the time during leaves of absence.
CommentsMay differ from the time the Encounter.period lasted because of leave of absence.
Data typeDuration ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists() - drt-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM.
code.exists() implies ((system = %ucum) and value.exists()) Mappings- rim: n/a
- v2: SN (see also Range) or CQ
- rim: PQ, IVL<PQ>, MO, CO, depending on the values
- rim: PQ, IVL<PQ> depending on the values
- v2: (PV1-45 less PV1-44) iff ( (PV1-44 not empty) and (PV1-45 not empty) ); units in minutes
- rim: .lengthOfStayQuantity
|
| reason | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.reason Short descriptionDeviatingResult Alternate namesIndication, Admission diagnosis, AfwijkendeUitslag DefinitionA deviating result which serves as the reason for the contact.
CommentsFor 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).
Data typeCodeableConcept BindingReason why the encounter takes place. Encounter Reason Codes (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: EVN-4 / PV2-3 (note: PV2-3 is nominally constrained to inpatient admissions; HL7 v2 makes no vocabulary suggestions for PV2-3; would not expect PV2 segment or PV2-3 to be in use in all implementations )
- rim: .reasonCode
- w5: why
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idEncounter.reason.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.reason.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idEncounter.reason.coding Short descriptionCode defined by a terminology system DefinitionA reference to a code defined by a terminology system.
RequirementsAllows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
CommentsCodes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Data typeCoding ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
- v2: C*E.1-8, C*E.10-22
- rim: union(., ./translation)
- orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idEncounter.reason.text Short descriptionDeviatingResult Alternate namesAfwijkendeUitslag DefinitionA deviating result which serves as the reason for the contact.
RequirementsThe codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
CommentsVery often the text is the same as a displayName of one of the codings.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: C*E.9. But note many systems use C*E.2 for this
- rim: ./originalText[mediaType/code="text/plain"]/data
- orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
- hcim-encounter-v1.2-2015EN: NL-CM:15.1.12
- hcim-encounter-v3.0-2016EN: NL-CM:15.1.12
- hcim-encounter-v3.1-2017EN: NL-CM:15.1.12
|
| diagnosis | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.diagnosis Short descriptionThe list of diagnosis relevant to this encounter DefinitionThe list of diagnosis relevant to this encounter.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- rim: .outboundRelationship[typeCode=RSON]
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idEncounter.diagnosis.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.diagnosis.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.diagnosis.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
CommentsThere 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.
Data typeExtension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| condition | C | 1..1 | Reference(Zib Problem | Zib Procedure) | There are no (further) constraints on this element Element idEncounter.diagnosis.condition Short descriptionContactReason Alternate namesAdmission diagnosis, discharge diagnosis, indication, Probleem, Procedure DefinitionThe problem that led to the contact or the procedure carried out during the contact.
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.
CommentsFor 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).
Data typeReference(Zib Problem | Zib Procedure) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: Resources that would commonly referenced at Encounter.indication would be Condition and/or Procedure. These most closely align with DG1/PRB and PR1 respectively.
- rim: .outboundRelationship[typeCode=RSON].target
- w5: why
- hcim-encounter-v1.2-2015EN: NL-CM:15.1.6
- hcim-encounter-v3.0-2016EN: NL-CM:15.1.6
- hcim-encounter-v3.1-2017EN: NL-CM:15.1.6
- hcim-encounter-v1.2-2015EN: NL-CM:15.1.11
- hcim-encounter-v3.0-2016EN: NL-CM:15.1.11
- hcim-encounter-v3.1-2017EN: NL-CM:15.1.11
|
| role | | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.diagnosis.role Short descriptionRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …) DefinitionRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …).
CommentsNot all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data typeCodeableConcept BindingThe type of diagnosis this condition represents DiagnosisRole (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
|
| rank | | 0..1 | positiveInt | There are no (further) constraints on this element Element idEncounter.diagnosis.rank Short descriptionRanking of the diagnosis (for each role type) DefinitionRanking of the diagnosis (for each role type).
Comments32 bit number; for values larger than this, use decimal
Data typepositiveInt ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- rim: .outboundRelationship[typeCode=RSON].priority
|
| account | C | 0..* | Reference(Account) | There are no (further) constraints on this element Element idEncounter.account Short descriptionThe set of accounts that may be used for billing for this Encounter DefinitionThe set of accounts that may be used for billing for this Encounter.
CommentsThe billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules.
Data typeReference(Account) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- rim: .pertains.A_Account
|
| hospitalization | | 0..1 | BackboneElement | There are no (further) constraints on this element Element idEncounter.hospitalization Short descriptionDetails about the admission to a healthcare service DefinitionDetails about the admission to a healthcare service.
CommentsAn 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.
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- rim: .outboundRelationship[typeCode=COMP].target[classCode=ENC, moodCode=EVN]
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idEncounter.hospitalization.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.hospitalization.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.hospitalization.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
CommentsThere 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.
Data typeExtension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| preAdmissionIdentifier | | 0..1 | Identifier | There are no (further) constraints on this element Element idEncounter.hospitalization.preAdmissionIdentifier Short descriptionPre-admission identifier DefinitionPre-admission identifier.
Data typeIdentifier ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd: Identifier
- v2: PV1-5
- rim: .id
|
| origin | C | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idEncounter.hospitalization.origin Short descriptionThe location from which the patient came before admission DefinitionThe location from which the patient came before admission.
CommentsReferences SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data typeReference(Location) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- rim: .participation[typeCode=ORG].role
|
| admitSource | | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.hospitalization.admitSource Short descriptionOrigin Alternate namesHerkomst DefinitionLocation from which the patient came before the encounter. In most cases this will only be used when the patient is admitted.
CommentsNot all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data typeCodeableConcept BindingHerkomstCodelijst HerkomstCodelijst (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: PV1-14
- rim: .admissionReferralSourceCode
- hcim-encounter-v3.1-2017EN: NL-CM:15.1.14
|
| reAdmission | | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.hospitalization.reAdmission Short descriptionThe type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission DefinitionWhether this hospitalization is a readmission and why if known.
CommentsNot all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data typeCodeableConcept BindingThe reason for re-admission of this hospitalization encounter. v2 Re-Admission Indicator (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: PV1-13
|
| dietPreference | | 0..* | CodeableConcept | There are no (further) constraints on this element Element idEncounter.hospitalization.dietPreference Short descriptionDiet preferences reported by the patient DefinitionDiet preferences reported by the patient.
RequirementsUsed 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.
CommentsFor example a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive).
Data typeCodeableConcept BindingMedical, cultural or ethical food preferences to help with catering requirements. Diet (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: PV1-38
- rim: .outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=EVN, code="diet"]
|
| specialCourtesy | | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.hospitalization.specialCourtesy Short descriptionSpecial courtesies (VIP, board member) DefinitionSpecial courtesies (VIP, board member).
CommentsNot all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data typeCodeableConcept BindingSpecial courtesies SpecialCourtesy (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: PV1-16
- rim: .specialCourtesiesCode
|
| specialArrangement | | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.hospitalization.specialArrangement Short descriptionWheelchair, translator, stretcher, etc. DefinitionAny special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.
CommentsNot all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data typeCodeableConcept BindingSpecial arrangements SpecialArrangements (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: PV1-15 / OBR-30 / OBR-43
- rim: .specialArrangementCode
|
| destination | C | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idEncounter.hospitalization.destination Short descriptionLocation to which the patient is discharged DefinitionLocation to which the patient is discharged.
CommentsReferences SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data typeReference(Location) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: PV1-37
- rim: .participation[typeCode=DST]
|
| dischargeDisposition | | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.hospitalization.dischargeDisposition Short descriptionDestination Alternate namesBestemming DefinitionLocation to which the patient will go after the encounter. In most cases this will only be used when the patient is discharged.
CommentsNot all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data typeCodeableConcept BindingBestemmingCodelijst BestemmingCodelijst (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: PV1-36
- rim: .dischargeDispositionCode
- hcim-encounter-v3.1-2017EN: NL-CM:15.1.16
|
| location | | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.location Short descriptionList of locations where the patient has been DefinitionList of locations where the patient has been during this encounter.
CommentsVirtual 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".
Data typeBackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- rim: .participation[typeCode=LOC]
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idEncounter.location.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.location.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.location.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
CommentsThere 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.
Data typeExtension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| location | C | 1..1 | Reference(Location) | There are no (further) constraints on this element Element idEncounter.location.location Short descriptionLocation the encounter takes place DefinitionThe location where the encounter takes place.
CommentsReferences SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data typeReference(Location) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: PV1-3 / PV1-6 / PV1-11 / PV1-42 / PV1-43
- rim: .role
- w5: where
|
| status | | 0..1 | codeBinding | There are no (further) constraints on this element Element idEncounter.location.status Short descriptionplanned | active | reserved | completed DefinitionThe status of the participants' presence at the specified location during the period specified. If the participant is is no longer at the location, then the period will have an end date/time.
CommentsWhen the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed.
Data typecode BindingThe status of the location. EncounterLocationStatus (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- rim: .role.statusCode
|
| period | C | 0..1 | Period | There are no (further) constraints on this element Element idEncounter.location.period Short descriptionTime period during which the patient was present at the location DefinitionTime period during which the patient was present at the location.
CommentsThis is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
Data typePeriod ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end) Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- rim: .time
|
| serviceProvider | C | 0..1 | Reference(nl-core-organization) | There are no (further) constraints on this element Element idEncounter.serviceProvider Short descriptionLocation Alternate namesLocatie DefinitionThe physical location at which the contact took place.
CommentsReferences SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data typeReference(nl-core-organization) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: PV1-10 / PL.6 & PL.1 (note: HL7 v2 definition is "the treatment or type of surgery that the patient is scheduled to receive"; seems slightly out of alignment with the concept name 'hospital service'. Would not trust that implementations apply this semantic by default)
- rim: .particiaption[typeCode=PFM].role
- hcim-encounter-v1.2-2015EN: NL-CM:15.1.8
- hcim-encounter-v3.0-2016EN: NL-CM:15.1.8
- hcim-encounter-v3.1-2017EN: NL-CM:15.1.8
|
| partOf | C | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idEncounter.partOf Short descriptionAnother Encounter this encounter is part of DefinitionAnother Encounter of which this encounter is a part of (administratively or in time).
CommentsThis 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.
Data typeReference(Encounter) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- rim: .inboundRelationship[typeCode=COMP].source[classCode=COMP, moodCode=EVN]
|