Implementation Guide for FFB messaging (FFB udvekslingsdatasæt)
1.0.0 - release
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
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from KLCommonCareSocialCarePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | KLCommonCareSocialCarePlan | Healthcare plan for patient or group | |
implicitRules | ?!Σ | 0..1 | uri | A 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 | |
subjectActingMunicipality | S | 0..1 | Coding | ActingMunicipality URL: http://fhir.kl.dk/ffbmessaging/StructureDefinition/kl-messaging-ffb-actingMunicipality Binding: MunicipalityCodes (required) |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 1..1 | code | [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..1 | code | [DK] indsatsforløbhensigt Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. |
category | SΣ | 1..1 | CodeableConcept | Type of plan Binding: KLIndsatsforløbTypekoder (extensible) |
description | SΣ | 0..1 | string | [DK] indsatsforløbBeskrivelse |
subject | SΣ | 1..1 | Reference(Citizen) | [DK] indsatsforløbsubjekt |
period | SΣ | 0..1 | Period | Time period plan covers |
created | SΣ | 1..1 | dateTime | [DK] indsatsforløbOprettelsestid |
author | SΣ | 1..1 | Reference(ParticipatingOrganization) | [DK] indsatsforløbansvarlig |
careTeam | S | 0..* | Reference(ServicePerformer) | [DK] indsatsforløbsleverandør og indsatsforløbtilbud |
addresses | SΣ | 1..* | Reference(TargetGroup) | [DK] indsatsforløbmålgruppe |
conditionRank | 0..1 | positiveInt | [DK] indsatsforløbsmålgruppeRang URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank | |
supportingInfo | S | 0..* | Reference(RelatedCarePlan) | Information considered as part of plan |
Slices for goal | S | 1..* | Reference(Goal) | Desired outcome of plan Slice: Unordered, Open by value:resolve().category |
goal:fpurpose | 1..1 | Reference(InterventionPurpose) | [DK] indsatsforløbFormål | |
goal:ffbgoal | 0..* | Reference(Goal - FFB Intervention) | [DK] indsatsforløbsmål | |
goal:citizenObjective | S | 0..* | Reference(CitizenObjective) | Desired outcome of plan |
Slices for activity | C | 0..* | BackboneElement | Action to occur as part of plan Slice: Unordered, Open by value:detail.code |
activity:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
activity:carePlanEvaluation | C | 0..* | BackboneElement | Action to occur as part of plan |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Documentation for this format |
Path | Conformance | ValueSet |
CarePlan.status | required | RequestStatus |
CarePlan.intent | required | CarePlanIntent |
CarePlan.category | extensible | KLCarePlanCategoryCodes |
Id | Grade | Path(s) | Details | Requirements |
cpl-3 | error | CarePlan.activity, CarePlan.activity:carePlanEvaluation | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CarePlan | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CarePlan | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CarePlan | 0..* | KLCommonCareSocialCarePlan | Healthcare plan for patient or group | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension 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 | S | 0..1 | Coding | ActingMunicipality URL: http://fhir.kl.dk/ffbmessaging/StructureDefinition/kl-messaging-ffb-actingMunicipality Binding: MunicipalityCodes (required) | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External Ids for this plan | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates 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..1 | code | [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..1 | code | [DK] indsatsforløbhensigt Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||
category | SΣ | 1..1 | CodeableConcept | Type of plan Binding: KLIndsatsforløbTypekoder (extensible) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | [DK] indsatsforløbKategori | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
title | Σ | 0..1 | string | Human-friendly name for the care plan | ||||
description | SΣ | 0..1 | string | [DK] indsatsforløbBeskrivelse | ||||
subject | SΣ | 1..1 | Reference(Citizen) | [DK] indsatsforløbsubjekt | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
period | SΣ | 0..1 | Period | Time period plan covers | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | ΣC | 0..1 | dateTime | [DK] indsatsforløbBevillingstid | ||||
end | ΣC | 0..1 | dateTime | [DK] indsatsforløbAfslutningstid | ||||
created | SΣ | 1..1 | dateTime | [DK] indsatsforløbOprettelsestid | ||||
author | SΣ | 1..1 | Reference(ParticipatingOrganization) | [DK] indsatsforløbansvarlig | ||||
contributor | 0..* | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who provided the content of the care plan | |||||
careTeam | S | 0..* | Reference(ServicePerformer) | [DK] indsatsforløbsleverandør og indsatsforløbtilbud | ||||
addresses | SΣ | 1..* | Reference(TargetGroup) | [DK] indsatsforløbmålgruppe | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
conditionRank | 0..1 | positiveInt | [DK] indsatsforløbsmålgruppeRang URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
supportingInfo | S | 0..* | Reference(RelatedCarePlan) | Information considered as part of plan | ||||
Slices for goal | S | 1..* | Reference(Goal) | Desired outcome of plan Slice: Unordered, Open by value:resolve().category | ||||
goal:fpurpose | 1..1 | Reference(InterventionPurpose) | [DK] indsatsforløbFormål | |||||
goal:ffbgoal | 0..* | Reference(Goal - FFB Intervention) | [DK] indsatsforløbsmål | |||||
goal:citizenObjective | S | 0..* | Reference(CitizenObjective) | Desired outcome of plan | ||||
Slices for activity | C | 0..* | BackboneElement | Action to occur as part of plan Slice: Unordered, Open by value:detail.code | ||||
activity:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||
outcomeReference | 0..* | Reference(Resource) | [DK] vurderinger | |||||
progress | 0..* | Annotation | Comments about the activity status/progress | |||||
reference | C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
detail | C | 0..1 | BackboneElement | In-line definition of activity | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
kind | 0..1 | code | Appointment | 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..* | uri | Instantiates external protocol or definition | |||||
code | 0..1 | CodeableConcept | Detail 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..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | [DK] vurderinger | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
reasonCode | 0..* | CodeableConcept | Why 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..1 | code | not-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..1 | CodeableConcept | Reason for current status | |||||
doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action | ||||
scheduled[x] | 0..1 | When activity is to occur | ||||||
scheduledTiming | Timing | |||||||
scheduledPeriod | Period | |||||||
scheduledString | string | |||||||
location | 0..1 | Reference(Location) | Where it should happen | |||||
performer | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |||||
product[x] | 0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
productCodeableConcept | CodeableConcept | |||||||
productReference | Reference(Medication | Substance) | |||||||
dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |||||
quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |||||
description | 0..1 | string | Extra info describing activity to perform | |||||
activity:carePlanEvaluation | C | 0..* | BackboneElement | Action to occur as part of plan | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||
outcomeReference | 0..* | Reference(Evaluation) | Appointment, Encounter, Procedure, etc. | |||||
progress | 0..* | Annotation | Comments about the activity status/progress | |||||
reference | C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
detail | C | 0..1 | BackboneElement | In-line definition of activity | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
kind | 0..1 | code | Appointment | 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..* | uri | Instantiates external protocol or definition | |||||
code | 1..1 | CodeableConcept | Detail 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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 95ec4535-8fe8-4296-867c-35de421794cf | |||||
display | 0..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 | |||||
reasonCode | 0..* | CodeableConcept | Why 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..1 | code | not-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..1 | CodeableConcept | Reason for current status | |||||
doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action | ||||
scheduled[x] | 0..1 | When activity is to occur | ||||||
scheduledTiming | Timing | |||||||
scheduledPeriod | Period | |||||||
scheduledString | string | |||||||
location | 0..1 | Reference(Location) | Where it should happen | |||||
performer | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |||||
product[x] | 0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
productCodeableConcept | CodeableConcept | |||||||
productReference | Reference(Medication | Substance) | |||||||
dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |||||
quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |||||
description | 0..1 | string | Extra info describing activity to perform | |||||
note | 0..* | Annotation | Comments about the plan | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
CarePlan.language | preferred | CommonLanguages
| ||||
CarePlan.status | required | RequestStatus | ||||
CarePlan.intent | required | CarePlanIntent | ||||
CarePlan.category | extensible | KLCarePlanCategoryCodes | ||||
CarePlan.addresses.type | extensible | ResourceType | ||||
CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcome | ||||
CarePlan.activity.detail.kind | required | CarePlanActivityKind | ||||
CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT) | ||||
CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindings | ||||
CarePlan.activity.detail.status | required | CarePlanActivityStatus | ||||
CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodes | ||||
CarePlan.activity:carePlanEvaluation.outcomeCodeableConcept | example | CarePlanActivityOutcome | ||||
CarePlan.activity:carePlanEvaluation.detail.kind | required | CarePlanActivityKind | ||||
CarePlan.activity:carePlanEvaluation.detail.code | example | Pattern: 95ec4535-8fe8-4296-867c-35de421794cf | ||||
CarePlan.activity:carePlanEvaluation.detail.reasonCode | example | SNOMEDCTClinicalFindings | ||||
CarePlan.activity:carePlanEvaluation.detail.status | required | CarePlanActivityStatus | ||||
CarePlan.activity:carePlanEvaluation.detail.product[x] | example | SNOMEDCTMedicationCodes |
Id | Grade | Path(s) | Details | Requirements |
cpl-3 | error | CarePlan.activity, CarePlan.activity:carePlanEvaluation | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CarePlan | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CarePlan | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from KLCommonCareSocialCarePlan
Summary
Mandatory: 2 elements
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from KLCommonCareSocialCarePlan
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | KLCommonCareSocialCarePlan | Healthcare plan for patient or group | |
implicitRules | ?!Σ | 0..1 | uri | A 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 | |
subjectActingMunicipality | S | 0..1 | Coding | ActingMunicipality URL: http://fhir.kl.dk/ffbmessaging/StructureDefinition/kl-messaging-ffb-actingMunicipality Binding: MunicipalityCodes (required) |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 1..1 | code | [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..1 | code | [DK] indsatsforløbhensigt Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. |
category | SΣ | 1..1 | CodeableConcept | Type of plan Binding: KLIndsatsforløbTypekoder (extensible) |
description | SΣ | 0..1 | string | [DK] indsatsforløbBeskrivelse |
subject | SΣ | 1..1 | Reference(Citizen) | [DK] indsatsforløbsubjekt |
period | SΣ | 0..1 | Period | Time period plan covers |
created | SΣ | 1..1 | dateTime | [DK] indsatsforløbOprettelsestid |
author | SΣ | 1..1 | Reference(ParticipatingOrganization) | [DK] indsatsforløbansvarlig |
careTeam | S | 0..* | Reference(ServicePerformer) | [DK] indsatsforløbsleverandør og indsatsforløbtilbud |
addresses | SΣ | 1..* | Reference(TargetGroup) | [DK] indsatsforløbmålgruppe |
conditionRank | 0..1 | positiveInt | [DK] indsatsforløbsmålgruppeRang URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank | |
supportingInfo | S | 0..* | Reference(RelatedCarePlan) | Information considered as part of plan |
Slices for goal | S | 1..* | Reference(Goal) | Desired outcome of plan Slice: Unordered, Open by value:resolve().category |
goal:fpurpose | 1..1 | Reference(InterventionPurpose) | [DK] indsatsforløbFormål | |
goal:ffbgoal | 0..* | Reference(Goal - FFB Intervention) | [DK] indsatsforløbsmål | |
goal:citizenObjective | S | 0..* | Reference(CitizenObjective) | Desired outcome of plan |
Slices for activity | C | 0..* | BackboneElement | Action to occur as part of plan Slice: Unordered, Open by value:detail.code |
activity:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
activity:carePlanEvaluation | C | 0..* | BackboneElement | Action to occur as part of plan |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Documentation for this format |
Path | Conformance | ValueSet |
CarePlan.status | required | RequestStatus |
CarePlan.intent | required | CarePlanIntent |
CarePlan.category | extensible | KLCarePlanCategoryCodes |
Id | Grade | Path(s) | Details | Requirements |
cpl-3 | error | CarePlan.activity, CarePlan.activity:carePlanEvaluation | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CarePlan | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CarePlan | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CarePlan | 0..* | KLCommonCareSocialCarePlan | Healthcare plan for patient or group | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension 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 | S | 0..1 | Coding | ActingMunicipality URL: http://fhir.kl.dk/ffbmessaging/StructureDefinition/kl-messaging-ffb-actingMunicipality Binding: MunicipalityCodes (required) | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External Ids for this plan | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates 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..1 | code | [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..1 | code | [DK] indsatsforløbhensigt Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||
category | SΣ | 1..1 | CodeableConcept | Type of plan Binding: KLIndsatsforløbTypekoder (extensible) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | [DK] indsatsforløbKategori | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
title | Σ | 0..1 | string | Human-friendly name for the care plan | ||||
description | SΣ | 0..1 | string | [DK] indsatsforløbBeskrivelse | ||||
subject | SΣ | 1..1 | Reference(Citizen) | [DK] indsatsforløbsubjekt | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
period | SΣ | 0..1 | Period | Time period plan covers | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | ΣC | 0..1 | dateTime | [DK] indsatsforløbBevillingstid | ||||
end | ΣC | 0..1 | dateTime | [DK] indsatsforløbAfslutningstid | ||||
created | SΣ | 1..1 | dateTime | [DK] indsatsforløbOprettelsestid | ||||
author | SΣ | 1..1 | Reference(ParticipatingOrganization) | [DK] indsatsforløbansvarlig | ||||
contributor | 0..* | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who provided the content of the care plan | |||||
careTeam | S | 0..* | Reference(ServicePerformer) | [DK] indsatsforløbsleverandør og indsatsforløbtilbud | ||||
addresses | SΣ | 1..* | Reference(TargetGroup) | [DK] indsatsforløbmålgruppe | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
conditionRank | 0..1 | positiveInt | [DK] indsatsforløbsmålgruppeRang URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
supportingInfo | S | 0..* | Reference(RelatedCarePlan) | Information considered as part of plan | ||||
Slices for goal | S | 1..* | Reference(Goal) | Desired outcome of plan Slice: Unordered, Open by value:resolve().category | ||||
goal:fpurpose | 1..1 | Reference(InterventionPurpose) | [DK] indsatsforløbFormål | |||||
goal:ffbgoal | 0..* | Reference(Goal - FFB Intervention) | [DK] indsatsforløbsmål | |||||
goal:citizenObjective | S | 0..* | Reference(CitizenObjective) | Desired outcome of plan | ||||
Slices for activity | C | 0..* | BackboneElement | Action to occur as part of plan Slice: Unordered, Open by value:detail.code | ||||
activity:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||
outcomeReference | 0..* | Reference(Resource) | [DK] vurderinger | |||||
progress | 0..* | Annotation | Comments about the activity status/progress | |||||
reference | C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
detail | C | 0..1 | BackboneElement | In-line definition of activity | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
kind | 0..1 | code | Appointment | 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..* | uri | Instantiates external protocol or definition | |||||
code | 0..1 | CodeableConcept | Detail 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..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | [DK] vurderinger | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
reasonCode | 0..* | CodeableConcept | Why 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..1 | code | not-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..1 | CodeableConcept | Reason for current status | |||||
doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action | ||||
scheduled[x] | 0..1 | When activity is to occur | ||||||
scheduledTiming | Timing | |||||||
scheduledPeriod | Period | |||||||
scheduledString | string | |||||||
location | 0..1 | Reference(Location) | Where it should happen | |||||
performer | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |||||
product[x] | 0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
productCodeableConcept | CodeableConcept | |||||||
productReference | Reference(Medication | Substance) | |||||||
dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |||||
quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |||||
description | 0..1 | string | Extra info describing activity to perform | |||||
activity:carePlanEvaluation | C | 0..* | BackboneElement | Action to occur as part of plan | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||
outcomeReference | 0..* | Reference(Evaluation) | Appointment, Encounter, Procedure, etc. | |||||
progress | 0..* | Annotation | Comments about the activity status/progress | |||||
reference | C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
detail | C | 0..1 | BackboneElement | In-line definition of activity | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
kind | 0..1 | code | Appointment | 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..* | uri | Instantiates external protocol or definition | |||||
code | 1..1 | CodeableConcept | Detail 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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 95ec4535-8fe8-4296-867c-35de421794cf | |||||
display | 0..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 | |||||
reasonCode | 0..* | CodeableConcept | Why 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..1 | code | not-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..1 | CodeableConcept | Reason for current status | |||||
doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action | ||||
scheduled[x] | 0..1 | When activity is to occur | ||||||
scheduledTiming | Timing | |||||||
scheduledPeriod | Period | |||||||
scheduledString | string | |||||||
location | 0..1 | Reference(Location) | Where it should happen | |||||
performer | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |||||
product[x] | 0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
productCodeableConcept | CodeableConcept | |||||||
productReference | Reference(Medication | Substance) | |||||||
dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |||||
quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |||||
description | 0..1 | string | Extra info describing activity to perform | |||||
note | 0..* | Annotation | Comments about the plan | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
CarePlan.language | preferred | CommonLanguages
| ||||
CarePlan.status | required | RequestStatus | ||||
CarePlan.intent | required | CarePlanIntent | ||||
CarePlan.category | extensible | KLCarePlanCategoryCodes | ||||
CarePlan.addresses.type | extensible | ResourceType | ||||
CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcome | ||||
CarePlan.activity.detail.kind | required | CarePlanActivityKind | ||||
CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT) | ||||
CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindings | ||||
CarePlan.activity.detail.status | required | CarePlanActivityStatus | ||||
CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodes | ||||
CarePlan.activity:carePlanEvaluation.outcomeCodeableConcept | example | CarePlanActivityOutcome | ||||
CarePlan.activity:carePlanEvaluation.detail.kind | required | CarePlanActivityKind | ||||
CarePlan.activity:carePlanEvaluation.detail.code | example | Pattern: 95ec4535-8fe8-4296-867c-35de421794cf | ||||
CarePlan.activity:carePlanEvaluation.detail.reasonCode | example | SNOMEDCTClinicalFindings | ||||
CarePlan.activity:carePlanEvaluation.detail.status | required | CarePlanActivityStatus | ||||
CarePlan.activity:carePlanEvaluation.detail.product[x] | example | SNOMEDCTMedicationCodes |
Id | Grade | Path(s) | Details | Requirements |
cpl-3 | error | CarePlan.activity, CarePlan.activity:carePlanEvaluation | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CarePlan | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CarePlan | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from KLCommonCareSocialCarePlan
Summary
Mandatory: 2 elements
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron