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: OrderCarePlan

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

FFB care plan being ordered

Usage:

Formal Views of Profile Content

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

This structure is derived from KLCommonCareSocialCarePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*KLCommonCareSocialCarePlanHealthcare plan for patient or group
... subjectActingMunicipality S0..1CodingActingMunicipality
URL: http://fhir.kl.dk/ffbmessaging/StructureDefinition/kl-messaging-ffb-actingMunicipality
Binding: MunicipalityCodes (required)
... status S1..1code[DK] indsatsforløbstatus
... intent S1..1code[DK] indsatsforløbhensigt
... subject S1..1Reference(Citizen)[DK] indsatsforløbsubjekt
... period S0..1PeriodTime period plan covers
... created S1..1dateTime[DK] indsatsforløbOprettelsestid
... author S1..1Reference(ParticipatingOrganization)[DK] indsatsforløbansvarlig
... careTeam S0..*Reference(ServicePerformer)[DK] indsatsforløbsleverandør og indsatsforløbtilbud
... addresses S1..*Reference(TargetGroup)[DK] indsatsforløbmålgruppe
... supportingInfo S0..*Reference(RelatedCarePlan)Information considered as part of plan
... goal S1..*Reference(Goal)Desired outcome of plan
... goal:fpurpose 1..1Reference(InterventionPurpose)[DK] indsatsforløbFormål
... goal:citizenObjective S0..*Reference(CitizenObjective)Desired outcome of plan

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*KLCommonCareSocialCarePlanHealthcare plan for patient or group
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... relevantHistory 0..*Reference(Provenance)[DK] indsatsforløbæ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
... status ?!SΣ1..1code[DK] indsatsforløbstatus
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] indsatsforløbhensigt
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... category SΣ1..1CodeableConceptType of plan
Binding: KLIndsatsforløbTypekoder (extensible)
... description SΣ0..1string[DK] indsatsforløbBeskrivelse
... subject SΣ1..1Reference(Citizen)[DK] indsatsforløbsubjekt
... period SΣ0..1PeriodTime period plan covers
... created SΣ1..1dateTime[DK] indsatsforløbOprettelsestid
... author SΣ1..1Reference(ParticipatingOrganization)[DK] indsatsforløbansvarlig
... careTeam S0..*Reference(ServicePerformer)[DK] indsatsforløbsleverandør og indsatsforløbtilbud
... addresses SΣ1..*Reference(TargetGroup)[DK] indsatsforløbmålgruppe
.... conditionRank 0..1positiveInt[DK] indsatsforløbsmålgruppeRang
URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank
... supportingInfo S0..*Reference(RelatedCarePlan)Information considered as part of plan
... Slices for goal S1..*Reference(Goal)Desired outcome of plan
Slice: Unordered, Open by value:resolve().category
.... goal:fpurpose 1..1Reference(InterventionPurpose)[DK] indsatsforløbFormål
.... goal:ffbgoal 0..*Reference(Goal - FFB Intervention)[DK] indsatsforløbsmål
.... goal:citizenObjective S0..*Reference(CitizenObjective)Desired outcome of plan
... Slices for activity C0..*BackboneElementAction to occur as part of plan
Slice: Unordered, Open by value:detail.code
.... activity:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... activity:carePlanEvaluation C0..*BackboneElementAction to occur as part of plan
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CarePlan.statusrequiredRequestStatus
CarePlan.intentrequiredCarePlanIntent
CarePlan.categoryextensibleKLCarePlanCategoryCodes

Constraints

IdGradePath(s)DetailsRequirements
cpl-3errorCarePlan.activity, CarePlan.activity:carePlanEvaluationProvide 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..*KLCommonCareSocialCarePlanHealthcare 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
... relevantHistory 0..*Reference(Provenance)[DK] indsatsforløbændringshistorie
URL: http://hl7.org/fhir/StructureDefinition/request-relevantHistory
... municipalityCaseNumber 0..1(Complex)[DK] anledningDokumenteretISag
URL: http://fhir.kl.dk/core/StructureDefinition/MunicipalityCaseNumber
... subjectActingMunicipality S0..1CodingActingMunicipality
URL: http://fhir.kl.dk/ffbmessaging/StructureDefinition/kl-messaging-ffb-actingMunicipality
Binding: MunicipalityCodes (required)
... 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 Σ0..*Reference(CarePlan)Fulfills CarePlan
... replaces Σ0..*Reference(CarePlan)CarePlan replaced by this CarePlan
... partOf Σ0..*Reference(CarePlan)Part of referenced CarePlan
... status ?!SΣ1..1code[DK] indsatsforløbstatus
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] indsatsforløbhensigt
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... category SΣ1..1CodeableConceptType of plan
Binding: KLIndsatsforløbTypekoder (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*Coding[DK] indsatsforløbKategori
.... text Σ0..1stringPlain text representation of the concept
... title Σ0..1stringHuman-friendly name for the care plan
... description SΣ0..1string[DK] indsatsforløbBeskrivelse
... subject SΣ1..1Reference(Citizen)[DK] indsatsforløbsubjekt
... 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] indsatsforløbBevillingstid
.... end ΣC0..1dateTime[DK] indsatsforløbAfslutningstid
... created SΣ1..1dateTime[DK] indsatsforløbOprettelsestid
... author SΣ1..1Reference(ParticipatingOrganization)[DK] indsatsforløbansvarlig
... contributor 0..*Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who provided the content of the care plan
... careTeam S0..*Reference(ServicePerformer)[DK] indsatsforløbsleverandør og indsatsforløbtilbud
... addresses SΣ1..*Reference(TargetGroup)[DK] indsatsforløbmålgruppe
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... conditionRank 0..1positiveInt[DK] indsatsforløbsmålgruppeRang
URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... supportingInfo S0..*Reference(RelatedCarePlan)Information considered as part of plan
... Slices for goal S1..*Reference(Goal)Desired outcome of plan
Slice: Unordered, Open by value:resolve().category
.... goal:fpurpose 1..1Reference(InterventionPurpose)[DK] indsatsforløbFormål
.... goal:ffbgoal 0..*Reference(Goal - FFB Intervention)[DK] indsatsforløbsmål
.... goal:citizenObjective S0..*Reference(CitizenObjective)Desired outcome of plan
... Slices for activity C0..*BackboneElementAction to occur as part of plan
Slice: Unordered, Open by value:detail.code
.... activity:All Slices Content/Rules for all slices
..... 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(Resource)[DK] vurderinger
..... 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 C0..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 0..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
....... coding Σ0..*Coding[DK] vurderinger
....... 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 | Observation | DiagnosticReport | DocumentReference)Why activity is needed
...... goal 0..*Reference(Goal)Goals this activity relates to
...... status ?!1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
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(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device)Who will be responsible?
...... 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..1stringExtra info describing activity to perform
.... activity:carePlanEvaluation C0..*BackboneElementAction 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(Evaluation)Appointment, Encounter, Procedure, etc.
..... 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 C0..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 1..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.


Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ 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: 95ec4535-8fe8-4296-867c-35de421794cf
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..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 | Observation | DiagnosticReport | DocumentReference)Why activity is needed
...... goal 0..*Reference(Goal)Goals this activity relates to
...... status ?!1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
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(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device)Who will be responsible?
...... 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..1stringExtra info describing activity to perform
... note 0..*AnnotationComments about the plan

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
CarePlan.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
CarePlan.statusrequiredRequestStatus
CarePlan.intentrequiredCarePlanIntent
CarePlan.categoryextensibleKLCarePlanCategoryCodes
CarePlan.addresses.typeextensibleResourceType
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes
CarePlan.activity:carePlanEvaluation.outcomeCodeableConceptexampleCarePlanActivityOutcome
CarePlan.activity:carePlanEvaluation.detail.kindrequiredCarePlanActivityKind
CarePlan.activity:carePlanEvaluation.detail.codeexamplePattern: 95ec4535-8fe8-4296-867c-35de421794cf
CarePlan.activity:carePlanEvaluation.detail.reasonCodeexampleSNOMEDCTClinicalFindings
CarePlan.activity:carePlanEvaluation.detail.statusrequiredCarePlanActivityStatus
CarePlan.activity:carePlanEvaluation.detail.product[x]exampleSNOMEDCTMedicationCodes

Constraints

IdGradePath(s)DetailsRequirements
cpl-3errorCarePlan.activity, CarePlan.activity:carePlanEvaluationProvide 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()

Differential View

This structure is derived from KLCommonCareSocialCarePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*KLCommonCareSocialCarePlanHealthcare plan for patient or group
... subjectActingMunicipality S0..1CodingActingMunicipality
URL: http://fhir.kl.dk/ffbmessaging/StructureDefinition/kl-messaging-ffb-actingMunicipality
Binding: MunicipalityCodes (required)
... status S1..1code[DK] indsatsforløbstatus
... intent S1..1code[DK] indsatsforløbhensigt
... subject S1..1Reference(Citizen)[DK] indsatsforløbsubjekt
... period S0..1PeriodTime period plan covers
... created S1..1dateTime[DK] indsatsforløbOprettelsestid
... author S1..1Reference(ParticipatingOrganization)[DK] indsatsforløbansvarlig
... careTeam S0..*Reference(ServicePerformer)[DK] indsatsforløbsleverandør og indsatsforløbtilbud
... addresses S1..*Reference(TargetGroup)[DK] indsatsforløbmålgruppe
... supportingInfo S0..*Reference(RelatedCarePlan)Information considered as part of plan
... goal S1..*Reference(Goal)Desired outcome of plan
... goal:fpurpose 1..1Reference(InterventionPurpose)[DK] indsatsforløbFormål
... goal:citizenObjective S0..*Reference(CitizenObjective)Desired outcome of plan

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*KLCommonCareSocialCarePlanHealthcare plan for patient or group
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... relevantHistory 0..*Reference(Provenance)[DK] indsatsforløbæ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
... status ?!SΣ1..1code[DK] indsatsforløbstatus
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] indsatsforløbhensigt
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... category SΣ1..1CodeableConceptType of plan
Binding: KLIndsatsforløbTypekoder (extensible)
... description SΣ0..1string[DK] indsatsforløbBeskrivelse
... subject SΣ1..1Reference(Citizen)[DK] indsatsforløbsubjekt
... period SΣ0..1PeriodTime period plan covers
... created SΣ1..1dateTime[DK] indsatsforløbOprettelsestid
... author SΣ1..1Reference(ParticipatingOrganization)[DK] indsatsforløbansvarlig
... careTeam S0..*Reference(ServicePerformer)[DK] indsatsforløbsleverandør og indsatsforløbtilbud
... addresses SΣ1..*Reference(TargetGroup)[DK] indsatsforløbmålgruppe
.... conditionRank 0..1positiveInt[DK] indsatsforløbsmålgruppeRang
URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank
... supportingInfo S0..*Reference(RelatedCarePlan)Information considered as part of plan
... Slices for goal S1..*Reference(Goal)Desired outcome of plan
Slice: Unordered, Open by value:resolve().category
.... goal:fpurpose 1..1Reference(InterventionPurpose)[DK] indsatsforløbFormål
.... goal:ffbgoal 0..*Reference(Goal - FFB Intervention)[DK] indsatsforløbsmål
.... goal:citizenObjective S0..*Reference(CitizenObjective)Desired outcome of plan
... Slices for activity C0..*BackboneElementAction to occur as part of plan
Slice: Unordered, Open by value:detail.code
.... activity:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... activity:carePlanEvaluation C0..*BackboneElementAction to occur as part of plan
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CarePlan.statusrequiredRequestStatus
CarePlan.intentrequiredCarePlanIntent
CarePlan.categoryextensibleKLCarePlanCategoryCodes

Constraints

IdGradePath(s)DetailsRequirements
cpl-3errorCarePlan.activity, CarePlan.activity:carePlanEvaluationProvide 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..*KLCommonCareSocialCarePlanHealthcare 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
... relevantHistory 0..*Reference(Provenance)[DK] indsatsforløbændringshistorie
URL: http://hl7.org/fhir/StructureDefinition/request-relevantHistory
... municipalityCaseNumber 0..1(Complex)[DK] anledningDokumenteretISag
URL: http://fhir.kl.dk/core/StructureDefinition/MunicipalityCaseNumber
... subjectActingMunicipality S0..1CodingActingMunicipality
URL: http://fhir.kl.dk/ffbmessaging/StructureDefinition/kl-messaging-ffb-actingMunicipality
Binding: MunicipalityCodes (required)
... 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 Σ0..*Reference(CarePlan)Fulfills CarePlan
... replaces Σ0..*Reference(CarePlan)CarePlan replaced by this CarePlan
... partOf Σ0..*Reference(CarePlan)Part of referenced CarePlan
... status ?!SΣ1..1code[DK] indsatsforløbstatus
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] indsatsforløbhensigt
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... category SΣ1..1CodeableConceptType of plan
Binding: KLIndsatsforløbTypekoder (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*Coding[DK] indsatsforløbKategori
.... text Σ0..1stringPlain text representation of the concept
... title Σ0..1stringHuman-friendly name for the care plan
... description SΣ0..1string[DK] indsatsforløbBeskrivelse
... subject SΣ1..1Reference(Citizen)[DK] indsatsforløbsubjekt
... 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] indsatsforløbBevillingstid
.... end ΣC0..1dateTime[DK] indsatsforløbAfslutningstid
... created SΣ1..1dateTime[DK] indsatsforløbOprettelsestid
... author SΣ1..1Reference(ParticipatingOrganization)[DK] indsatsforløbansvarlig
... contributor 0..*Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)Who provided the content of the care plan
... careTeam S0..*Reference(ServicePerformer)[DK] indsatsforløbsleverandør og indsatsforløbtilbud
... addresses SΣ1..*Reference(TargetGroup)[DK] indsatsforløbmålgruppe
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... conditionRank 0..1positiveInt[DK] indsatsforløbsmålgruppeRang
URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... supportingInfo S0..*Reference(RelatedCarePlan)Information considered as part of plan
... Slices for goal S1..*Reference(Goal)Desired outcome of plan
Slice: Unordered, Open by value:resolve().category
.... goal:fpurpose 1..1Reference(InterventionPurpose)[DK] indsatsforløbFormål
.... goal:ffbgoal 0..*Reference(Goal - FFB Intervention)[DK] indsatsforløbsmål
.... goal:citizenObjective S0..*Reference(CitizenObjective)Desired outcome of plan
... Slices for activity C0..*BackboneElementAction to occur as part of plan
Slice: Unordered, Open by value:detail.code
.... activity:All Slices Content/Rules for all slices
..... 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(Resource)[DK] vurderinger
..... 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 C0..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 0..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
....... coding Σ0..*Coding[DK] vurderinger
....... 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 | Observation | DiagnosticReport | DocumentReference)Why activity is needed
...... goal 0..*Reference(Goal)Goals this activity relates to
...... status ?!1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
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(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device)Who will be responsible?
...... 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..1stringExtra info describing activity to perform
.... activity:carePlanEvaluation C0..*BackboneElementAction 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(Evaluation)Appointment, Encounter, Procedure, etc.
..... 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 C0..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 1..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.


Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ 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: 95ec4535-8fe8-4296-867c-35de421794cf
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..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 | Observation | DiagnosticReport | DocumentReference)Why activity is needed
...... goal 0..*Reference(Goal)Goals this activity relates to
...... status ?!1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
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(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device)Who will be responsible?
...... 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..1stringExtra info describing activity to perform
... note 0..*AnnotationComments about the plan

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
CarePlan.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
CarePlan.statusrequiredRequestStatus
CarePlan.intentrequiredCarePlanIntent
CarePlan.categoryextensibleKLCarePlanCategoryCodes
CarePlan.addresses.typeextensibleResourceType
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes
CarePlan.activity:carePlanEvaluation.outcomeCodeableConceptexampleCarePlanActivityOutcome
CarePlan.activity:carePlanEvaluation.detail.kindrequiredCarePlanActivityKind
CarePlan.activity:carePlanEvaluation.detail.codeexamplePattern: 95ec4535-8fe8-4296-867c-35de421794cf
CarePlan.activity:carePlanEvaluation.detail.reasonCodeexampleSNOMEDCTClinicalFindings
CarePlan.activity:carePlanEvaluation.detail.statusrequiredCarePlanActivityStatus
CarePlan.activity:carePlanEvaluation.detail.product[x]exampleSNOMEDCTMedicationCodes

Constraints

IdGradePath(s)DetailsRequirements
cpl-3errorCarePlan.activity, CarePlan.activity:carePlanEvaluationProvide 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()

 

Other representations of profile: CSV, Excel, Schematron