Implementation Guide for FFB reporting (FFB uddatasæt)
1.0.0 - release
This page is part of the KLFFBReporting (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/ffbreporting/StructureDefinition/kl-reporting-ffb-intervention | Version: 1.0.0 | |||
Active as of 2023-08-27 | Computable Name: KLReportingFFBIntervention |
Intervention in a reported care plan
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 | 0..* | CarePlan | Healthcare plan for patient or group | |
identifier | 0..0 | |||
instantiatesCanonical | 0..0 | |||
instantiatesUri | 0..0 | |||
basedOn | S | 1..* | Reference(CarePlan) {b} | [DK] indsatsDelAfPlan |
replaces | 0..0 | |||
partOf | 0..0 | |||
status | S | 1..1 | code | [DK] indsatsstatus |
intent | S | 1..1 | code | [DK] indsatshensigt |
category | 0..0 | |||
title | 0..0 | |||
description | 0..0 | |||
subject | S | 1..1 | Reference(Citizen) {b} | [DK] indsatssubjekt |
encounter | 0..0 | |||
period | S | 0..1 | Period | Time period plan covers |
id | 0..0 | |||
start | S | 1..1 | dateTime | [DK] indsatsbevillingstid |
end | S | 0..1 | dateTime | [DK] indsatsafslutningstid |
created | S | 1..1 | dateTime | [DK] indsatsoprettelsestid |
author | 0..0 | |||
contributor | 0..0 | |||
careTeam | 0..0 | |||
addresses | 0..0 | |||
supportingInfo | 0..0 | |||
goal | 0..0 | |||
activity | S | 1..* | BackboneElement | Action to occur as part of plan |
id | 0..0 | |||
outcomeCodeableConcept | 0..0 | |||
outcomeReference | 0..0 | |||
progress | 0..0 | |||
reference | 0..0 | |||
detail | S | 1..1 | BackboneElement | In-line definition of activity |
id | 0..0 | |||
kind | 0..0 | |||
instantiatesCanonical | 0..0 | |||
instantiatesUri | 0..0 | |||
code | S | 1..1 | CodeableConcept | Detail type of activity |
id | 0..0 | |||
coding | S | 1..1 | Coding | [DK] indsatsskode Binding: KLYdelserFFB (required) |
text | 0..0 | |||
reasonCode | 0..0 | |||
reasonReference | 0..0 | |||
goal | 0..0 | |||
status | S | 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 |
CarePlan.activity.detail.code.coding | required | KLInterventionsFFB |
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 |
basedOn | SΣ | 1..* | Reference(CarePlan) {b} | [DK] indsatsDelAfPlan |
status | ?!SΣ | 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 | ?!SΣ | 1..1 | code | [DK] indsatshensigt Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. |
subject | SΣ | 1..1 | Reference(Citizen) {b} | [DK] indsatssubjekt |
period | SΣ | 0..1 | Period | Time period plan covers |
start | SΣC | 1..1 | dateTime | [DK] indsatsbevillingstid |
end | SΣC | 0..1 | dateTime | [DK] indsatsafslutningstid |
created | SΣ | 1..1 | dateTime | [DK] indsatsoprettelsestid |
activity | SC | 1..* | BackboneElement | Action to occur as part of plan |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
detail | SC | 1..1 | BackboneElement | In-line definition of activity |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | S | 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 | SΣ | 1..1 | Coding | [DK] indsatsskode Binding: KLYdelserFFB (required) |
status | ?!S | 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 |
CarePlan.status | required | RequestStatus |
CarePlan.intent | required | CarePlanIntent |
CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT) |
CarePlan.activity.detail.code.coding | required | KLInterventionsFFB |
CarePlan.activity.detail.status | required | CarePlanActivityStatus |
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 | ||||
basedOn | SΣ | 1..* | Reference(CarePlan) {b} | [DK] indsatsDelAfPlan | ||||
status | ?!SΣ | 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 | ?!SΣ | 1..1 | code | [DK] indsatshensigt Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||
subject | SΣ | 1..1 | Reference(Citizen) {b} | [DK] indsatssubjekt | ||||
period | SΣ | 0..1 | Period | Time period plan covers | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 1..1 | dateTime | [DK] indsatsbevillingstid | ||||
end | SΣC | 0..1 | dateTime | [DK] indsatsafslutningstid | ||||
created | SΣ | 1..1 | dateTime | [DK] indsatsoprettelsestid | ||||
activity | SC | 1..* | BackboneElement | Action to occur as part of plan | ||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
detail | SC | 1..1 | BackboneElement | In-line definition of activity | ||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | S | 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. | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..1 | Coding | [DK] indsatsskode Binding: KLYdelserFFB (required) | ||||
status | ?!S | 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 | ||||
CarePlan.language | preferred | CommonLanguages
| ||||
CarePlan.status | required | RequestStatus | ||||
CarePlan.intent | required | CarePlanIntent | ||||
CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT) | ||||
CarePlan.activity.detail.code.coding | required | KLInterventionsFFB | ||||
CarePlan.activity.detail.status | required | CarePlanActivityStatus |
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 | 0..* | CarePlan | Healthcare plan for patient or group | |
identifier | 0..0 | |||
instantiatesCanonical | 0..0 | |||
instantiatesUri | 0..0 | |||
basedOn | S | 1..* | Reference(CarePlan) {b} | [DK] indsatsDelAfPlan |
replaces | 0..0 | |||
partOf | 0..0 | |||
status | S | 1..1 | code | [DK] indsatsstatus |
intent | S | 1..1 | code | [DK] indsatshensigt |
category | 0..0 | |||
title | 0..0 | |||
description | 0..0 | |||
subject | S | 1..1 | Reference(Citizen) {b} | [DK] indsatssubjekt |
encounter | 0..0 | |||
period | S | 0..1 | Period | Time period plan covers |
id | 0..0 | |||
start | S | 1..1 | dateTime | [DK] indsatsbevillingstid |
end | S | 0..1 | dateTime | [DK] indsatsafslutningstid |
created | S | 1..1 | dateTime | [DK] indsatsoprettelsestid |
author | 0..0 | |||
contributor | 0..0 | |||
careTeam | 0..0 | |||
addresses | 0..0 | |||
supportingInfo | 0..0 | |||
goal | 0..0 | |||
activity | S | 1..* | BackboneElement | Action to occur as part of plan |
id | 0..0 | |||
outcomeCodeableConcept | 0..0 | |||
outcomeReference | 0..0 | |||
progress | 0..0 | |||
reference | 0..0 | |||
detail | S | 1..1 | BackboneElement | In-line definition of activity |
id | 0..0 | |||
kind | 0..0 | |||
instantiatesCanonical | 0..0 | |||
instantiatesUri | 0..0 | |||
code | S | 1..1 | CodeableConcept | Detail type of activity |
id | 0..0 | |||
coding | S | 1..1 | Coding | [DK] indsatsskode Binding: KLYdelserFFB (required) |
text | 0..0 | |||
reasonCode | 0..0 | |||
reasonReference | 0..0 | |||
goal | 0..0 | |||
status | S | 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 |
CarePlan.activity.detail.code.coding | required | KLInterventionsFFB |
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 |
basedOn | SΣ | 1..* | Reference(CarePlan) {b} | [DK] indsatsDelAfPlan |
status | ?!SΣ | 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 | ?!SΣ | 1..1 | code | [DK] indsatshensigt Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. |
subject | SΣ | 1..1 | Reference(Citizen) {b} | [DK] indsatssubjekt |
period | SΣ | 0..1 | Period | Time period plan covers |
start | SΣC | 1..1 | dateTime | [DK] indsatsbevillingstid |
end | SΣC | 0..1 | dateTime | [DK] indsatsafslutningstid |
created | SΣ | 1..1 | dateTime | [DK] indsatsoprettelsestid |
activity | SC | 1..* | BackboneElement | Action to occur as part of plan |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
detail | SC | 1..1 | BackboneElement | In-line definition of activity |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | S | 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 | SΣ | 1..1 | Coding | [DK] indsatsskode Binding: KLYdelserFFB (required) |
status | ?!S | 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 |
CarePlan.status | required | RequestStatus |
CarePlan.intent | required | CarePlanIntent |
CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT) |
CarePlan.activity.detail.code.coding | required | KLInterventionsFFB |
CarePlan.activity.detail.status | required | CarePlanActivityStatus |
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 | ||||
basedOn | SΣ | 1..* | Reference(CarePlan) {b} | [DK] indsatsDelAfPlan | ||||
status | ?!SΣ | 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 | ?!SΣ | 1..1 | code | [DK] indsatshensigt Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||
subject | SΣ | 1..1 | Reference(Citizen) {b} | [DK] indsatssubjekt | ||||
period | SΣ | 0..1 | Period | Time period plan covers | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 1..1 | dateTime | [DK] indsatsbevillingstid | ||||
end | SΣC | 0..1 | dateTime | [DK] indsatsafslutningstid | ||||
created | SΣ | 1..1 | dateTime | [DK] indsatsoprettelsestid | ||||
activity | SC | 1..* | BackboneElement | Action to occur as part of plan | ||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
detail | SC | 1..1 | BackboneElement | In-line definition of activity | ||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | S | 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. | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..1 | Coding | [DK] indsatsskode Binding: KLYdelserFFB (required) | ||||
status | ?!S | 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 | ||||
CarePlan.language | preferred | CommonLanguages
| ||||
CarePlan.status | required | RequestStatus | ||||
CarePlan.intent | required | CarePlanIntent | ||||
CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT) | ||||
CarePlan.activity.detail.code.coding | required | KLInterventionsFFB | ||||
CarePlan.activity.detail.status | required | CarePlanActivityStatus |
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