Implementation Guide for FFB reporting (FFB uddatasæt)
1.0.0 - release
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 in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| Official URL: http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-carePlan | Version: 1.0.0 | |||
| Active as of 2023-08-27 | Computable Name: KLReportingFFBCarePlan | |||
FFB 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 | C | 0..* | CarePlan | Healthcare plan for patient or group kl-reporting-ffb-care-plan-1: CarePlan must have a follow-up encounter if ordered and not completed kl-reporting-ffb-care-plan-2: CarePlan shall address no more than one condition with rank 1 kl-reporting-ffb-care-plan-4: CarePlan shall contain evaluation if ordered and not completed kl-reporting-ffb-care-plan-5: CarePlan shall contain target groups if ordered and not completed |
  Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
 municipalityCaseNumber | S | 1..1 | (Complex) | [DK] anledningDokumenteretISag URL: http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-municipalityCaseNumber |
| followUpDate | S | 0..1 | Reference(FollowUpEncounter) {b} | FollowUpDateExtension URL: http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-follow-up-date-extension |
 identifier | 0..0 | |||
| instantiatesCanonical | 0..0 | |||
| instantiatesUri | 0..0 | |||
| basedOn | 0..0 | |||
| replaces | 0..0 | |||
| partOf | 0..0 | |||
| status | S | 1..1 | code | [DK] indsatsforløbstatus |
| intent | S | 1..1 | code | [DK] indsatsforløbhensigt |
| category | 0..0 | |||
| title | 0..0 | |||
| description | 0..0 | |||
 subject | S | 1..1 | Reference(Citizen) {b} | [DK] indsatsforløbsubjekt |
| encounter | 0..0 | |||
 period | S | 1..1 | Period | Time period plan covers |
 start | S | 1..1 | dateTime | [DK] indsatsforløbBevillingstid |
 end | 0..1 | dateTime | [DK] indsatsforløbAfslutningstid | |
| created | 0..0 | |||
| author | 0..0 | |||
| contributor | 0..0 | |||
| careTeam | S | 0..* | Reference(CareTeam) | [DK] indsatsforløbsleverandør og indsatsforløbtilbud |
| addresses | S | 0..* | Reference(TargetGroup) {b} | [DK] indsatsforløbmålgruppe |
| extension | 1..* | Extension | Extension | |
| conditionRank | S | 1..1 | positiveInt | [DK] indsatsforløbsmålgruppeRang - 1 = primær, 2 = sekundær URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank |
 value[x] | 1..1 | positiveInt | Value of extension | |
| reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | 0..0 | |||
| identifier | 0..0 | |||
| display | 0..0 | |||
| supportingInfo | 0..0 | |||
| goal | S | 0..* | Reference(InterventionGoal) {b} | [DK] indsatsforløbsmål |
| activity | S | 0..1 | BackboneElement | Action to occur as part of plan |
| outcomeCodeableConcept | 0..0 | |||
| outcomeReference | S | 1..1 | Reference(CareEvaluation) {b} | [DK] støttebehovsvurdering |
| progress | 0..0 | |||
| reference | 0..0 | |||
| detail | 0..0 | |||
| note | 0..0 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| kl-reporting-ffb-care-plan-1 | error | CarePlan | CarePlan must have a follow-up encounter if ordered and not completed : (intent != 'order') or (status = 'completed') or extension('http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-follow-up-date-extension').exists() | |
| kl-reporting-ffb-care-plan-2 | error | CarePlan | CarePlan shall address no more than one condition with rank 1 : addresses.where(extension('http://fhir.kl.dk/core/StructureDefinition/ConditionRank').valuePositiveInt = '1').count() < 2 | |
| kl-reporting-ffb-care-plan-4 | error | CarePlan | CarePlan shall contain evaluation if ordered and not completed : (intent != 'order') or (status = 'completed') or activity.outcomeReference.exists() | |
| kl-reporting-ffb-care-plan-5 | error | CarePlan | CarePlan shall contain target groups if ordered and not completed : (intent != 'order') or (status = 'completed') or addresses.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CarePlan | C | 0..* | CarePlan | Healthcare plan for patient or group kl-reporting-ffb-care-plan-1: CarePlan must have a follow-up encounter if ordered and not completed kl-reporting-ffb-care-plan-2: CarePlan shall address no more than one condition with rank 1 kl-reporting-ffb-care-plan-4: CarePlan shall contain evaluation if ordered and not completed kl-reporting-ffb-care-plan-5: CarePlan shall contain target groups if ordered and not completed |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| municipalityCaseNumber | S | 1..1 | (Complex) | [DK] anledningDokumenteretISag URL: http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-municipalityCaseNumber |
| followUpDate | S | 0..1 | Reference(FollowUpEncounter) {b} | FollowUpDateExtension URL: http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-follow-up-date-extension |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 1..1 | code | [DK] indsatsforløbstatus Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. |
| intent | ?!SΣ | 1..1 | code | [DK] indsatsforløbhensigt Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. |
| subject | SΣ | 1..1 | Reference(Citizen) {b} | [DK] indsatsforløbsubjekt |
 period | SΣ | 1..1 | Period | Time period plan covers |
| start | SΣC | 1..1 | dateTime | [DK] indsatsforløbBevillingstid |
| end | ΣC | 0..1 | dateTime | [DK] indsatsforløbAfslutningstid |
| careTeam | S | 0..* | Reference(CareTeam) | [DK] indsatsforløbsleverandør og indsatsforløbtilbud |
| addresses | SΣ | 0..* | Reference(TargetGroup) {b} | [DK] indsatsforløbmålgruppe |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| conditionRank | S | 1..1 | positiveInt | [DK] indsatsforløbsmålgruppeRang - 1 = primær, 2 = sekundær URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank |
 extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.kl.dk/core/StructureDefinition/ConditionRank" | |
| value[x] | 1..1 | positiveInt | Value of extension | |
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| goal | S | 0..* | Reference(InterventionGoal) {b} | [DK] indsatsforløbsmål |
 activity | SC | 0..1 | BackboneElement | Action to occur as part of plan |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| outcomeReference | S | 1..1 | Reference(CareEvaluation) {b} | [DK] støttebehovsvurdering |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| CarePlan.status | required | RequestStatus |
| CarePlan.intent | required | CarePlanIntent |
| 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() | |
| kl-reporting-ffb-care-plan-1 | error | CarePlan | CarePlan must have a follow-up encounter if ordered and not completed : (intent != 'order') or (status = 'completed') or extension('http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-follow-up-date-extension').exists() | |
| kl-reporting-ffb-care-plan-2 | error | CarePlan | CarePlan shall address no more than one condition with rank 1 : addresses.where(extension('http://fhir.kl.dk/core/StructureDefinition/ConditionRank').valuePositiveInt = '1').count() < 2 | |
| kl-reporting-ffb-care-plan-4 | error | CarePlan | CarePlan shall contain evaluation if ordered and not completed : (intent != 'order') or (status = 'completed') or activity.outcomeReference.exists() | |
| kl-reporting-ffb-care-plan-5 | error | CarePlan | CarePlan shall contain target groups if ordered and not completed : (intent != 'order') or (status = 'completed') or addresses.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| CarePlan | C | 0..* | CarePlan | Healthcare plan for patient or group kl-reporting-ffb-care-plan-1: CarePlan must have a follow-up encounter if ordered and not completed kl-reporting-ffb-care-plan-2: CarePlan shall address no more than one condition with rank 1 kl-reporting-ffb-care-plan-4: CarePlan shall contain evaluation if ordered and not completed kl-reporting-ffb-care-plan-5: CarePlan shall contain target groups if ordered and not completed | ||||
| 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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| municipalityCaseNumber | S | 1..1 | (Complex) | [DK] anledningDokumenteretISag URL: http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-municipalityCaseNumber | ||||
| followUpDate | S | 0..1 | Reference(FollowUpEncounter) {b} | FollowUpDateExtension URL: http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-follow-up-date-extension | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| status | ?!SΣ | 1..1 | code | [DK] indsatsforløbstatus Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | ||||
| intent | ?!SΣ | 1..1 | code | [DK] indsatsforløbhensigt Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||
| subject | SΣ | 1..1 | Reference(Citizen) {b} | [DK] indsatsforløbsubjekt | ||||
| period | SΣ | 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 | SΣC | 1..1 | dateTime | [DK] indsatsforløbBevillingstid | ||||
| end | ΣC | 0..1 | dateTime | [DK] indsatsforløbAfslutningstid | ||||
| careTeam | S | 0..* | Reference(CareTeam) | [DK] indsatsforløbsleverandør og indsatsforløbtilbud | ||||
| addresses | SΣ | 0..* | Reference(TargetGroup) {b} | [DK] indsatsforløbmålgruppe | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| conditionRank | S | 1..1 | positiveInt | [DK] indsatsforløbsmålgruppeRang - 1 = primær, 2 = sekundær URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://fhir.kl.dk/core/StructureDefinition/ConditionRank" | |||||
| value[x] | 1..1 | positiveInt | Value of extension | |||||
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| goal | S | 0..* | Reference(InterventionGoal) {b} | [DK] indsatsforløbsmål | ||||
| activity | SC | 0..1 | BackboneElement | Action to occur as part of plan | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| outcomeReference | S | 1..1 | Reference(CareEvaluation) {b} | [DK] støttebehovsvurdering | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| CarePlan.language | preferred | CommonLanguages
| ||||
| CarePlan.status | required | RequestStatus | ||||
| CarePlan.intent | required | CarePlanIntent | ||||
| CarePlan.activity.detail.kind | required | CarePlanActivityKind | ||||
| CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT) | ||||
| CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindings | ||||
| CarePlan.activity.detail.status | required | CarePlanActivityStatus | ||||
| CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodes |
| 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() | |
| kl-reporting-ffb-care-plan-1 | error | CarePlan | CarePlan must have a follow-up encounter if ordered and not completed : (intent != 'order') or (status = 'completed') or extension('http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-follow-up-date-extension').exists() | |
| kl-reporting-ffb-care-plan-2 | error | CarePlan | CarePlan shall address no more than one condition with rank 1 : addresses.where(extension('http://fhir.kl.dk/core/StructureDefinition/ConditionRank').valuePositiveInt = '1').count() < 2 | |
| kl-reporting-ffb-care-plan-4 | error | CarePlan | CarePlan shall contain evaluation if ordered and not completed : (intent != 'order') or (status = 'completed') or activity.outcomeReference.exists() | |
| kl-reporting-ffb-care-plan-5 | error | CarePlan | CarePlan shall contain target groups if ordered and not completed : (intent != 'order') or (status = 'completed') or addresses.exists() |
This structure is derived from CarePlan
Summary
Mandatory: 4 elements (4 nested mandatory elements)
Must-Support: 14 elements
Prohibited: 22 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from CarePlan
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CarePlan | C | 0..* | CarePlan | Healthcare plan for patient or group kl-reporting-ffb-care-plan-1: CarePlan must have a follow-up encounter if ordered and not completed kl-reporting-ffb-care-plan-2: CarePlan shall address no more than one condition with rank 1 kl-reporting-ffb-care-plan-4: CarePlan shall contain evaluation if ordered and not completed kl-reporting-ffb-care-plan-5: CarePlan shall contain target groups if ordered and not completed |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| municipalityCaseNumber | S | 1..1 | (Complex) | [DK] anledningDokumenteretISag URL: http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-municipalityCaseNumber |
| followUpDate | S | 0..1 | Reference(FollowUpEncounter) {b} | FollowUpDateExtension URL: http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-follow-up-date-extension |
| identifier | 0..0 | |||
| instantiatesCanonical | 0..0 | |||
| instantiatesUri | 0..0 | |||
| basedOn | 0..0 | |||
| replaces | 0..0 | |||
| partOf | 0..0 | |||
| status | S | 1..1 | code | [DK] indsatsforløbstatus |
| intent | S | 1..1 | code | [DK] indsatsforløbhensigt |
| category | 0..0 | |||
| title | 0..0 | |||
| description | 0..0 | |||
| subject | S | 1..1 | Reference(Citizen) {b} | [DK] indsatsforløbsubjekt |
| encounter | 0..0 | |||
| period | S | 1..1 | Period | Time period plan covers |
| start | S | 1..1 | dateTime | [DK] indsatsforløbBevillingstid |
| end | 0..1 | dateTime | [DK] indsatsforløbAfslutningstid | |
| created | 0..0 | |||
| author | 0..0 | |||
| contributor | 0..0 | |||
| careTeam | S | 0..* | Reference(CareTeam) | [DK] indsatsforløbsleverandør og indsatsforløbtilbud |
| addresses | S | 0..* | Reference(TargetGroup) {b} | [DK] indsatsforløbmålgruppe |
| extension | 1..* | Extension | Extension | |
| conditionRank | S | 1..1 | positiveInt | [DK] indsatsforløbsmålgruppeRang - 1 = primær, 2 = sekundær URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank |
| value[x] | 1..1 | positiveInt | Value of extension | |
| reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | 0..0 | |||
| identifier | 0..0 | |||
| display | 0..0 | |||
| supportingInfo | 0..0 | |||
| goal | S | 0..* | Reference(InterventionGoal) {b} | [DK] indsatsforløbsmål |
| activity | S | 0..1 | BackboneElement | Action to occur as part of plan |
| outcomeCodeableConcept | 0..0 | |||
| outcomeReference | S | 1..1 | Reference(CareEvaluation) {b} | [DK] støttebehovsvurdering |
| progress | 0..0 | |||
| reference | 0..0 | |||
| detail | 0..0 | |||
| note | 0..0 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| kl-reporting-ffb-care-plan-1 | error | CarePlan | CarePlan must have a follow-up encounter if ordered and not completed : (intent != 'order') or (status = 'completed') or extension('http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-follow-up-date-extension').exists() | |
| kl-reporting-ffb-care-plan-2 | error | CarePlan | CarePlan shall address no more than one condition with rank 1 : addresses.where(extension('http://fhir.kl.dk/core/StructureDefinition/ConditionRank').valuePositiveInt = '1').count() < 2 | |
| kl-reporting-ffb-care-plan-4 | error | CarePlan | CarePlan shall contain evaluation if ordered and not completed : (intent != 'order') or (status = 'completed') or activity.outcomeReference.exists() | |
| kl-reporting-ffb-care-plan-5 | error | CarePlan | CarePlan shall contain target groups if ordered and not completed : (intent != 'order') or (status = 'completed') or addresses.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CarePlan | C | 0..* | CarePlan | Healthcare plan for patient or group kl-reporting-ffb-care-plan-1: CarePlan must have a follow-up encounter if ordered and not completed kl-reporting-ffb-care-plan-2: CarePlan shall address no more than one condition with rank 1 kl-reporting-ffb-care-plan-4: CarePlan shall contain evaluation if ordered and not completed kl-reporting-ffb-care-plan-5: CarePlan shall contain target groups if ordered and not completed |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| municipalityCaseNumber | S | 1..1 | (Complex) | [DK] anledningDokumenteretISag URL: http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-municipalityCaseNumber |
| followUpDate | S | 0..1 | Reference(FollowUpEncounter) {b} | FollowUpDateExtension URL: http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-follow-up-date-extension |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 1..1 | code | [DK] indsatsforløbstatus Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. |
| intent | ?!SΣ | 1..1 | code | [DK] indsatsforløbhensigt Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. |
| subject | SΣ | 1..1 | Reference(Citizen) {b} | [DK] indsatsforløbsubjekt |
| period | SΣ | 1..1 | Period | Time period plan covers |
| start | SΣC | 1..1 | dateTime | [DK] indsatsforløbBevillingstid |
| end | ΣC | 0..1 | dateTime | [DK] indsatsforløbAfslutningstid |
| careTeam | S | 0..* | Reference(CareTeam) | [DK] indsatsforløbsleverandør og indsatsforløbtilbud |
| addresses | SΣ | 0..* | Reference(TargetGroup) {b} | [DK] indsatsforløbmålgruppe |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| conditionRank | S | 1..1 | positiveInt | [DK] indsatsforløbsmålgruppeRang - 1 = primær, 2 = sekundær URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://fhir.kl.dk/core/StructureDefinition/ConditionRank" | |
| value[x] | 1..1 | positiveInt | Value of extension | |
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| goal | S | 0..* | Reference(InterventionGoal) {b} | [DK] indsatsforløbsmål |
| activity | SC | 0..1 | BackboneElement | Action to occur as part of plan |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| outcomeReference | S | 1..1 | Reference(CareEvaluation) {b} | [DK] støttebehovsvurdering |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| CarePlan.status | required | RequestStatus |
| CarePlan.intent | required | CarePlanIntent |
| 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() | |
| kl-reporting-ffb-care-plan-1 | error | CarePlan | CarePlan must have a follow-up encounter if ordered and not completed : (intent != 'order') or (status = 'completed') or extension('http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-follow-up-date-extension').exists() | |
| kl-reporting-ffb-care-plan-2 | error | CarePlan | CarePlan shall address no more than one condition with rank 1 : addresses.where(extension('http://fhir.kl.dk/core/StructureDefinition/ConditionRank').valuePositiveInt = '1').count() < 2 | |
| kl-reporting-ffb-care-plan-4 | error | CarePlan | CarePlan shall contain evaluation if ordered and not completed : (intent != 'order') or (status = 'completed') or activity.outcomeReference.exists() | |
| kl-reporting-ffb-care-plan-5 | error | CarePlan | CarePlan shall contain target groups if ordered and not completed : (intent != 'order') or (status = 'completed') or addresses.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| CarePlan | C | 0..* | CarePlan | Healthcare plan for patient or group kl-reporting-ffb-care-plan-1: CarePlan must have a follow-up encounter if ordered and not completed kl-reporting-ffb-care-plan-2: CarePlan shall address no more than one condition with rank 1 kl-reporting-ffb-care-plan-4: CarePlan shall contain evaluation if ordered and not completed kl-reporting-ffb-care-plan-5: CarePlan shall contain target groups if ordered and not completed | ||||
| 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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| municipalityCaseNumber | S | 1..1 | (Complex) | [DK] anledningDokumenteretISag URL: http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-municipalityCaseNumber | ||||
| followUpDate | S | 0..1 | Reference(FollowUpEncounter) {b} | FollowUpDateExtension URL: http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-follow-up-date-extension | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| status | ?!SΣ | 1..1 | code | [DK] indsatsforløbstatus Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | ||||
| intent | ?!SΣ | 1..1 | code | [DK] indsatsforløbhensigt Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||
| subject | SΣ | 1..1 | Reference(Citizen) {b} | [DK] indsatsforløbsubjekt | ||||
| period | SΣ | 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 | SΣC | 1..1 | dateTime | [DK] indsatsforløbBevillingstid | ||||
| end | ΣC | 0..1 | dateTime | [DK] indsatsforløbAfslutningstid | ||||
| careTeam | S | 0..* | Reference(CareTeam) | [DK] indsatsforløbsleverandør og indsatsforløbtilbud | ||||
| addresses | SΣ | 0..* | Reference(TargetGroup) {b} | [DK] indsatsforløbmålgruppe | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| conditionRank | S | 1..1 | positiveInt | [DK] indsatsforløbsmålgruppeRang - 1 = primær, 2 = sekundær URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://fhir.kl.dk/core/StructureDefinition/ConditionRank" | |||||
| value[x] | 1..1 | positiveInt | Value of extension | |||||
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| goal | S | 0..* | Reference(InterventionGoal) {b} | [DK] indsatsforløbsmål | ||||
| activity | SC | 0..1 | BackboneElement | Action to occur as part of plan | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| outcomeReference | S | 1..1 | Reference(CareEvaluation) {b} | [DK] støttebehovsvurdering | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| CarePlan.language | preferred | CommonLanguages
| ||||
| CarePlan.status | required | RequestStatus | ||||
| CarePlan.intent | required | CarePlanIntent | ||||
| CarePlan.activity.detail.kind | required | CarePlanActivityKind | ||||
| CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT) | ||||
| CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindings | ||||
| CarePlan.activity.detail.status | required | CarePlanActivityStatus | ||||
| CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodes |
| 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() | |
| kl-reporting-ffb-care-plan-1 | error | CarePlan | CarePlan must have a follow-up encounter if ordered and not completed : (intent != 'order') or (status = 'completed') or extension('http://fhir.kl.dk/ffbreporting/StructureDefinition/kl-reporting-ffb-follow-up-date-extension').exists() | |
| kl-reporting-ffb-care-plan-2 | error | CarePlan | CarePlan shall address no more than one condition with rank 1 : addresses.where(extension('http://fhir.kl.dk/core/StructureDefinition/ConditionRank').valuePositiveInt = '1').count() < 2 | |
| kl-reporting-ffb-care-plan-4 | error | CarePlan | CarePlan shall contain evaluation if ordered and not completed : (intent != 'order') or (status = 'completed') or activity.outcomeReference.exists() | |
| kl-reporting-ffb-care-plan-5 | error | CarePlan | CarePlan shall contain target groups if ordered and not completed : (intent != 'order') or (status = 'completed') or addresses.exists() |
This structure is derived from CarePlan
Summary
Mandatory: 4 elements (4 nested mandatory elements)
Must-Support: 14 elements
Prohibited: 22 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron