1.0.0 - Release
This page is part of the KLGatewayRehab (v1.0.0: Release) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://fhir.kl.dk/rehab/StructureDefinition/klgateway-140-encounter | Version: 1.0.0 | |||
Active as of 2023-09-28 | Computable Name: KLGateway140Encounter |
Encounter for first planned visits and all executed activities in a §140 care pathway
klgateway-140-encounter is used whenever a citizen meets the rehabilitation staff in a Danish municipality context.
In the context of the rehabilitation repporting, all Encounter.status values may be used, but not all are mandatory. The mandatory part is:
Enconters that are planned, but not carried out are possible to report but not mandatory.
Encounter.class is mandatory in FHIR. In Danish municipalities, the values are used as follows.
Encounter.extension[basedOnCarePlan] should be populated with a reference to the care plan or planned intervention that describes the activities that are planned for the encounter.
The time of the encounter is documented in Encounter.period.start and Encounter.periode.end, and both attributes are mandatory. Only planned time is mandatory to report. There is no expectation that the staff update the time if they finish a little earlier or a little later.
Encounter.subject relates to the citizen that the encounter is about.
Nedenstående tabel oversætter mellem de attributter der er defineret i den fælleskommunale informationsmodel (FKI), definerer kort den enkelte attribut på dansk og specificere hvilke af FHIR-profilens atributter der skal bruges til specifikation af indholdet
FKI-attribut | Definition | FHIR |
---|---|---|
borgerkontaktstatus | Klasse der indikerer om kontakten er igangværende, eller om dokumentationen repræsentere en fremtidig intention eller er historisk | Encounter.status |
borgerkontaktklasse | Klasse, der udtrykker en generel kategori for kontakten, som rækker ud over den kommunale kontekst. | Encounter.class |
borgerkontaktstart | Kontaktens start, eller planlagte start | Encounter.period.start |
borgerkontaktslut | Kontaktens sluttidspunkt, eller planlagte sluttidspunkt | Encounter.period.end |
borgerkontaktsubjekt | Den borger kontakten vedrører | Encounter.subject |
borgerkontaktanledning | Den henvisning/henvendelse, der er grunden til at denne kontakt udføres | Encounter.basedOn |
borgerkontaktBaseretPå | Den care plan, der er grunden til at denne kontakt udføres | Encounter.extension:basedOnCarePlan |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
basedOnCarePlan | 0..1 | Reference(KLGateway140care-plan | KLGateway140PlannedIntervention) | [DK] kontaktBaseretPå URL: http://fhir.kl.dk/rehab/StructureDefinition/BasedOnCarePlanExtension | |
value[x] | 1..1 | Reference(KLGateway140care-plan | KLGateway140PlannedIntervention) {b} | Value of extension | |
identifier | 0..0 | |||
status | 1..1 | code | [DK] kontaktstatus | |
statusHistory | 0..0 | |||
class | 1..1 | Coding | [DK] kontaktklasse | |
version | 0..0 | |||
display | 0..0 | |||
userSelected | 0..0 | |||
classHistory | 0..0 | |||
type | ||||
coding | 0..0 | |||
text | 0..0 | |||
serviceType | 0..0 | |||
priority | 0..0 | |||
subject | 1..1 | Reference(KLGateway140Citizen) {b} | [DK] kontaktsubjekt | |
episodeOfCare | 0..0 | |||
basedOn | 0..0 | |||
participant | 0..0 | |||
appointment | 0..0 | |||
period | 1..1 | Period | The start and end time of the encounter | |
start | 1..1 | dateTime | [DK] kontaktstart | |
end | 1..1 | dateTime | [DK] kontaktslut | |
length | 0..0 | |||
reasonCode | 0..0 | |||
reasonReference | 0..0 | |||
diagnosis | 0..0 | |||
account | 0..0 | |||
hospitalization | 0..0 | |||
location | 0..0 | |||
serviceProvider | 0..0 | |||
partOf | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
basedOnCarePlan | 0..1 | Reference(KLGateway140care-plan | KLGateway140PlannedIntervention) | [DK] kontaktBaseretPå URL: http://fhir.kl.dk/rehab/StructureDefinition/BasedOnCarePlanExtension | |
extension | 0..0 | |||
url | 1..1 | uri | "http://fhir.kl.dk/rehab/StructureDefinition/BasedOnCarePlanExtension" | |
value[x] | 1..1 | Reference(KLGateway140care-plan | KLGateway140PlannedIntervention) {b} | Value of extension | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | [DK] kontaktstatus Binding: EncounterStatus (required): Current state of the encounter. |
class | Σ | 1..1 | Coding | [DK] kontaktklasse Binding: ActEncounterCode (extensible): Classification of the encounter. |
subject | Σ | 1..1 | Reference(KLGateway140Citizen) {b} | [DK] kontaktsubjekt |
period | 1..1 | Period | The start and end time of the encounter | |
start | ΣC | 1..1 | dateTime | [DK] kontaktstart |
end | ΣC | 1..1 | dateTime | [DK] kontaktslut |
Documentation for this format |
Path | Conformance | ValueSet |
Encounter.status | required | EncounterStatus |
Encounter.statusHistory.status | required | EncounterStatus |
Encounter.class | extensible | ActEncounterCode |
Encounter.classHistory.class | extensible | ActEncounterCode |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
basedOnCarePlan | 0..1 | Reference(KLGateway140care-plan | KLGateway140PlannedIntervention) | [DK] kontaktBaseretPå URL: http://fhir.kl.dk/rehab/StructureDefinition/BasedOnCarePlanExtension | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://fhir.kl.dk/rehab/StructureDefinition/BasedOnCarePlanExtension" | |||||
value[x] | 1..1 | Reference(KLGateway140care-plan | KLGateway140PlannedIntervention) {b} | Value of extension | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
status | ?!Σ | 1..1 | code | [DK] kontaktstatus Binding: EncounterStatus (required): Current state of the encounter. | ||||
class | Σ | 1..1 | Coding | [DK] kontaktklasse Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
type | Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
subject | Σ | 1..1 | Reference(KLGateway140Citizen) {b} | [DK] kontaktsubjekt | ||||
period | 1..1 | Period | The start and end time of the encounter | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | ΣC | 1..1 | dateTime | [DK] kontaktstart | ||||
end | ΣC | 1..1 | dateTime | [DK] kontaktslut | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Encounter.language | preferred | CommonLanguages
| ||||
Encounter.status | required | EncounterStatus | ||||
Encounter.statusHistory.status | required | EncounterStatus | ||||
Encounter.class | extensible | ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCode | ||||
Encounter.type | example | EncounterType | ||||
Encounter.participant.type | extensible | ParticipantType | ||||
Encounter.diagnosis.use | preferred | DiagnosisRole | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSource | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicator | ||||
Encounter.hospitalization.dietPreference | example | Diet | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesy | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangements | ||||
Encounter.hospitalization.dischargeDisposition | example | DischargeDisposition | ||||
Encounter.location.status | required | EncounterLocationStatus | ||||
Encounter.location.physicalType | example | LocationType |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Encounter
Summary
Mandatory: 4 elements
Prohibited: 26 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
basedOnCarePlan | 0..1 | Reference(KLGateway140care-plan | KLGateway140PlannedIntervention) | [DK] kontaktBaseretPå URL: http://fhir.kl.dk/rehab/StructureDefinition/BasedOnCarePlanExtension | |
value[x] | 1..1 | Reference(KLGateway140care-plan | KLGateway140PlannedIntervention) {b} | Value of extension | |
identifier | 0..0 | |||
status | 1..1 | code | [DK] kontaktstatus | |
statusHistory | 0..0 | |||
class | 1..1 | Coding | [DK] kontaktklasse | |
version | 0..0 | |||
display | 0..0 | |||
userSelected | 0..0 | |||
classHistory | 0..0 | |||
type | ||||
coding | 0..0 | |||
text | 0..0 | |||
serviceType | 0..0 | |||
priority | 0..0 | |||
subject | 1..1 | Reference(KLGateway140Citizen) {b} | [DK] kontaktsubjekt | |
episodeOfCare | 0..0 | |||
basedOn | 0..0 | |||
participant | 0..0 | |||
appointment | 0..0 | |||
period | 1..1 | Period | The start and end time of the encounter | |
start | 1..1 | dateTime | [DK] kontaktstart | |
end | 1..1 | dateTime | [DK] kontaktslut | |
length | 0..0 | |||
reasonCode | 0..0 | |||
reasonReference | 0..0 | |||
diagnosis | 0..0 | |||
account | 0..0 | |||
hospitalization | 0..0 | |||
location | 0..0 | |||
serviceProvider | 0..0 | |||
partOf | 0..0 | |||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
basedOnCarePlan | 0..1 | Reference(KLGateway140care-plan | KLGateway140PlannedIntervention) | [DK] kontaktBaseretPå URL: http://fhir.kl.dk/rehab/StructureDefinition/BasedOnCarePlanExtension | |
extension | 0..0 | |||
url | 1..1 | uri | "http://fhir.kl.dk/rehab/StructureDefinition/BasedOnCarePlanExtension" | |
value[x] | 1..1 | Reference(KLGateway140care-plan | KLGateway140PlannedIntervention) {b} | Value of extension | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | [DK] kontaktstatus Binding: EncounterStatus (required): Current state of the encounter. |
class | Σ | 1..1 | Coding | [DK] kontaktklasse Binding: ActEncounterCode (extensible): Classification of the encounter. |
subject | Σ | 1..1 | Reference(KLGateway140Citizen) {b} | [DK] kontaktsubjekt |
period | 1..1 | Period | The start and end time of the encounter | |
start | ΣC | 1..1 | dateTime | [DK] kontaktstart |
end | ΣC | 1..1 | dateTime | [DK] kontaktslut |
Documentation for this format |
Path | Conformance | ValueSet |
Encounter.status | required | EncounterStatus |
Encounter.statusHistory.status | required | EncounterStatus |
Encounter.class | extensible | ActEncounterCode |
Encounter.classHistory.class | extensible | ActEncounterCode |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
basedOnCarePlan | 0..1 | Reference(KLGateway140care-plan | KLGateway140PlannedIntervention) | [DK] kontaktBaseretPå URL: http://fhir.kl.dk/rehab/StructureDefinition/BasedOnCarePlanExtension | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://fhir.kl.dk/rehab/StructureDefinition/BasedOnCarePlanExtension" | |||||
value[x] | 1..1 | Reference(KLGateway140care-plan | KLGateway140PlannedIntervention) {b} | Value of extension | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
status | ?!Σ | 1..1 | code | [DK] kontaktstatus Binding: EncounterStatus (required): Current state of the encounter. | ||||
class | Σ | 1..1 | Coding | [DK] kontaktklasse Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
type | Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
subject | Σ | 1..1 | Reference(KLGateway140Citizen) {b} | [DK] kontaktsubjekt | ||||
period | 1..1 | Period | The start and end time of the encounter | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | ΣC | 1..1 | dateTime | [DK] kontaktstart | ||||
end | ΣC | 1..1 | dateTime | [DK] kontaktslut | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Encounter.language | preferred | CommonLanguages
| ||||
Encounter.status | required | EncounterStatus | ||||
Encounter.statusHistory.status | required | EncounterStatus | ||||
Encounter.class | extensible | ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCode | ||||
Encounter.type | example | EncounterType | ||||
Encounter.participant.type | extensible | ParticipantType | ||||
Encounter.diagnosis.use | preferred | DiagnosisRole | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSource | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicator | ||||
Encounter.hospitalization.dietPreference | example | Diet | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesy | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangements | ||||
Encounter.hospitalization.dischargeDisposition | example | DischargeDisposition | ||||
Encounter.location.status | required | EncounterLocationStatus | ||||
Encounter.location.physicalType | example | LocationType |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Encounter
Summary
Mandatory: 4 elements
Prohibited: 26 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron