KLChildren implementation guide, an implementation of FBU
2.1.0 - Release
This page is part of the KLChildren (v2.1.0: Release) based on FHIR (HL7® FHIR® Standard) 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/children/StructureDefinition/klgateway-children-intervention | Version: 2.1.0 | |||
Active as of 2024-10-31 | Computable Name: KLGatewayChildrenIntervention |
Profile representing interventions in the children database
The KLGatewayChildrenIntervention for the FBU standard is used whenever a need-based intervention is planned for a child or parent in Danish municipalities.
CarePlan.activity.detail.code.coding holds the intervention code, which has to come from the official list of interventions.
It is important to distinguish correctly between the dates and times stated in the model. CarePlan.period.start is when the PlannedIntervention was authorized (bevillingstid). The planned end-date is CarePlan.period.end, unless the date has already occurred and the status is 'completed', then it is the actual end-date. It is not necessary to report a planned end-date, if it is unknown. All dates may be reported with or without time of day.
Notice that some interventions have a timeframe, in which several encounters are delivered. Others are planned and delivered without that eliciting extra encounters for the child or parents (or at least without specific documentation of it). The last mentioned may be reported with the same CarePlan.period.start and CarePlan.period.end, or with only a start-date, and there is no requirement to report associated encounters. This holds true for the interventions related to parent-education (forældreuddannelse), parent-group (forældregruppe) and collaboration/referrals (samarbejdsindsatser inkl. henvisninger).
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 occurred.
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.subject references the citizen, that receives the interventions. Note that some interventions should be linked to the child, and others to the parents.
CarePlan.activity.detail.reasonCode.coding may hold one or more condition-codes. Though not mandatory to use, conditions provide a structured way of linking what challenges a family have, with the intervention provided.
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 specificere hvilke af FHIR-profilens atributter 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 |
indsatsAktivitetsstatus | Indikerer om indsatsen er igangsat, eller om den ikke er startet, er aflyst, eller er færdiggjort | CarePlan.activity.detail.status |
indsatssubjekt | Den borger som den planlagte indsats retter sig mod | CarePlan.subject |
indsatsBegrundelse | Kode for den eller de tilstande, der ligge til grund for denne behovsindsats | CarePlan.activity.detail.reasonCode.coding |
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 | |||
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(KLGatewayChildrenCitizen) {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 | |
kind | 0..0 | |||
instantiatesCanonical | 0..0 | |||
instantiatesUri | 0..0 | |||
code | 1..1 | CodeableConcept | Detail type of activity | |
coding | 1..1 | Coding | [DK] indsatsskode Binding: Sundhedsplejeindsatser (required) | |
system | 0..1 | uri | Identity of the terminology system Required Pattern: http://fhir.kl.dk/term/CodeSystem/FBOE | |
text | 0..0 | |||
reasonCode | ||||
coding | 0..* | Coding | [DK] indsatsbegrundelse Binding: Sundhedsplejetilstande (required) | |
reasonReference | 0..0 | |||
goal | 0..0 | |||
status | 1..1 | code | [DK] indsatsAktivitetsstatus | |
statusReason | 0..0 | |||
doNotPerform | 0..0 | |||
scheduled[x] | 0..0 | |||
location | 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.code.coding | required | KLHealthNurseInterventionshttp://fhir.kl.dk/children/ValueSet/KLHealthNurseInterventions from this IG | |
CarePlan.activity.detail.reasonCode.coding | required | KLHealthNurseConditionshttp://fhir.kl.dk/children/ValueSet/KLHealthNurseConditions 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 |
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(KLGatewayChildrenCitizen) {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 |
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. | |
coding | Σ | 1..1 | Coding | [DK] indsatsskode Binding: Sundhedsplejeindsatser (required) |
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://fhir.kl.dk/term/CodeSystem/FBOE |
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 | required | KLHealthNurseInterventionshttp://fhir.kl.dk/children/ValueSet/KLHealthNurseInterventions 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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(KLGatewayChildrenCitizen) {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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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 | |||||
coding | Σ | 1..1 | Coding | [DK] indsatsskode Binding: Sundhedsplejeindsatser (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 | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://fhir.kl.dk/term/CodeSystem/FBOE | ||||
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 | ||||
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. | |||||
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] indsatsbegrundelse Binding: Sundhedsplejetilstande (required) | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
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. | ||||
performer | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |||||
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.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | ||||
CarePlan.activity.detail.code.coding | required | KLHealthNurseInterventionshttp://fhir.kl.dk/children/ValueSet/KLHealthNurseInterventions from this IG | ||||
CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
CarePlan.activity.detail.reasonCode.coding | required | KLHealthNurseConditionshttp://fhir.kl.dk/children/ValueSet/KLHealthNurseConditions 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
Differential View
This structure is derived from CarePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | CarePlan | |||
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(KLGatewayChildrenCitizen) {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 | |
kind | 0..0 | |||
instantiatesCanonical | 0..0 | |||
instantiatesUri | 0..0 | |||
code | 1..1 | CodeableConcept | Detail type of activity | |
coding | 1..1 | Coding | [DK] indsatsskode Binding: Sundhedsplejeindsatser (required) | |
system | 0..1 | uri | Identity of the terminology system Required Pattern: http://fhir.kl.dk/term/CodeSystem/FBOE | |
text | 0..0 | |||
reasonCode | ||||
coding | 0..* | Coding | [DK] indsatsbegrundelse Binding: Sundhedsplejetilstande (required) | |
reasonReference | 0..0 | |||
goal | 0..0 | |||
status | 1..1 | code | [DK] indsatsAktivitetsstatus | |
statusReason | 0..0 | |||
doNotPerform | 0..0 | |||
scheduled[x] | 0..0 | |||
location | 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.code.coding | required | KLHealthNurseInterventionshttp://fhir.kl.dk/children/ValueSet/KLHealthNurseInterventions from this IG | |
CarePlan.activity.detail.reasonCode.coding | required | KLHealthNurseConditionshttp://fhir.kl.dk/children/ValueSet/KLHealthNurseConditions 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 |
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(KLGatewayChildrenCitizen) {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 |
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. | |
coding | Σ | 1..1 | Coding | [DK] indsatsskode Binding: Sundhedsplejeindsatser (required) |
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://fhir.kl.dk/term/CodeSystem/FBOE |
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 | required | KLHealthNurseInterventionshttp://fhir.kl.dk/children/ValueSet/KLHealthNurseInterventions 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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(KLGatewayChildrenCitizen) {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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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 | |||||
coding | Σ | 1..1 | Coding | [DK] indsatsskode Binding: Sundhedsplejeindsatser (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 | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://fhir.kl.dk/term/CodeSystem/FBOE | ||||
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 | ||||
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. | |||||
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] indsatsbegrundelse Binding: Sundhedsplejetilstande (required) | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
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. | ||||
performer | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |||||
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.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | ||||
CarePlan.activity.detail.code.coding | required | KLHealthNurseInterventionshttp://fhir.kl.dk/children/ValueSet/KLHealthNurseInterventions from this IG | ||||
CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
CarePlan.activity.detail.reasonCode.coding | required | KLHealthNurseConditionshttp://fhir.kl.dk/children/ValueSet/KLHealthNurseConditions 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
Other representations of profile: CSV, Excel, Schematron