Implementation Guide for FFB reporting (FFB uddatasæt)
1.0.0 - release
This page is part of the KLFFBReporting (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/ffbreporting/StructureDefinition/kl-reporting-ffb-followUpEncounter | Version: 1.0.0 | |||
Active as of 2023-08-27 | Computable Name: KLReportingFFBFollowUpEncounter |
Encounter for following up on care plans and interventions
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 | S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Required Pattern: planned |
statusHistory | 0..0 | |||
class | S | 1..1 | Coding | Classification of patient 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 | |
version | 0..0 | |||
display | 0..0 | |||
userSelected | 0..0 | |||
classHistory | 0..0 | |||
type | S | 1..1 | CodeableConcept | Specific type of encounter Binding: KLKontaktTyper (required) |
coding | S | 1..1 | Coding | Code defined by a terminology system 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 | S | 1..1 | Reference(Citizen) {b} | The patient or group present at the encounter |
episodeOfCare | 0..0 | |||
basedOn | 0..0 | |||
participant | 0..0 | |||
appointment | 0..0 | |||
period | S | 1..1 | Period | The start and end time of the encounter |
start | S | 1..1 | dateTime | Starting time with inclusive boundary |
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 | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. Required Pattern: planned |
class | SΣ | 1..1 | Coding | Classification of patient encounter 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 | SΣ | 1..1 | CodeableConcept | Specific type of encounter Binding: KLKontaktTyper (required) |
coding | SΣ | 1..1 | Coding | Code defined by a terminology system 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 | SΣ | 1..1 | Reference(Citizen) {b} | The patient or group present at the encounter |
period | S | 1..1 | Period | The start and end time of the encounter |
start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Encounter.status | required | Pattern: planned |
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 | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. Required Pattern: planned | ||||
class | SΣ | 1..1 | Coding | Classification of patient encounter 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 | SΣ | 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 | SΣ | 1..1 | Coding | Code defined by a terminology system 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 | SΣ | 1..1 | Reference(Citizen) {b} | The patient or group present at the encounter | ||||
period | S | 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 | SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Encounter.language | preferred | CommonLanguages
| ||||
Encounter.status | required | Pattern: planned | ||||
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 |
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
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 | S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Required Pattern: planned |
statusHistory | 0..0 | |||
class | S | 1..1 | Coding | Classification of patient 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 | |
version | 0..0 | |||
display | 0..0 | |||
userSelected | 0..0 | |||
classHistory | 0..0 | |||
type | S | 1..1 | CodeableConcept | Specific type of encounter Binding: KLKontaktTyper (required) |
coding | S | 1..1 | Coding | Code defined by a terminology system 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 | S | 1..1 | Reference(Citizen) {b} | The patient or group present at the encounter |
episodeOfCare | 0..0 | |||
basedOn | 0..0 | |||
participant | 0..0 | |||
appointment | 0..0 | |||
period | S | 1..1 | Period | The start and end time of the encounter |
start | S | 1..1 | dateTime | Starting time with inclusive boundary |
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 | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. Required Pattern: planned |
class | SΣ | 1..1 | Coding | Classification of patient encounter 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 | SΣ | 1..1 | CodeableConcept | Specific type of encounter Binding: KLKontaktTyper (required) |
coding | SΣ | 1..1 | Coding | Code defined by a terminology system 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 | SΣ | 1..1 | Reference(Citizen) {b} | The patient or group present at the encounter |
period | S | 1..1 | Period | The start and end time of the encounter |
start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Encounter.status | required | Pattern: planned |
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 | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. Required Pattern: planned | ||||
class | SΣ | 1..1 | Coding | Classification of patient encounter 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 | SΣ | 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 | SΣ | 1..1 | Coding | Code defined by a terminology system 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 | SΣ | 1..1 | Reference(Citizen) {b} | The patient or group present at the encounter | ||||
period | S | 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 | SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Encounter.language | preferred | CommonLanguages
| ||||
Encounter.status | required | Pattern: planned | ||||
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 |
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
Other representations of profile: CSV, Excel, Schematron