1.2.0 - release
KLGateway, published by KL. This guide is not an authorized publication; it is the continuous build for version 1.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7dk/kl-gateway/ and changes regularly. See the Directory of published versions
Official URL: http://fhir.kl.dk/gateway/StructureDefinition/klgateway-care-planned-intervention | Version: 1.2.0 | |||
Active as of 2024-10-31 | Computable Name: KLGatewayCarePlannedIntervention |
Planned interventions for nursing and home care in Danish Municipalities.
The PlannedIntervention may be instatiated whenever an intervention is planned for a citizen in Danish municipalities. PlannedIntervention is used for planning ahead. When the intervention is acute or otherwise not planned, use CompletedIntervention instead.
CarePlan.activity.detail.code.coding holds the intervention code from FSIII of the intervention that should be carried out.
It is important to distiguish correctly between the dates and times stated in the model. CarePlan.period.start is from when the PlannedIntervention is authorized (bevillingstid). The planned end-date is CarePlan.period.end, unless the date has already occured and the status is "completed", then it is the actual end-date.
CarePlan.status and CarePlan.intent are mandatory in the FHIR CarePlan resource. CarePlan.intent is always 'plan' in this implementation guide. CarePlan status should be either 'unknown', 'entered-in-error', or the status of the intervention at the time of reporting. Note that the meaning of 'active' is "ready to be acted upon", so it does not signify that the first activity has occured.
CarePlan.activity.detail.status is also mandatory, and all the statuses in the FHIR ValueSet may be used, however 'unknown' is permitted from the time where the intervention occurs in the record until its completion. It is recommended not to use 'entered-in-error' - if the CarePlan is entered-in-error use CarePlan.status.
CarePlan:extension.FollowUpEncounter can be used to explicitely state when follow-up on the intervention should occur. However, the followUpEncounter-extension will be depricated in the next version of this implementation guide. In the new version, GeneralEncounter can hold a reference to the PlannedIntervention.
CarePlan.activity.detail.reasonReference holds the link between conditions and interventions which are mandatory is FSIII, but optional in this context to allow reporting of interventions not yet linked to a reason.
CarePlan.activity.detail:extension.deliveryType can be used to state, how interventions are delivered. Valid values are 'individual', 'group based', 'delivered using a robot' 'delivered using digital solutions'. Note that more than one code may apply to one intervention e.g. cleaning may be done partially by a robot vacuum cleaner, and partially by a person. In this case, use both 'individual' and 'delivered using a robot'.
Nedenstående tabel oversætter mellem de attributter der er defineret i den fælleskommunale informationsmodel (FKI), definerer kort den enkelte attribut på dansk og specificerer hvilke af FHIR-profilens attributter der skal bruges til specifikation af indholdet
FKI-attribut | Definition | FHIR |
---|---|---|
indsatsskode | Udtrykker hvilken klasse indsatsen tilhører. | CarePlan.activity.detail.code.coding |
indsatsbevillingstid | Tidspunktet for hvornår indsatsen er bevilget | CarePlan.period.start |
indsatsafslutningstid | Tidspunktet for hvornår indsatsen er afsluttet, eller planlægges afsluttet | CarePlan.period.end |
indsatsstatus | Indikerer om indsatsplanen er klar til at blive handlet på, om dokumentationen repræsentere en fremtidig intention eller er historisk. | CarePlan.status |
indsatshensigt | Indikerer niveauet af autorisation og hvor langt i planlægningen indsatsen er | CarePlan.intent |
indsatssubjekt | Den borger som den planlagte indsats retter sig mod | CarePlan.subject |
indsatsPlanlagtOpfølgning | Kontakt, hvor det planlægges at følge op på tilstanden | CarePlan:extension.FollowUpEncounter |
indsatsbegrundelse | Tilstand som indsatsen rettes mod | CarePlan.activity.detail.reasonReference |
indsatsAktivitetsstatus | Indikerer om indsatsen er igangsat, eller om den ikke er startet, eller er færdiggjort | CarePlan.activity.detail.status |
indsatsLeveringstype | Type der beskriver hvordan indsatsen leveres | activity.detail.extension:deliveryType |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CarePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | CarePlan | |||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
followUpEncounter | S | 0..1 | Reference(CareEncounter) {b} | [DK] indsatsPlanlagtOpfølgning URL: http://fhir.kl.dk/gateway/StructureDefinition/klgateway-care-follow-up-encounter-extension |
identifier | 0..0 | |||
instantiatesCanonical | 0..0 | |||
instantiatesUri | 0..0 | |||
basedOn | 0..0 | |||
replaces | 0..0 | |||
partOf | 0..0 | |||
status | 1..1 | code | [DK] indsatsstatus | |
intent | 1..1 | code | [DK] indsatshensigt Required Pattern: plan | |
category | 0..0 | |||
title | 0..0 | |||
description | 0..0 | |||
subject | 1..1 | Reference(CareCitizen) {b} | [DK] indsatssubjekt | |
encounter | 0..0 | |||
period | 1..1 | Period | Time period plan covers | |
start | 1..1 | dateTime | [DK] indsatsbevillingstid | |
end | 0..1 | dateTime | [DK] indsatsafslutningstid | |
created | 0..0 | |||
author | 0..0 | |||
contributor | 0..0 | |||
careTeam | 0..0 | |||
addresses | 0..0 | |||
supportingInfo | 0..0 | |||
goal | 0..0 | |||
activity | 1..1 | BackboneElement | Action to occur as part of plan | |
outcomeCodeableConcept | 0..0 | |||
outcomeReference | 0..0 | |||
progress | 0..0 | |||
reference | 0..0 | |||
detail | 1..1 | BackboneElement | In-line definition of activity | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
deliveryType | 0..* | (Complex) | [DK] indsatsLeveringstype URL: http://fhir.kl.dk/gateway/StructureDefinition/DeliveryType | |
value[x] | ||||
coding | 0..* | Coding | Code defined by a terminology system Binding: DeliveryTypes (required) | |
kind | 0..0 | |||
instantiatesCanonical | 0..0 | |||
instantiatesUri | 0..0 | |||
code | 1..1 | CodeableConcept | Detail type of activity | |
Slices for coding | 1..* | Coding | [DK] indsatsskode Slice: Unordered, Closed by value:system | |
coding:level2 | 1..1 | Coding | Code defined by a terminology system Binding: FSIIICareInterventions (required) | |
system | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:1.2.208.176.2.21 | |
coding:level3 | S | 0..1 | Coding | Code defined by a terminology system |
system | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.kl.dk/gateway/CodeSystem/LocallyDefinedInterventions | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
reasonCode | 0..0 | |||
reasonReference | S | 0..* | Reference(CareCondition) {b} | [DK] indsatsbegrundelse |
goal | 0..0 | |||
status | 1..1 | code | [DK] indsatsAktivitetsstatus | |
statusReason | 0..0 | |||
doNotPerform | 0..0 | |||
scheduled[x] | 0..0 | |||
location | 0..0 | |||
performer | 0..0 | |||
product[x] | 0..0 | |||
dailyAmount | 0..0 | |||
quantity | 0..0 | |||
description | 0..0 | |||
note | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
CarePlan.activity.detail.extension:deliveryType.value[x].coding | required | DeliveryTypeshttp://fhir.kl.dk/gateway/ValueSet/DeliveryTypes from this IG | |
CarePlan.activity.detail.code.coding:level2 | required | FSIIICareInterventionshttp://fhir.kl.dk/gateway/ValueSet/FSIIICareInterventions from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
followUpEncounter | S | 0..1 | Reference(CareEncounter) {b} | [DK] indsatsPlanlagtOpfølgning URL: http://fhir.kl.dk/gateway/StructureDefinition/klgateway-care-follow-up-encounter-extension |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | [DK] indsatsstatus Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. |
intent | ?!Σ | 1..1 | code | [DK] indsatshensigt Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. Required Pattern: plan |
subject | Σ | 1..1 | Reference(CareCitizen) {b} | [DK] indsatssubjekt |
period | Σ | 1..1 | Period | Time period plan covers |
start | ΣC | 1..1 | dateTime | [DK] indsatsbevillingstid |
end | ΣC | 0..1 | dateTime | [DK] indsatsafslutningstid |
activity | C | 1..1 | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
detail | C | 1..1 | BackboneElement | In-line definition of activity |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
deliveryType | 0..* | (Complex) | [DK] indsatsLeveringstype URL: http://fhir.kl.dk/gateway/StructureDefinition/DeliveryType | |
extension | 0..0 | |||
url | 1..1 | uri | "http://fhir.kl.dk/gateway/StructureDefinition/DeliveryType" | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
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. | |
Slices for coding | Σ | 1..* | Coding | [DK] indsatsskode Slice: Unordered, Closed by value:system |
coding:level2 | Σ | 1..1 | Coding | Code defined by a terminology system Binding: FSIIICareInterventions (required) |
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:1.2.208.176.2.21 |
coding:level3 | SΣ | 0..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.kl.dk/gateway/CodeSystem/LocallyDefinedInterventions |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
reasonReference | S | 0..* | Reference(CareCondition) {b} | [DK] indsatsbegrundelse |
status | ?! | 1..1 | code | [DK] indsatsAktivitetsstatus Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
CarePlan.intent | required | Pattern: planhttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard | |
CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | |
CarePlan.activity.detail.code.coding:level2 | required | FSIIICareInterventionshttp://fhir.kl.dk/gateway/ValueSet/FSIIICareInterventions from this IG | |
CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cpl-3 | error | CarePlan.activity | 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..* | CarePlan | 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 | |||||
followUpEncounter | S | 0..1 | Reference(CareEncounter) {b} | [DK] indsatsPlanlagtOpfølgning URL: http://fhir.kl.dk/gateway/StructureDefinition/klgateway-care-follow-up-encounter-extension | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
status | ?!Σ | 1..1 | code | [DK] indsatsstatus Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | ||||
intent | ?!Σ | 1..1 | code | [DK] indsatshensigt Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. Required Pattern: plan | ||||
subject | Σ | 1..1 | Reference(CareCitizen) {b} | [DK] indsatssubjekt | ||||
period | Σ | 1..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 | 1..1 | dateTime | [DK] indsatsbevillingstid | ||||
end | ΣC | 0..1 | dateTime | [DK] indsatsafslutningstid | ||||
activity | C | 1..1 | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both | ||||
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 | ||||
detail | C | 1..1 | BackboneElement | In-line definition of activity | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
deliveryType | 0..* | (Complex) | [DK] indsatsLeveringstype URL: http://fhir.kl.dk/gateway/StructureDefinition/DeliveryType | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://fhir.kl.dk/gateway/StructureDefinition/DeliveryType" | |||||
value[x] | 0..1 | CodeableConcept | Value of extension | |||||
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 | Code defined by a terminology system Binding: DeliveryTypes (required) | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 1..* | Coding | [DK] indsatsskode Slice: Unordered, Closed by value:system | ||||
coding:level2 | Σ | 1..1 | Coding | Code defined by a terminology system Binding: FSIIICareInterventions (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:1.2.208.176.2.21 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:level3 | SΣ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.kl.dk/gateway/CodeSystem/LocallyDefinedInterventions | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
reasonReference | S | 0..* | Reference(CareCondition) {b} | [DK] indsatsbegrundelse | ||||
status | ?! | 1..1 | code | [DK] indsatsAktivitetsstatus Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
CarePlan.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
CarePlan.intent | required | Pattern: planhttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard | ||||
CarePlan.activity.detail.extension:deliveryType.value[x].coding | required | DeliveryTypeshttp://fhir.kl.dk/gateway/ValueSet/DeliveryTypes from this IG | ||||
CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | ||||
CarePlan.activity.detail.code.coding:level2 | required | FSIIICareInterventionshttp://fhir.kl.dk/gateway/ValueSet/FSIIICareInterventions from this IG | ||||
CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cpl-3 | error | CarePlan.activity | 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 CarePlan
Summary
Mandatory: 8 elements(3 nested mandatory elements)
Must-Support: 3 elements
Prohibited: 36 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CarePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | CarePlan | |||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
followUpEncounter | S | 0..1 | Reference(CareEncounter) {b} | [DK] indsatsPlanlagtOpfølgning URL: http://fhir.kl.dk/gateway/StructureDefinition/klgateway-care-follow-up-encounter-extension |
identifier | 0..0 | |||
instantiatesCanonical | 0..0 | |||
instantiatesUri | 0..0 | |||
basedOn | 0..0 | |||
replaces | 0..0 | |||
partOf | 0..0 | |||
status | 1..1 | code | [DK] indsatsstatus | |
intent | 1..1 | code | [DK] indsatshensigt Required Pattern: plan | |
category | 0..0 | |||
title | 0..0 | |||
description | 0..0 | |||
subject | 1..1 | Reference(CareCitizen) {b} | [DK] indsatssubjekt | |
encounter | 0..0 | |||
period | 1..1 | Period | Time period plan covers | |
start | 1..1 | dateTime | [DK] indsatsbevillingstid | |
end | 0..1 | dateTime | [DK] indsatsafslutningstid | |
created | 0..0 | |||
author | 0..0 | |||
contributor | 0..0 | |||
careTeam | 0..0 | |||
addresses | 0..0 | |||
supportingInfo | 0..0 | |||
goal | 0..0 | |||
activity | 1..1 | BackboneElement | Action to occur as part of plan | |
outcomeCodeableConcept | 0..0 | |||
outcomeReference | 0..0 | |||
progress | 0..0 | |||
reference | 0..0 | |||
detail | 1..1 | BackboneElement | In-line definition of activity | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
deliveryType | 0..* | (Complex) | [DK] indsatsLeveringstype URL: http://fhir.kl.dk/gateway/StructureDefinition/DeliveryType | |
value[x] | ||||
coding | 0..* | Coding | Code defined by a terminology system Binding: DeliveryTypes (required) | |
kind | 0..0 | |||
instantiatesCanonical | 0..0 | |||
instantiatesUri | 0..0 | |||
code | 1..1 | CodeableConcept | Detail type of activity | |
Slices for coding | 1..* | Coding | [DK] indsatsskode Slice: Unordered, Closed by value:system | |
coding:level2 | 1..1 | Coding | Code defined by a terminology system Binding: FSIIICareInterventions (required) | |
system | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:1.2.208.176.2.21 | |
coding:level3 | S | 0..1 | Coding | Code defined by a terminology system |
system | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.kl.dk/gateway/CodeSystem/LocallyDefinedInterventions | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
reasonCode | 0..0 | |||
reasonReference | S | 0..* | Reference(CareCondition) {b} | [DK] indsatsbegrundelse |
goal | 0..0 | |||
status | 1..1 | code | [DK] indsatsAktivitetsstatus | |
statusReason | 0..0 | |||
doNotPerform | 0..0 | |||
scheduled[x] | 0..0 | |||
location | 0..0 | |||
performer | 0..0 | |||
product[x] | 0..0 | |||
dailyAmount | 0..0 | |||
quantity | 0..0 | |||
description | 0..0 | |||
note | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
CarePlan.activity.detail.extension:deliveryType.value[x].coding | required | DeliveryTypeshttp://fhir.kl.dk/gateway/ValueSet/DeliveryTypes from this IG | |
CarePlan.activity.detail.code.coding:level2 | required | FSIIICareInterventionshttp://fhir.kl.dk/gateway/ValueSet/FSIIICareInterventions from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
followUpEncounter | S | 0..1 | Reference(CareEncounter) {b} | [DK] indsatsPlanlagtOpfølgning URL: http://fhir.kl.dk/gateway/StructureDefinition/klgateway-care-follow-up-encounter-extension |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | [DK] indsatsstatus Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. |
intent | ?!Σ | 1..1 | code | [DK] indsatshensigt Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. Required Pattern: plan |
subject | Σ | 1..1 | Reference(CareCitizen) {b} | [DK] indsatssubjekt |
period | Σ | 1..1 | Period | Time period plan covers |
start | ΣC | 1..1 | dateTime | [DK] indsatsbevillingstid |
end | ΣC | 0..1 | dateTime | [DK] indsatsafslutningstid |
activity | C | 1..1 | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
detail | C | 1..1 | BackboneElement | In-line definition of activity |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
deliveryType | 0..* | (Complex) | [DK] indsatsLeveringstype URL: http://fhir.kl.dk/gateway/StructureDefinition/DeliveryType | |
extension | 0..0 | |||
url | 1..1 | uri | "http://fhir.kl.dk/gateway/StructureDefinition/DeliveryType" | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
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. | |
Slices for coding | Σ | 1..* | Coding | [DK] indsatsskode Slice: Unordered, Closed by value:system |
coding:level2 | Σ | 1..1 | Coding | Code defined by a terminology system Binding: FSIIICareInterventions (required) |
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:1.2.208.176.2.21 |
coding:level3 | SΣ | 0..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.kl.dk/gateway/CodeSystem/LocallyDefinedInterventions |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
reasonReference | S | 0..* | Reference(CareCondition) {b} | [DK] indsatsbegrundelse |
status | ?! | 1..1 | code | [DK] indsatsAktivitetsstatus Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
CarePlan.intent | required | Pattern: planhttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard | |
CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | |
CarePlan.activity.detail.code.coding:level2 | required | FSIIICareInterventionshttp://fhir.kl.dk/gateway/ValueSet/FSIIICareInterventions from this IG | |
CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cpl-3 | error | CarePlan.activity | 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..* | CarePlan | 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 | |||||
followUpEncounter | S | 0..1 | Reference(CareEncounter) {b} | [DK] indsatsPlanlagtOpfølgning URL: http://fhir.kl.dk/gateway/StructureDefinition/klgateway-care-follow-up-encounter-extension | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
status | ?!Σ | 1..1 | code | [DK] indsatsstatus Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | ||||
intent | ?!Σ | 1..1 | code | [DK] indsatshensigt Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. Required Pattern: plan | ||||
subject | Σ | 1..1 | Reference(CareCitizen) {b} | [DK] indsatssubjekt | ||||
period | Σ | 1..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 | 1..1 | dateTime | [DK] indsatsbevillingstid | ||||
end | ΣC | 0..1 | dateTime | [DK] indsatsafslutningstid | ||||
activity | C | 1..1 | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both | ||||
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 | ||||
detail | C | 1..1 | BackboneElement | In-line definition of activity | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
deliveryType | 0..* | (Complex) | [DK] indsatsLeveringstype URL: http://fhir.kl.dk/gateway/StructureDefinition/DeliveryType | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://fhir.kl.dk/gateway/StructureDefinition/DeliveryType" | |||||
value[x] | 0..1 | CodeableConcept | Value of extension | |||||
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 | Code defined by a terminology system Binding: DeliveryTypes (required) | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 1..* | Coding | [DK] indsatsskode Slice: Unordered, Closed by value:system | ||||
coding:level2 | Σ | 1..1 | Coding | Code defined by a terminology system Binding: FSIIICareInterventions (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:1.2.208.176.2.21 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:level3 | SΣ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.kl.dk/gateway/CodeSystem/LocallyDefinedInterventions | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
reasonReference | S | 0..* | Reference(CareCondition) {b} | [DK] indsatsbegrundelse | ||||
status | ?! | 1..1 | code | [DK] indsatsAktivitetsstatus Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
CarePlan.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
CarePlan.intent | required | Pattern: planhttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard | ||||
CarePlan.activity.detail.extension:deliveryType.value[x].coding | required | DeliveryTypeshttp://fhir.kl.dk/gateway/ValueSet/DeliveryTypes from this IG | ||||
CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | ||||
CarePlan.activity.detail.code.coding:level2 | required | FSIIICareInterventionshttp://fhir.kl.dk/gateway/ValueSet/FSIIICareInterventions from this IG | ||||
CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cpl-3 | error | CarePlan.activity | 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 CarePlan
Summary
Mandatory: 8 elements(3 nested mandatory elements)
Must-Support: 3 elements
Prohibited: 36 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron