1.1.0 - release
This page is part of the KL Gateway (v1.1.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/gateway/StructureDefinition/klgateway-care-encounter | Version: 1.1.0 | |||
Active as of 2023-06-21 | Computable Name: KLGatewayCareEncounter |
Encounter for following up on conditions, care plans, or observations.
The Encounter may be instantiated whenever citizens and practitioners meet in a Danish municipality context. In this implementation guide it is only used for follow-up on conditions and interventions. The Encounter.type.coding attribute is thus the fixed code for “opfølgning”.
It is important in FSIII to be able to express follow-up encounters. In the planning state, these are documented by setting Encounter.status = “planned”, and Encounter.type.coding = “opfølgning”. Encounters which are finished should not be reported hence Encounters with Encounter.status = ‘finished’ should not be reported and can be omitted entirely.
Encounter.class is mandatory in FHIR. In this implementation guide encounter have the fixed code ‘HH’ home health.
Encounter.period.start is mandatory and contains the follow-up date. Note that “time of day” is optional.
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 specificerer hvilke af FHIR-profilens atributter der skal bruges til specifikation af indholdet
FKI-attribut | Definition | FHIR |
---|---|---|
kontaktstatus | Klasse der indikerer om kontakten er igangværende, eller om dokumentationen repræsentere en fremtidig intention eller er historisk | Encounter.status |
kontakttype | Klasse der udtrykker typen af aktivitet der gennemføres ved kontakten | Encounter.type.coding |
kontaktstart | Kontaktens start, eller planlagte start | Encounter.period.start |
kontaktsubjekt | Den borger kontakten vedrører | Encounter.subject |
kontaktklasse | Klasse, der udtrykker en generel kategori for kontakten, som rækker ud over den kommunale kontekst. | Encounter.class |
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 | |
identifier | 0..0 | |||
status | 1..1 | code | [DK] kontaktstatus | |
statusHistory | 0..0 | |||
class | 1..1 | Coding | [DK] kontaktklasse Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HH | |
version | 0..0 | |||
display | 0..0 | |||
userSelected | 0..0 | |||
classHistory | 0..0 | |||
type | 1..1 | CodeableConcept | Specific type of encounter Binding: KLKontaktTyper (required) | |
coding | 1..1 | Coding | [DK] kontakttype Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 9f03dfbb-7a97-45a5-94db-d4c3501714a9 | |
version | 0..0 | |||
display | 0..0 | |||
userSelected | 0..0 | |||
text | 0..0 | |||
serviceType | 0..0 | |||
priority | 0..0 | |||
subject | 1..1 | Reference(CareCitizen) {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 | 0..0 | |||
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 |
Path | Conformance | ValueSet |
Encounter.type | required | KLEncounterTypes |
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 |
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. Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HH | |
type | Σ | 1..1 | CodeableConcept | Specific type of encounter Binding: KLKontaktTyper (required) |
coding | Σ | 1..1 | Coding | [DK] kontakttype Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 9f03dfbb-7a97-45a5-94db-d4c3501714a9 | |
subject | Σ | 1..1 | Reference(CareCitizen) {b} | [DK] kontaktsubjekt |
period | 1..1 | Period | The start and end time of the encounter | |
start | ΣC | 1..1 | dateTime | [DK] kontaktstart |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Encounter.status | required | EncounterStatus |
Encounter.statusHistory.status | required | EncounterStatus |
Encounter.class | extensible | Pattern: HH |
Encounter.classHistory.class | extensible | ActEncounterCode |
Encounter.type | required | KLEncounterTypes |
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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HH | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
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 | Σ | 1..1 | CodeableConcept | Specific type of encounter Binding: KLKontaktTyper (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..1 | Coding | [DK] kontakttype Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 9f03dfbb-7a97-45a5-94db-d4c3501714a9 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
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 | ||||
subject | Σ | 1..1 | Reference(CareCitizen) {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 | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Encounter.language | preferred | CommonLanguages
| ||||
Encounter.status | required | EncounterStatus | ||||
Encounter.statusHistory.status | required | EncounterStatus | ||||
Encounter.class | extensible | Pattern: HH | ||||
Encounter.classHistory.class | extensible | ActEncounterCode | ||||
Encounter.type | required | KLEncounterTypes | ||||
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 |
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
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 | |
identifier | 0..0 | |||
status | 1..1 | code | [DK] kontaktstatus | |
statusHistory | 0..0 | |||
class | 1..1 | Coding | [DK] kontaktklasse Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HH | |
version | 0..0 | |||
display | 0..0 | |||
userSelected | 0..0 | |||
classHistory | 0..0 | |||
type | 1..1 | CodeableConcept | Specific type of encounter Binding: KLKontaktTyper (required) | |
coding | 1..1 | Coding | [DK] kontakttype Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 9f03dfbb-7a97-45a5-94db-d4c3501714a9 | |
version | 0..0 | |||
display | 0..0 | |||
userSelected | 0..0 | |||
text | 0..0 | |||
serviceType | 0..0 | |||
priority | 0..0 | |||
subject | 1..1 | Reference(CareCitizen) {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 | 0..0 | |||
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 |
Path | Conformance | ValueSet |
Encounter.type | required | KLEncounterTypes |
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 |
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. Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HH | |
type | Σ | 1..1 | CodeableConcept | Specific type of encounter Binding: KLKontaktTyper (required) |
coding | Σ | 1..1 | Coding | [DK] kontakttype Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 9f03dfbb-7a97-45a5-94db-d4c3501714a9 | |
subject | Σ | 1..1 | Reference(CareCitizen) {b} | [DK] kontaktsubjekt |
period | 1..1 | Period | The start and end time of the encounter | |
start | ΣC | 1..1 | dateTime | [DK] kontaktstart |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Encounter.status | required | EncounterStatus |
Encounter.statusHistory.status | required | EncounterStatus |
Encounter.class | extensible | Pattern: HH |
Encounter.classHistory.class | extensible | ActEncounterCode |
Encounter.type | required | KLEncounterTypes |
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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HH | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
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 | Σ | 1..1 | CodeableConcept | Specific type of encounter Binding: KLKontaktTyper (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..1 | Coding | [DK] kontakttype Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 9f03dfbb-7a97-45a5-94db-d4c3501714a9 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
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 | ||||
subject | Σ | 1..1 | Reference(CareCitizen) {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 | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Encounter.language | preferred | CommonLanguages
| ||||
Encounter.status | required | EncounterStatus | ||||
Encounter.statusHistory.status | required | EncounterStatus | ||||
Encounter.class | extensible | Pattern: HH | ||||
Encounter.classHistory.class | extensible | ActEncounterCode | ||||
Encounter.type | required | KLEncounterTypes | ||||
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 |
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
Other representations of profile: CSV, Excel, Schematron