1.2.0 - release

KLGateway, published by KL. This guide is not an authorized publication; it is the continuous build for version 1.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7dk/kl-gateway/ and changes regularly. See the Directory of published versions

Resource Profile: CareCompletedIntervention

Official URL: http://fhir.kl.dk/gateway/StructureDefinition/klgateway-care-completed-intervention Version: 1.2.0
Active as of 2024-10-31 Computable Name: KLGatewayCareCompletedIntervention

Documentation for completed interventions (activities related to one and only one encounter) in Danish municipalities

Scope and usage

In a Danish municipality setting, CompletedIntervention is used to describe what activities has been delivered (e.g. a visit from a nurse to a citizen home where wound care is delivered). A CompletedIntervention always describes actual activities of one encounter. It should not be confused with PlannedIntervention, which describes the intention of activities, typically for several encounters.

In this implementation guide it is only used for interventions delivered acute or otherwise not planned at the time of delivery.

Procedure.subject references the citizen. Procedure.code.coding holds the intervention code from FSIII of the intervention that should be carried out. Start-time is documented in Procedure.performedDateTime. They are all mandatory.

It is optional to document the Condition which is the reason for delivering the CompletedIntervention. If it is present, register it in Procedure.reasonReference. The Encounter where the CompletedIntervention took place, can be referenced in Procedure.encounter. This is also optional.

Procedure.status holds a mandatory status attribute, use only values "completed" and "entered-in-error".

Conversions between Danish information model and FHIR-profile

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
leveretIndsatsSubjekt Den borger som indsatsen er leveret til. Procedure.subject
leveretIndsatsKode Klasse, der udtrykker hvad den leverede indsats omhandler. Procedure.code.coding
leveretIndsatsStart Starttidspunkt for levering af indsatsen. Procedure.performedDateTime
leveretIndsatsbegrundelse Tilstand som indsatsen rettes mod Procedure.reasonReference
leveretIndsatsKontakt Den kontakt hvor indsatsen leveres Procedure.encounter
leveretIndsatsstatus Indikation af hvor i det kliniske forløb indsatsen er. Procedure.status

Usage:

Formal Views of Profile Content

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

This structure is derived from Procedure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..* Procedure An action that is being or was performed on a patient
... identifier 0..0
... instantiatesCanonical 0..0
... instantiatesUri 0..0
... basedOn 0..0
... partOf 0..0
... status 1..1 code [DK] leveretIndsatsstatus (completed | entered-in-error)
... statusReason 0..0
... category 0..0
... code 1..1 CodeableConcept Identification of the procedure
.... Slices for coding 1..* Coding [DK] leveretIndsatsKode
Slice: Unordered, Closed by value:system
..... coding:level2 1..1 Coding Code defined by a terminology system
Binding: FSIIICareInterventions (required)
...... system 1..1 uri Identity of the terminology system
Required Pattern: urn:oid:1.2.208.176.2.21
..... coding:level3 S 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.kl.dk/gateway/CodeSystem/LocallyDefinedInterventions
...... code 1..1 code Symbol in syntax defined by the system
...... display 1..1 string Representation defined by the system
... subject 1..1 Reference(CareCitizen) {b} [DK] leveretIndsatsSubjekt
... encounter 0..0
... performed[x] 1..1 dateTime [DK] leveretIndsatsStart
... recorder 0..0
... asserter 0..0
... performer 0..0
... location 0..0
... reasonCode 0..0
... reasonReference S 0..* Reference(CareCondition) {b} [DK] leveretIndsatsbegrundelse
... bodySite 0..0
... outcome 0..0
... report 0..0
... complication 0..0
... complicationDetail 0..0
... followUp 0..0
... note 0..0
... focalDevice 0..0
... usedReference 0..0
... usedCode 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Procedure.code.coding:level2requiredFSIIICareInterventions
http://fhir.kl.dk/gateway/ValueSet/FSIIICareInterventions
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..* Procedure An action that is being or was performed on a 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] leveretIndsatsstatus (completed | entered-in-error)
Binding: EventStatus (required): A code specifying the state of the procedure.

.... Slices for coding Σ 1..* Coding [DK] leveretIndsatsKode
Slice: Unordered, Closed by value:system
..... coding:level2 Σ 1..1 Coding Code defined by a terminology system
Binding: FSIIICareInterventions (required)
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: urn:oid:1.2.208.176.2.21
..... coding:level3 SΣ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.kl.dk/gateway/CodeSystem/LocallyDefinedInterventions
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 1..1 string Representation defined by the system
... subject Σ 1..1 Reference(CareCitizen) {b} [DK] leveretIndsatsSubjekt
... performed[x] Σ 1..1 dateTime [DK] leveretIndsatsStart
... reasonReference SΣ 0..* Reference(CareCondition) {b} [DK] leveretIndsatsbegrundelse

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard
Procedure.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
Procedure.code.coding:level2requiredFSIIICareInterventions
http://fhir.kl.dk/gateway/ValueSet/FSIIICareInterventions
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProcedureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProcedureIf 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-4errorProcedureIf 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-5errorProcedureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProcedureA 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
.. Procedure 0..* Procedure An action that is being or was performed on a 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
... 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] leveretIndsatsstatus (completed | entered-in-error)
Binding: EventStatus (required): A code specifying the state of the procedure.

... code Σ 1..1 CodeableConcept Identification of the procedure
Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure .

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding [DK] leveretIndsatsKode
Slice: Unordered, Closed by value:system
..... coding:level2 Σ 1..1 Coding Code defined by a terminology system
Binding: FSIIICareInterventions (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
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: urn:oid:1.2.208.176.2.21
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:level3 SΣ 0..1 Coding Code defined by a terminology system
...... 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 Σ 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.kl.dk/gateway/CodeSystem/LocallyDefinedInterventions
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(CareCitizen) {b} [DK] leveretIndsatsSubjekt
... performed[x] Σ 1..1 dateTime [DK] leveretIndsatsStart
... reasonReference SΣ 0..* Reference(CareCondition) {b} [DK] leveretIndsatsbegrundelse

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard
Procedure.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
Procedure.code.coding:level2requiredFSIIICareInterventions
http://fhir.kl.dk/gateway/ValueSet/FSIIICareInterventions
from this IG
Procedure.performer.functionexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
Procedure.focalDevice.actionpreferredProcedureDeviceActionCodes
http://hl7.org/fhir/ValueSet/device-action
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProcedureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProcedureIf 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-4errorProcedureIf 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-5errorProcedureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProcedureA 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 Procedure

Summary

Mandatory: 5 elements(3 nested mandatory elements)
Must-Support: 2 elements
Prohibited: 23 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Procedure.code.coding (Closed)

Differential View

This structure is derived from Procedure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..* Procedure An action that is being or was performed on a patient
... identifier 0..0
... instantiatesCanonical 0..0
... instantiatesUri 0..0
... basedOn 0..0
... partOf 0..0
... status 1..1 code [DK] leveretIndsatsstatus (completed | entered-in-error)
... statusReason 0..0
... category 0..0
... code 1..1 CodeableConcept Identification of the procedure
.... Slices for coding 1..* Coding [DK] leveretIndsatsKode
Slice: Unordered, Closed by value:system
..... coding:level2 1..1 Coding Code defined by a terminology system
Binding: FSIIICareInterventions (required)
...... system 1..1 uri Identity of the terminology system
Required Pattern: urn:oid:1.2.208.176.2.21
..... coding:level3 S 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.kl.dk/gateway/CodeSystem/LocallyDefinedInterventions
...... code 1..1 code Symbol in syntax defined by the system
...... display 1..1 string Representation defined by the system
... subject 1..1 Reference(CareCitizen) {b} [DK] leveretIndsatsSubjekt
... encounter 0..0
... performed[x] 1..1 dateTime [DK] leveretIndsatsStart
... recorder 0..0
... asserter 0..0
... performer 0..0
... location 0..0
... reasonCode 0..0
... reasonReference S 0..* Reference(CareCondition) {b} [DK] leveretIndsatsbegrundelse
... bodySite 0..0
... outcome 0..0
... report 0..0
... complication 0..0
... complicationDetail 0..0
... followUp 0..0
... note 0..0
... focalDevice 0..0
... usedReference 0..0
... usedCode 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Procedure.code.coding:level2requiredFSIIICareInterventions
http://fhir.kl.dk/gateway/ValueSet/FSIIICareInterventions
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..* Procedure An action that is being or was performed on a 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] leveretIndsatsstatus (completed | entered-in-error)
Binding: EventStatus (required): A code specifying the state of the procedure.

.... Slices for coding Σ 1..* Coding [DK] leveretIndsatsKode
Slice: Unordered, Closed by value:system
..... coding:level2 Σ 1..1 Coding Code defined by a terminology system
Binding: FSIIICareInterventions (required)
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: urn:oid:1.2.208.176.2.21
..... coding:level3 SΣ 0..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.kl.dk/gateway/CodeSystem/LocallyDefinedInterventions
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 1..1 string Representation defined by the system
... subject Σ 1..1 Reference(CareCitizen) {b} [DK] leveretIndsatsSubjekt
... performed[x] Σ 1..1 dateTime [DK] leveretIndsatsStart
... reasonReference SΣ 0..* Reference(CareCondition) {b} [DK] leveretIndsatsbegrundelse

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard
Procedure.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
Procedure.code.coding:level2requiredFSIIICareInterventions
http://fhir.kl.dk/gateway/ValueSet/FSIIICareInterventions
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProcedureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProcedureIf 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-4errorProcedureIf 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-5errorProcedureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProcedureA 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
.. Procedure 0..* Procedure An action that is being or was performed on a 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
... 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] leveretIndsatsstatus (completed | entered-in-error)
Binding: EventStatus (required): A code specifying the state of the procedure.

... code Σ 1..1 CodeableConcept Identification of the procedure
Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure .

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding [DK] leveretIndsatsKode
Slice: Unordered, Closed by value:system
..... coding:level2 Σ 1..1 Coding Code defined by a terminology system
Binding: FSIIICareInterventions (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
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: urn:oid:1.2.208.176.2.21
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:level3 SΣ 0..1 Coding Code defined by a terminology system
...... 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 Σ 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.kl.dk/gateway/CodeSystem/LocallyDefinedInterventions
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(CareCitizen) {b} [DK] leveretIndsatsSubjekt
... performed[x] Σ 1..1 dateTime [DK] leveretIndsatsStart
... reasonReference SΣ 0..* Reference(CareCondition) {b} [DK] leveretIndsatsbegrundelse

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Procedure.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Procedure.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard
Procedure.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
Procedure.code.coding:level2requiredFSIIICareInterventions
http://fhir.kl.dk/gateway/ValueSet/FSIIICareInterventions
from this IG
Procedure.performer.functionexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
Procedure.focalDevice.actionpreferredProcedureDeviceActionCodes
http://hl7.org/fhir/ValueSet/device-action
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProcedureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProcedureIf 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-4errorProcedureIf 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-5errorProcedureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProcedureA 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 Procedure

Summary

Mandatory: 5 elements(3 nested mandatory elements)
Must-Support: 2 elements
Prohibited: 23 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Procedure.code.coding (Closed)

 

Other representations of profile: CSV, Excel, Schematron