Implementation Guide for FFB messaging (FFB udvekslingsdatasæt)
1.0.0 - release Denmark flag

This page is part of the KLFFBMessaging (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: Intervention

Official URL: http://fhir.kl.dk/ffbmessaging/StructureDefinition/kl-messaging-ffb-intervention Version: 1.0.0
Active as of 2023-08-27 Computable Name: KLMessagingFFBIntervention

Intervention in a ordered care plan

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from KLCommonCareSocialPlannedIntervention

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*KLCommonCareSocialPlannedInterventionHealthcare plan for patient or group
... basedOn S1..*Reference(OrderCarePlan)[DK] indsatsDelAfPlan
... status S1..1code[DK] indsatsstatus
... intent S1..1code[DK] indsatshensigt
... period S0..1PeriodTime period plan covers
... created S1..1dateTime[DK] indsatsoprettelsestid
... activity S1..1BackboneElementAction to occur as part of plan
.... detail S1..1BackboneElementIn-line definition of activity
..... code S1..1CodeableConceptDetail type of activity
...... coding:FFBintervention S0..1CodingCode defined by a terminology system
Binding: KLYdelserFFB (required)
..... status S1..1code[DK] indsatsAktivitetsstatus

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
CarePlan.activity.detail.code.coding:FFBinterventionrequiredKLInterventionsFFB
NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*KLCommonCareSocialPlannedInterventionHealthcare plan for patient or group
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... followUpEncounter 0..1Reference(Encounter)[DK] indsatsPlanlagtOpfølgning
URL: http://fhir.kl.dk/core/StructureDefinition/FollowUpEncounter
... relevantHistory 0..*Reference(Provenance)[DK] indsatsændringshistorie
URL: http://hl7.org/fhir/StructureDefinition/request-relevantHistory
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... basedOn SΣ1..*Reference(OrderCarePlan)[DK] indsatsDelAfPlan
... status ?!SΣ1..1code[DK] indsatsstatus
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

... intent ?!SΣ1..1code[DK] indsatshensigt
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... subject SΣ1..1Reference(Citizen)[DK] indsatssubjekt
... period SΣ0..1PeriodTime period plan covers
... created SΣ1..1dateTime[DK] indsatsoprettelsestid
... activity SC1..1BackboneElementAction to occur as part of plan
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... detail SC1..1BackboneElementIn-line definition of activity
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1CodeableConceptDetail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

...... Slices for coding Σ0..*Coding[DK] indsatsskode
Slice: Unordered, Open by value:system
....... coding:FFBintervention SΣ0..1CodingCode defined by a terminology system
Binding: KLYdelserFFB (required)
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: urn:oid:1.2.208.176.2.22
....... coding:FSIIIlevel2 Σ0..1CodingCode defined by a terminology system
Binding: KLIndsatserFSIII (required)
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: urn:oid:1.2.208.176.2.21
....... coding:FSIIIlevel3 Σ0..1CodingCode defined by a terminology system
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: http://kl.dk/fhir/common/caresocial/CodeSystem/KLCommonproprietary
........ code Σ1..1codeSymbol in syntax defined by the system
........ display Σ1..1stringRepresentation defined by the system
....... coding:KLECode Σ0..1CodingCode defined by a terminology system
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: https://data.gov.dk/id/classification/KLE
..... status ?!S1..1code[DK] indsatsAktivitetsstatus
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.

..... doNotPerform ?!0..1booleanIf true, activity is prohibiting action

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CarePlan.statusrequiredRequestStatus
CarePlan.intentrequiredCarePlanIntent
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
CarePlan.activity.detail.code.coding:FFBinterventionrequiredKLInterventionsFFB
CarePlan.activity.detail.code.coding:FSIIIlevel2requiredKLInterventionsFSIII
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus

Constraints

IdGradePath(s)DetailsRequirements
cpl-3errorCarePlan.activityProvide a reference or detail, not both
: detail.empty() or reference.empty()
dom-2errorCarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCarePlanIf 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-4errorCarePlanIf 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-5errorCarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCarePlanA 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
.. CarePlan 0..*KLCommonCareSocialPlannedInterventionHealthcare plan for patient or group
... 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... followUpEncounter 0..1Reference(Encounter)[DK] indsatsPlanlagtOpfølgning
URL: http://fhir.kl.dk/core/StructureDefinition/FollowUpEncounter
... relevantHistory 0..*Reference(Provenance)[DK] indsatsændringshistorie
URL: http://hl7.org/fhir/StructureDefinition/request-relevantHistory
... municipalityCaseNumber 0..1(Complex)[DK] anledningDokumenteretISag
URL: http://fhir.kl.dk/core/StructureDefinition/MunicipalityCaseNumber
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this plan
... instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn SΣ1..*Reference(OrderCarePlan)[DK] indsatsDelAfPlan
... replaces Σ0..*Reference(CarePlan)CarePlan replaced by this CarePlan
... partOf Σ0..*Reference(CarePlan)Part of referenced CarePlan
... status ?!SΣ1..1code[DK] indsatsstatus
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

... intent ?!SΣ1..1code[DK] indsatshensigt
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... category Σ0..*CodeableConceptType of plan
Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.


... title Σ0..1stringHuman-friendly name for the care plan
... description Σ0..1stringSummary of nature of plan
... subject SΣ1..1Reference(Citizen)[DK] indsatssubjekt
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... period SΣ0..1PeriodTime period plan covers
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC0..1dateTime[DK] indsatsbevillingstid
.... end ΣC0..1dateTime[DK] indsatsafslutningstid
... created SΣ1..1dateTime[DK] indsatsoprettelsestid
... author Σ0..1Reference(Organization)[DK] indsatsansvarlig
... contributor 0..*Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who provided the content of the care plan
... careTeam 0..*Reference(CareTeam)Who's involved in plan?
... addresses Σ0..*Reference(Condition)Health issues this plan addresses
... supportingInfo 0..*Reference(Resource)Information considered as part of plan
... goal 0..*Reference(Goal)Desired outcome of plan
... activity SC1..1BackboneElementAction to occur as part of plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... outcomeCodeableConcept 0..*CodeableConceptResults of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.


.... outcomeReference 0..*Reference(Encounter)[DK] indsatsgennemførtAktivitet
.... progress 0..*AnnotationComments about the activity status/progress
.... reference C0..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup)Activity details defined in specific resource
.... detail SC1..1BackboneElementIn-line definition of activity
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 0..1codeAppointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.

..... instantiatesCanonical 0..*canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)Instantiates FHIR protocol or definition
..... instantiatesUri 0..*uriInstantiates external protocol or definition
..... code S1..1CodeableConceptDetail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for coding Σ0..*Coding[DK] indsatsskode
Slice: Unordered, Open by value:system
....... coding:FFBintervention SΣ0..1CodingCode defined by a terminology system
Binding: KLYdelserFFB (required)
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: urn:oid:1.2.208.176.2.22
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ0..1codeSymbol in syntax defined by the system
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... coding:FSIIIlevel2 Σ0..1CodingCode defined by a terminology system
Binding: KLIndsatserFSIII (required)
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: urn:oid:1.2.208.176.2.21
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ0..1codeSymbol in syntax defined by the system
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... coding:FSIIIlevel3 Σ0..1CodingCode defined by a terminology system
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: http://kl.dk/fhir/common/caresocial/CodeSystem/KLCommonproprietary
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ1..1codeSymbol in syntax defined by the system
........ display Σ1..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... coding:KLECode Σ0..1CodingCode defined by a terminology system
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: https://data.gov.dk/id/classification/KLE
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ0..1codeSymbol in syntax defined by the system
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... reasonCode 0..*CodeableConceptWhy activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.


..... reasonReference 0..*Reference(Condition)[DK] indsatsbegrundelse
..... goal 0..*Reference(Goal)[DK] indsatsmål
..... status ?!S1..1code[DK] indsatsAktivitetsstatus
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.

..... statusReason 0..1CodeableConceptReason for current status
..... doNotPerform ?!0..1booleanIf true, activity is prohibiting action
..... scheduled[x] 0..1When activity is to occur
...... scheduledTimingTiming
...... scheduledPeriodPeriod
...... scheduledStringstring
..... location 0..1Reference(Location)Where it should happen
..... performer 0..*Reference(Organization)[DK] indsatsleverandør
..... product[x] 0..1What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.

...... productCodeableConceptCodeableConcept
...... productReferenceReference(Medication | Substance)
..... dailyAmount 0..1SimpleQuantityHow to consume/day?
..... quantity 0..1SimpleQuantityHow much to administer/supply/consume
..... description 0..1string[DK] handlingsanvisning
... note 0..*AnnotationComments about the plan

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CarePlan.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
CarePlan.statusrequiredRequestStatus
CarePlan.intentrequiredCarePlanIntent
CarePlan.categoryexampleCarePlanCategory
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
CarePlan.activity.detail.code.coding:FFBinterventionrequiredKLInterventionsFFB
CarePlan.activity.detail.code.coding:FSIIIlevel2requiredKLInterventionsFSIII
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes

Constraints

IdGradePath(s)DetailsRequirements
cpl-3errorCarePlan.activityProvide a reference or detail, not both
: detail.empty() or reference.empty()
dom-2errorCarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCarePlanIf 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-4errorCarePlanIf 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-5errorCarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCarePlanA 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 KLCommonCareSocialPlannedIntervention

Differential View

This structure is derived from KLCommonCareSocialPlannedIntervention

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*KLCommonCareSocialPlannedInterventionHealthcare plan for patient or group
... basedOn S1..*Reference(OrderCarePlan)[DK] indsatsDelAfPlan
... status S1..1code[DK] indsatsstatus
... intent S1..1code[DK] indsatshensigt
... period S0..1PeriodTime period plan covers
... created S1..1dateTime[DK] indsatsoprettelsestid
... activity S1..1BackboneElementAction to occur as part of plan
.... detail S1..1BackboneElementIn-line definition of activity
..... code S1..1CodeableConceptDetail type of activity
...... coding:FFBintervention S0..1CodingCode defined by a terminology system
Binding: KLYdelserFFB (required)
..... status S1..1code[DK] indsatsAktivitetsstatus

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
CarePlan.activity.detail.code.coding:FFBinterventionrequiredKLInterventionsFFB

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*KLCommonCareSocialPlannedInterventionHealthcare plan for patient or group
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... followUpEncounter 0..1Reference(Encounter)[DK] indsatsPlanlagtOpfølgning
URL: http://fhir.kl.dk/core/StructureDefinition/FollowUpEncounter
... relevantHistory 0..*Reference(Provenance)[DK] indsatsændringshistorie
URL: http://hl7.org/fhir/StructureDefinition/request-relevantHistory
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... basedOn SΣ1..*Reference(OrderCarePlan)[DK] indsatsDelAfPlan
... status ?!SΣ1..1code[DK] indsatsstatus
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

... intent ?!SΣ1..1code[DK] indsatshensigt
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... subject SΣ1..1Reference(Citizen)[DK] indsatssubjekt
... period SΣ0..1PeriodTime period plan covers
... created SΣ1..1dateTime[DK] indsatsoprettelsestid
... activity SC1..1BackboneElementAction to occur as part of plan
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... detail SC1..1BackboneElementIn-line definition of activity
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1CodeableConceptDetail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

...... Slices for coding Σ0..*Coding[DK] indsatsskode
Slice: Unordered, Open by value:system
....... coding:FFBintervention SΣ0..1CodingCode defined by a terminology system
Binding: KLYdelserFFB (required)
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: urn:oid:1.2.208.176.2.22
....... coding:FSIIIlevel2 Σ0..1CodingCode defined by a terminology system
Binding: KLIndsatserFSIII (required)
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: urn:oid:1.2.208.176.2.21
....... coding:FSIIIlevel3 Σ0..1CodingCode defined by a terminology system
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: http://kl.dk/fhir/common/caresocial/CodeSystem/KLCommonproprietary
........ code Σ1..1codeSymbol in syntax defined by the system
........ display Σ1..1stringRepresentation defined by the system
....... coding:KLECode Σ0..1CodingCode defined by a terminology system
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: https://data.gov.dk/id/classification/KLE
..... status ?!S1..1code[DK] indsatsAktivitetsstatus
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.

..... doNotPerform ?!0..1booleanIf true, activity is prohibiting action

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CarePlan.statusrequiredRequestStatus
CarePlan.intentrequiredCarePlanIntent
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
CarePlan.activity.detail.code.coding:FFBinterventionrequiredKLInterventionsFFB
CarePlan.activity.detail.code.coding:FSIIIlevel2requiredKLInterventionsFSIII
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus

Constraints

IdGradePath(s)DetailsRequirements
cpl-3errorCarePlan.activityProvide a reference or detail, not both
: detail.empty() or reference.empty()
dom-2errorCarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCarePlanIf 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-4errorCarePlanIf 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-5errorCarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCarePlanA 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
.. CarePlan 0..*KLCommonCareSocialPlannedInterventionHealthcare plan for patient or group
... 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... followUpEncounter 0..1Reference(Encounter)[DK] indsatsPlanlagtOpfølgning
URL: http://fhir.kl.dk/core/StructureDefinition/FollowUpEncounter
... relevantHistory 0..*Reference(Provenance)[DK] indsatsændringshistorie
URL: http://hl7.org/fhir/StructureDefinition/request-relevantHistory
... municipalityCaseNumber 0..1(Complex)[DK] anledningDokumenteretISag
URL: http://fhir.kl.dk/core/StructureDefinition/MunicipalityCaseNumber
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this plan
... instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn SΣ1..*Reference(OrderCarePlan)[DK] indsatsDelAfPlan
... replaces Σ0..*Reference(CarePlan)CarePlan replaced by this CarePlan
... partOf Σ0..*Reference(CarePlan)Part of referenced CarePlan
... status ?!SΣ1..1code[DK] indsatsstatus
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

... intent ?!SΣ1..1code[DK] indsatshensigt
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... category Σ0..*CodeableConceptType of plan
Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.


... title Σ0..1stringHuman-friendly name for the care plan
... description Σ0..1stringSummary of nature of plan
... subject SΣ1..1Reference(Citizen)[DK] indsatssubjekt
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... period SΣ0..1PeriodTime period plan covers
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC0..1dateTime[DK] indsatsbevillingstid
.... end ΣC0..1dateTime[DK] indsatsafslutningstid
... created SΣ1..1dateTime[DK] indsatsoprettelsestid
... author Σ0..1Reference(Organization)[DK] indsatsansvarlig
... contributor 0..*Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who provided the content of the care plan
... careTeam 0..*Reference(CareTeam)Who's involved in plan?
... addresses Σ0..*Reference(Condition)Health issues this plan addresses
... supportingInfo 0..*Reference(Resource)Information considered as part of plan
... goal 0..*Reference(Goal)Desired outcome of plan
... activity SC1..1BackboneElementAction to occur as part of plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... outcomeCodeableConcept 0..*CodeableConceptResults of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.


.... outcomeReference 0..*Reference(Encounter)[DK] indsatsgennemførtAktivitet
.... progress 0..*AnnotationComments about the activity status/progress
.... reference C0..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup)Activity details defined in specific resource
.... detail SC1..1BackboneElementIn-line definition of activity
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 0..1codeAppointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.

..... instantiatesCanonical 0..*canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)Instantiates FHIR protocol or definition
..... instantiatesUri 0..*uriInstantiates external protocol or definition
..... code S1..1CodeableConceptDetail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for coding Σ0..*Coding[DK] indsatsskode
Slice: Unordered, Open by value:system
....... coding:FFBintervention SΣ0..1CodingCode defined by a terminology system
Binding: KLYdelserFFB (required)
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: urn:oid:1.2.208.176.2.22
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ0..1codeSymbol in syntax defined by the system
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... coding:FSIIIlevel2 Σ0..1CodingCode defined by a terminology system
Binding: KLIndsatserFSIII (required)
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: urn:oid:1.2.208.176.2.21
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ0..1codeSymbol in syntax defined by the system
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... coding:FSIIIlevel3 Σ0..1CodingCode defined by a terminology system
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: http://kl.dk/fhir/common/caresocial/CodeSystem/KLCommonproprietary
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ1..1codeSymbol in syntax defined by the system
........ display Σ1..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... coding:KLECode Σ0..1CodingCode defined by a terminology system
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ1..1uriIdentity of the terminology system
Required Pattern: https://data.gov.dk/id/classification/KLE
........ version Σ0..1stringVersion of the system - if relevant
........ code Σ0..1codeSymbol in syntax defined by the system
........ display Σ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... reasonCode 0..*CodeableConceptWhy activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.


..... reasonReference 0..*Reference(Condition)[DK] indsatsbegrundelse
..... goal 0..*Reference(Goal)[DK] indsatsmål
..... status ?!S1..1code[DK] indsatsAktivitetsstatus
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.

..... statusReason 0..1CodeableConceptReason for current status
..... doNotPerform ?!0..1booleanIf true, activity is prohibiting action
..... scheduled[x] 0..1When activity is to occur
...... scheduledTimingTiming
...... scheduledPeriodPeriod
...... scheduledStringstring
..... location 0..1Reference(Location)Where it should happen
..... performer 0..*Reference(Organization)[DK] indsatsleverandør
..... product[x] 0..1What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.

...... productCodeableConceptCodeableConcept
...... productReferenceReference(Medication | Substance)
..... dailyAmount 0..1SimpleQuantityHow to consume/day?
..... quantity 0..1SimpleQuantityHow much to administer/supply/consume
..... description 0..1string[DK] handlingsanvisning
... note 0..*AnnotationComments about the plan

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CarePlan.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
CarePlan.statusrequiredRequestStatus
CarePlan.intentrequiredCarePlanIntent
CarePlan.categoryexampleCarePlanCategory
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
CarePlan.activity.detail.code.coding:FFBinterventionrequiredKLInterventionsFFB
CarePlan.activity.detail.code.coding:FSIIIlevel2requiredKLInterventionsFSIII
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes

Constraints

IdGradePath(s)DetailsRequirements
cpl-3errorCarePlan.activityProvide a reference or detail, not both
: detail.empty() or reference.empty()
dom-2errorCarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCarePlanIf 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-4errorCarePlanIf 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-5errorCarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCarePlanA 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 KLCommonCareSocialPlannedIntervention

 

Other representations of profile: CSV, Excel, Schematron