4.1. Retrieve Long-term Healthcare - Encounter

4.1.1. Overview

Id 900000408
Data service name without version (English) Retrieve Long-term Healthcare - Encounter
Data service name without version (Dutch) Verzamelen Langdurige Zorg - Contact
Data service version 1.0.0-beta.1
System role(s) LZ-ENR-1.0.0-beta.1-FHIR (PHR)
LZ-ENB-1.0.0-beta.1-FHIR (XIS)
Relevant domain(s) Long-term Healthcare

4.1.2. Functional model

CIM zib Encounter in publication 2017 adjusted with a pre-adopt of its counterpart in publication 2020 in the sense that future contacts are in scope as well
Functional version 1.0.0-beta.2

4.1.3. Technical specification

FHIR profile(s) http://medmij.nl/fhir/StructureDefinition/lz-Encounter
FHIR package medmij.fhir.nl.stu3.longtermhealthcare version 1.0.0-beta.2 or compatible
FHIR version STU3
Search request GET [base]/Encounter
Must Support
CapabilityStatement(s) Long-term Healthcare Encounter Retrieve
Long-term Healthcare Encounter Serve

The FHIR profile is included below.

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textC0..1Narrative
contained0..*Resource
extensionC0..*Extension
modifierExtension?! C0..*Extension
identifierΣ0..*Identifier
statusΣ ?!1..1codeBinding
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
status1..1codeBinding
periodC1..1Period
classΣ1..1CodingBinding
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
class1..1CodingBinding
periodC1..1Period
typeΣ0..*CodeableConcept
priority0..1CodeableConcept
subjectΣ C1..1Reference(nl-core-patient)
episodeOfCareΣ C0..*Reference(nl-core-episodeofcare)
incomingReferralC0..*Reference(ReferralRequest)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
id0..1string
extensionC0..*Extension
healthProfessionalRoleΣ0..*CodingBinding
textΣ0..1string
periodC0..1Period
id0..1string
practitionerRoleC0..1Extension(Reference(nl-core-practitionerrole))
referenceΣ C0..1string
identifierΣ0..1Identifier
displayΣ0..1string
appointmentΣ C0..1Reference(Appointment)
id0..1string
extensionC0..*Extension
startΣ C1..1dateTime
endΣ C0..1dateTime
lengthC0..1Duration
id0..1string
extensionC0..*Extension
codingΣ0..*Coding
textΣ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
conditionC1..1Reference(Zib Problem | Zib Procedure)
role0..1CodeableConceptBinding
rank0..1positiveInt
accountC0..*Reference(Account)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
preAdmissionIdentifier0..1Identifier
originC0..1Reference(Location)
admitSource0..1CodeableConceptBinding
reAdmission0..1CodeableConcept
dietPreference0..*CodeableConcept
specialCourtesy0..*CodeableConceptBinding
specialArrangement0..*CodeableConceptBinding
destinationC0..1Reference(Location)
dischargeDisposition0..1CodeableConceptBinding
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
locationC1..1Reference(Location)
status0..1codeBinding
periodC0..1Period
serviceProviderC0..1Reference(nl-core-organization)
partOfC0..1Reference(Encounter)
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="lz-Encounter" />
<status value="empty" />
--- We have skipped the narrative for better readability of the resource ---
</text>
<url value="http://medmij.nl/fhir/StructureDefinition/lz-Encounter" />
<name value="LzEncounter" />
<title value="lz Encounter" />
<status value="draft" />
<publisher value="MedMij" />
<name value="MedMij" />
<system value="email" />
<value value="info@medmij.nl" />
<use value="work" />
</telecom>
</contact>
<description value="A contact is any interaction, regardless of the situation, between a patient and the healthcare provider, in which the healthcare provider has primary responsibility for diagnosing, evaluating and treating the patient's condition and informing the patient. These can be visits, appointments or non face-to-face interactions.\n\nContacts can be visits to the general practitioner or other practices, home visits, admissions (in hospitals, nursing homes or care homes, psychiatric institutions or convalescent homes) or other relevant contacts. This includes past and future contacts." />
<purpose value="This Encounter resource represents the Dutch [zib ('Zorginformatiebouwsteen', i.e. Health and Care Information Model) Encounter v3.1 (2017)](https://zibs.nl/wiki/Encounter-v3.1(2017EN)) adjusted such that it is suitable for implementation purposes in the context of Long-term Healthcare.\n\nThis profile is derived from the [zib-Encounter](http://nictiz.nl/fhir/StructureDefinition/zib-Encounter) profile, and differs from the latter profile in the sense that it can be used for future encounters as well as past encounters. This aligns with zib publication 2020. Strictly speaking, the change made in this profile is incompatible with the zib-Encounter profile. However, since the latter profile does not technically enforce contacts to be in the past, it could be used as a base for this profile." />
<copyright value="Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise." />
<fhirVersion value="3.0.2" />
<identity value="hcim-encounter-v3.1-2017EN" />
<uri value="https://zibs.nl/wiki/Encounter-v3.1(2017EN)" />
<name value="HCIM Encounter-v3.1(2017EN)" />
</mapping>
<kind value="resource" />
<abstract value="false" />
<type value="Encounter" />
<baseDefinition value="http://nictiz.nl/fhir/StructureDefinition/zib-Encounter" />
<derivation value="constraint" />
<element id="Encounter.status">
<path value="Encounter.status" />
<comment value="This 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:\n\n* When StartDateTime is in the future, `.status` will usually be set to _planned_.\n* When StartDateTime is in the past and EndDateTime is present and in the future, `.status` will usually be set to _in-progress_.\n* When EndDateTime is present and in the past, `.status` will usually be set to _finished_.\n* When EndDateTime is not present, this means it was a point-in-time encounter and `.status` will usually be set to _finished_.\n* When a system is unable to infer the status from the StartDateTime and EndDateTime, `.status` will be set to _unknown_.\n\nThe _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.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid." />
<identity value="hcim-encounter-v3.1-2017EN" />
<map value="NL-CM:15.1.3" />
<comment value="StartDateTime (implicit, main mapping is on `Encounter.period.start`)" />
</mapping>
<identity value="hcim-encounter-v3.1-2017EN" />
<map value="NL-CM:15.1.4" />
<comment value="EndDateTime (implicit, main mapping is on `Encounter.period.end`)" />
</mapping>
</element>
<element id="Encounter.period.start">
<path value="Encounter.period.start" />
<definition value="The date and time at which the contact took or will take place." />
<comment value="Note 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](http://nictiz.nl/fhir/StructureDefinition/zib-Encounter) profile." />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "lz-Encounter",
"text": {
"status": "empty",
--- We have skipped the narrative for better readability of the resource ---
},
"url": "http://medmij.nl/fhir/StructureDefinition/lz-Encounter",
"name": "LzEncounter",
"title": "lz Encounter",
"status": "draft",
"publisher": "MedMij",
"contact": [
{
"name": "MedMij",
"telecom": [
{
"system": "email",
"value": "info@medmij.nl",
"use": "work"
}
]
}
],
"description": "A contact is any interaction, regardless of the situation, between a patient and the healthcare provider, in which the healthcare provider has primary responsibility for diagnosing, evaluating and treating the patient's condition and informing the patient. These can be visits, appointments or non face-to-face interactions.\n\nContacts can be visits to the general practitioner or other practices, home visits, admissions (in hospitals, nursing homes or care homes, psychiatric institutions or convalescent homes) or other relevant contacts. This includes past and future contacts.",
"purpose": "This Encounter resource represents the Dutch [zib ('Zorginformatiebouwsteen', i.e. Health and Care Information Model) Encounter v3.1 (2017)](https://zibs.nl/wiki/Encounter-v3.1(2017EN)) adjusted such that it is suitable for implementation purposes in the context of Long-term Healthcare.\n\nThis profile is derived from the [zib-Encounter](http://nictiz.nl/fhir/StructureDefinition/zib-Encounter) profile, and differs from the latter profile in the sense that it can be used for future encounters as well as past encounters. This aligns with zib publication 2020. Strictly speaking, the change made in this profile is incompatible with the zib-Encounter profile. However, since the latter profile does not technically enforce contacts to be in the past, it could be used as a base for this profile.",
"copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "hcim-encounter-v3.1-2017EN",
"uri": "https://zibs.nl/wiki/Encounter-v3.1(2017EN)",
"name": "HCIM Encounter-v3.1(2017EN)"
}
],
"kind": "resource",
"abstract": false,
"type": "Encounter",
"baseDefinition": "http://nictiz.nl/fhir/StructureDefinition/zib-Encounter",
"derivation": "constraint",
"element": [
{
"id": "Encounter.status",
"path": "Encounter.status",
"comment": "This 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:\n\n* When StartDateTime is in the future, `.status` will usually be set to _planned_.\n* When StartDateTime is in the past and EndDateTime is present and in the future, `.status` will usually be set to _in-progress_.\n* When EndDateTime is present and in the past, `.status` will usually be set to _finished_.\n* When EndDateTime is not present, this means it was a point-in-time encounter and `.status` will usually be set to _finished_.\n* When a system is unable to infer the status from the StartDateTime and EndDateTime, `.status` will be set to _unknown_.\n\nThe _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.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"mapping": [
{
"identity": "hcim-encounter-v3.1-2017EN",
"map": "NL-CM:15.1.3",
"comment": "StartDateTime (implicit, main mapping is on `Encounter.period.start`)"
},
{
"identity": "hcim-encounter-v3.1-2017EN",
"map": "NL-CM:15.1.4",
"comment": "EndDateTime (implicit, main mapping is on `Encounter.period.end`)"
}
]
},
{
"id": "Encounter.period.start",
"path": "Encounter.period.start",
"definition": "The date and time at which the contact took or will take place.",
"comment": "Note 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](http://nictiz.nl/fhir/StructureDefinition/zib-Encounter) profile."
}
]
}
}