Implementation Guide for FFB reporting (FFB uddatasæt)
1.0.0 - release Denmark flag

This page is part of the KLFFBReporting (v1.0.0: Release) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: FollowUpEncounter

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:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncounterAn interaction during which services are provided to the patient
... identifier 0..0
... status S1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Required Pattern: planned
... statusHistory 0..0
.... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: HH
.... version 0..0
.... display 0..0
.... userSelected 0..0
... classHistory 0..0
... type S1..1CodeableConceptSpecific type of encounter
Binding: KLKontaktTyper (required)
.... coding S1..1CodingCode defined by a terminology system
Required Pattern: At least the following
..... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes
..... code1..1codeSymbol 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 S1..1Reference(Citizen) {b}The patient or group present at the encounter
... episodeOfCare 0..0
... basedOn 0..0
... participant 0..0
... appointment 0..0
... period S1..1PeriodThe start and end time of the encounter
.... start S1..1dateTimeStarting 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Encounter.typerequiredKLEncounterTypes
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncounterAn interaction during which services are provided to the patient
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.


Required Pattern: planned
.... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: HH
... type SΣ1..1CodeableConceptSpecific type of encounter
Binding: KLKontaktTyper (required)
.... coding SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
..... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 9f03dfbb-7a97-45a5-94db-d4c3501714a9
... subject SΣ1..1Reference(Citizen) {b}The patient or group present at the encounter
... period S1..1PeriodThe start and end time of the encounter
.... start SΣC1..1dateTimeStarting time with inclusive boundary

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Encounter.statusrequiredPattern: planned
Encounter.statusHistory.statusrequiredEncounterStatus
Encounter.classextensiblePattern: HH
Encounter.classHistory.classextensibleActEncounterCode
Encounter.typerequiredKLEncounterTypes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncounterAn interaction during which services are provided to the patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.


Required Pattern: planned
... class SΣ1..1CodingClassification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
.... version0..1stringVersion of the system - if relevant
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: HH
.... display0..1stringRepresentation defined by the system
.... userSelected0..1booleanIf this coding was chosen directly by the user
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ0..1uriIdentity of the terminology system
.... code Σ0..1codeSymbol in syntax defined by the system
... type SΣ1..1CodeableConceptSpecific type of encounter
Binding: KLKontaktTyper (required)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 9f03dfbb-7a97-45a5-94db-d4c3501714a9
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the terminology system
..... code Σ0..1codeSymbol in syntax defined by the system
... subject SΣ1..1Reference(Citizen) {b}The patient or group present at the encounter
... period S1..1PeriodThe start and end time of the encounter
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC1..1dateTimeStarting time with inclusive boundary

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Encounter.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.statusrequiredPattern: planned
Encounter.statusHistory.statusrequiredEncounterStatus
Encounter.classextensiblePattern: HH
Encounter.classHistory.classextensibleActEncounterCode
Encounter.typerequiredKLEncounterTypes
Encounter.participant.typeextensibleParticipantType
Encounter.diagnosis.usepreferredDiagnosisRole
Encounter.hospitalization.admitSourcepreferredAdmitSource
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
Encounter.hospitalization.dietPreferenceexampleDiet
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
Encounter.hospitalization.dischargeDispositionexampleDischargeDisposition
Encounter.location.statusrequiredEncounterLocationStatus
Encounter.location.physicalTypeexampleLocationType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Encounter

Summary

Mandatory: 5 elements
Must-Support: 7 elements
Prohibited: 26 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncounterAn interaction during which services are provided to the patient
... identifier 0..0
... status S1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Required Pattern: planned
... statusHistory 0..0
.... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: HH
.... version 0..0
.... display 0..0
.... userSelected 0..0
... classHistory 0..0
... type S1..1CodeableConceptSpecific type of encounter
Binding: KLKontaktTyper (required)
.... coding S1..1CodingCode defined by a terminology system
Required Pattern: At least the following
..... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes
..... code1..1codeSymbol 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 S1..1Reference(Citizen) {b}The patient or group present at the encounter
... episodeOfCare 0..0
... basedOn 0..0
... participant 0..0
... appointment 0..0
... period S1..1PeriodThe start and end time of the encounter
.... start S1..1dateTimeStarting 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Encounter.typerequiredKLEncounterTypes

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncounterAn interaction during which services are provided to the patient
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.


Required Pattern: planned
.... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: HH
... type SΣ1..1CodeableConceptSpecific type of encounter
Binding: KLKontaktTyper (required)
.... coding SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
..... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 9f03dfbb-7a97-45a5-94db-d4c3501714a9
... subject SΣ1..1Reference(Citizen) {b}The patient or group present at the encounter
... period S1..1PeriodThe start and end time of the encounter
.... start SΣC1..1dateTimeStarting time with inclusive boundary

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Encounter.statusrequiredPattern: planned
Encounter.statusHistory.statusrequiredEncounterStatus
Encounter.classextensiblePattern: HH
Encounter.classHistory.classextensibleActEncounterCode
Encounter.typerequiredKLEncounterTypes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*EncounterAn interaction during which services are provided to the patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.


Required Pattern: planned
... class SΣ1..1CodingClassification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
.... version0..1stringVersion of the system - if relevant
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: HH
.... display0..1stringRepresentation defined by the system
.... userSelected0..1booleanIf this coding was chosen directly by the user
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ0..1uriIdentity of the terminology system
.... code Σ0..1codeSymbol in syntax defined by the system
... type SΣ1..1CodeableConceptSpecific type of encounter
Binding: KLKontaktTyper (required)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 9f03dfbb-7a97-45a5-94db-d4c3501714a9
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the terminology system
..... code Σ0..1codeSymbol in syntax defined by the system
... subject SΣ1..1Reference(Citizen) {b}The patient or group present at the encounter
... period S1..1PeriodThe start and end time of the encounter
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC1..1dateTimeStarting time with inclusive boundary

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Encounter.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.statusrequiredPattern: planned
Encounter.statusHistory.statusrequiredEncounterStatus
Encounter.classextensiblePattern: HH
Encounter.classHistory.classextensibleActEncounterCode
Encounter.typerequiredKLEncounterTypes
Encounter.participant.typeextensibleParticipantType
Encounter.diagnosis.usepreferredDiagnosisRole
Encounter.hospitalization.admitSourcepreferredAdmitSource
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
Encounter.hospitalization.dietPreferenceexampleDiet
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
Encounter.hospitalization.dischargeDispositionexampleDischargeDisposition
Encounter.location.statusrequiredEncounterLocationStatus
Encounter.location.physicalTypeexampleLocationType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Encounter

Summary

Mandatory: 5 elements
Must-Support: 7 elements
Prohibited: 26 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron