eHealth Infrastructure - Local Development build (v2022.1). See the Directory of published versions
Defining URL: | http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careplan |
Version: | 2022.1 |
Name: | ehealth-careplan |
Status: | Active as of 1/18/22, 9:57 AM |
Publisher: | Systematic | Trifork |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careplan
A CarePlan describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
In scope of the eHealth infrastructure CarePlans represent specific tele-medicine plans prepared by a Practitioner and applied to a specific Patient for the treatment a condition such as chronic obstructive pulmonary disease (COPD).
A CarePlan can be constructed as a hierarchy of sub plans. The initial hierarchy is inherited from the PlanDefinition, but can be modified for the specific patient. This modification is possible both when instantiating the CarePlan and during execution of the plan.
Sub plans can be attached by making them partOf
the parent plan.
In order to preserve the context and history, it is not allowed to delete sub plans or remove ServiceRequest from the CarePlan.
The status
element can be used to either cancel
or complete
a CarePlan or ServiceRequest, if it is no longer relevant for the Patient.
The history of changes in status
is automatically maintained in the element ehealth-careplan-statusHistory
.
A CarePlan can have a number of responsible CareTeam set in careTeam
. The history of changes in careTeam
is automatically maintained in the element ehealth-teamHistory
.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CarePlan
Summary
Mandatory: 4 elements (1 nested mandatory element)
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from CarePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | |
workflow-episodeOfCare | 1..1 | Reference(EpisodeOfCare) | Associated Encounter episode of care URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare | |
ehealth-careplan-statusHistory | 0..* | (Complex) | Careplan status history URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careplan-statusHistory | |
ehealth-teamHistory | 0..* | (Complex) | History of assigned careTeam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-teamHistory | |
ehealth-careplan-statusschedule | 0..* | (Complex) | Careplan status schedule URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careplan-statusschedule | |
ehealth-teamschedule | 0..* | (Complex) | Team Schedule URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-teamschedule | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External Ids for this plan |
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition |
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition |
partOf | Σ | 0..1 | Reference(ehealth-careplan) {r} | Part of referenced CarePlan |
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required) |
intent | ?!Σ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. |
category | Σ | 0..* | CodeableConcept | Type of plan Binding: Careplan Category (required) |
title | Σ | 0..1 | string | Human-friendly name for the care plan |
description | Σ | 0..1 | string | Summary of nature of plan |
subject | Σ | 1..1 | Reference(ehealth-patient) {r} | Who the care plan is for |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
period | Σ | 1..1 | Period | Time period plan covers |
created | Σ | 0..1 | dateTime | Date record was first recorded |
author | Σ | 0..1 | Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | ehealth-organization | ehealth-careteam) | Who is the designated responsible party |
contributor | 0..* | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who provided the content of the care plan | |
careTeam | 0..* | Reference(ehealth-careteam) {r} | Who's involved in plan? | |
addresses | Σ | 1..1 | Reference(ehealth-condition) {r} | Health issues this plan addresses |
supportingInfo | 0..* | Reference(Resource) {r} | Information considered as part of plan | |
goal | 0..* | Reference(ehealth-goal) {r} | Desired outcome of plan | |
activity | I | 0..* | 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 |
outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |
outcomeReference | 0..* | Reference(Resource) {r} | Appointment, Encounter, Procedure, etc. | |
progress | 0..* | Annotation | Comments about the activity status/progress | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
Slices for author[x] | Σ | 0..1 | Individual responsible for the annotation Slice: Unordered, Closed by type:$this | |
authorReference | Reference(Any) | |||
authorString | string | |||
author[x]:authorReference | Σ | 0..1 | Reference(ehealth-practitioner | ehealth-patient | ehealth-relatedperson) | Individual responsible for the annotation |
author[x]:authorString | Σ | 0..1 | string | Individual responsible for the annotation |
time | Σ | 0..1 | dateTime | When the annotation was made |
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) |
reference | I | 1..1 | Reference(ehealth-servicerequest) {rrb} | Activity details defined in specific resource |
detail | I | 0..1 | BackboneElement | In-line definition of activity |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. | |
instantiatesCanonical | 0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |
instantiatesUri | 0..* | uri | Instantiates external protocol or definition | |
code | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |
reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. | |
reasonReference | 0..* | Reference(ehealth-condition) {r} | Why activity is needed | |
goal | 0..* | Reference(Goal) {r} | Goals this activity relates to | |
status | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. |
statusReason | 0..1 | CodeableConcept | Reason for current status | |
doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action |
scheduled[x] | 0..1 | When activity is to occur | ||
scheduledTiming | Timing | |||
scheduledPeriod | Period | |||
scheduledString | string | |||
location | 0..1 | Reference(Location) {r} | Where it should happen | |
performer | 0..* | Reference(ehealth-practitioner | ehealth-organization | ehealth-relatedperson | ehealth-patient | ehealth-careteam) {r} | Who will be responsible? | |
product[x] | 0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||
productCodeableConcept | CodeableConcept | |||
productReference | Reference(Medication | Substance) | |||
dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |
quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |
description | 0..1 | string | Extra info describing activity to perform | |
note | 0..* | Annotation | Comments about the plan | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
Slices for author[x] | Σ | 0..1 | Individual responsible for the annotation Slice: Unordered, Closed by type:$this | |
authorReference | Reference(Any) | |||
authorString | string | |||
author[x]:authorReference | Σ | 0..1 | Reference(ehealth-practitioner | ehealth-patient | ehealth-relatedperson) | Individual responsible for the annotation |
author[x]:authorString | Σ | 0..1 | string | Individual responsible for the annotation |
time | Σ | 0..1 | dateTime | When the annotation was made |
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
Documentation for this format |
This structure is derived from CarePlan
Summary
Mandatory: 4 elements (1 nested mandatory element)
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from CarePlan
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | |
workflow-episodeOfCare | 1..1 | Reference(EpisodeOfCare) | Associated Encounter episode of care URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare | |
ehealth-careplan-statusHistory | 0..* | (Complex) | Careplan status history URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careplan-statusHistory | |
ehealth-teamHistory | 0..* | (Complex) | History of assigned careTeam URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-teamHistory | |
ehealth-careplan-statusschedule | 0..* | (Complex) | Careplan status schedule URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careplan-statusschedule | |
ehealth-teamschedule | 0..* | (Complex) | Team Schedule URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-teamschedule | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External Ids for this plan |
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition |
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition |
partOf | Σ | 0..1 | Reference(ehealth-careplan) {r} | Part of referenced CarePlan |
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required) |
intent | ?!Σ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. |
category | Σ | 0..* | CodeableConcept | Type of plan Binding: Careplan Category (required) |
title | Σ | 0..1 | string | Human-friendly name for the care plan |
description | Σ | 0..1 | string | Summary of nature of plan |
subject | Σ | 1..1 | Reference(ehealth-patient) {r} | Who the care plan is for |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
period | Σ | 1..1 | Period | Time period plan covers |
created | Σ | 0..1 | dateTime | Date record was first recorded |
author | Σ | 0..1 | Reference(ehealth-patient | ehealth-practitioner | ehealth-relatedperson | ehealth-organization | ehealth-careteam) | Who is the designated responsible party |
contributor | 0..* | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who provided the content of the care plan | |
careTeam | 0..* | Reference(ehealth-careteam) {r} | Who's involved in plan? | |
addresses | Σ | 1..1 | Reference(ehealth-condition) {r} | Health issues this plan addresses |
supportingInfo | 0..* | Reference(Resource) {r} | Information considered as part of plan | |
goal | 0..* | Reference(ehealth-goal) {r} | Desired outcome of plan | |
activity | I | 0..* | 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 |
outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |
outcomeReference | 0..* | Reference(Resource) {r} | Appointment, Encounter, Procedure, etc. | |
progress | 0..* | Annotation | Comments about the activity status/progress | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
Slices for author[x] | Σ | 0..1 | Individual responsible for the annotation Slice: Unordered, Closed by type:$this | |
authorReference | Reference(Any) | |||
authorString | string | |||
author[x]:authorReference | Σ | 0..1 | Reference(ehealth-practitioner | ehealth-patient | ehealth-relatedperson) | Individual responsible for the annotation |
author[x]:authorString | Σ | 0..1 | string | Individual responsible for the annotation |
time | Σ | 0..1 | dateTime | When the annotation was made |
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) |
reference | I | 1..1 | Reference(ehealth-servicerequest) {rrb} | Activity details defined in specific resource |
detail | I | 0..1 | BackboneElement | In-line definition of activity |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. | |
instantiatesCanonical | 0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |
instantiatesUri | 0..* | uri | Instantiates external protocol or definition | |
code | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |
reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. | |
reasonReference | 0..* | Reference(ehealth-condition) {r} | Why activity is needed | |
goal | 0..* | Reference(Goal) {r} | Goals this activity relates to | |
status | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. |
statusReason | 0..1 | CodeableConcept | Reason for current status | |
doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action |
scheduled[x] | 0..1 | When activity is to occur | ||
scheduledTiming | Timing | |||
scheduledPeriod | Period | |||
scheduledString | string | |||
location | 0..1 | Reference(Location) {r} | Where it should happen | |
performer | 0..* | Reference(ehealth-practitioner | ehealth-organization | ehealth-relatedperson | ehealth-patient | ehealth-careteam) {r} | Who will be responsible? | |
product[x] | 0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||
productCodeableConcept | CodeableConcept | |||
productReference | Reference(Medication | Substance) | |||
dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |
quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |
description | 0..1 | string | Extra info describing activity to perform | |
note | 0..* | Annotation | Comments about the plan | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
Slices for author[x] | Σ | 0..1 | Individual responsible for the annotation Slice: Unordered, Closed by type:$this | |
authorReference | Reference(Any) | |||
authorString | string | |||
author[x]:authorReference | Σ | 0..1 | Reference(ehealth-practitioner | ehealth-patient | ehealth-relatedperson) | Individual responsible for the annotation |
author[x]:authorString | Σ | 0..1 | string | Individual responsible for the annotation |
time | Σ | 0..1 | dateTime | When the annotation was made |
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
CarePlan.language | preferred | CommonLanguages Max Binding: AllLanguages |
CarePlan.status | required | RequestStatus |
CarePlan.intent | required | CarePlanIntent |
CarePlan.category | required | CareplanCategory |
CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcome |
CarePlan.activity.detail.kind | required | CarePlanActivityKind |
CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT) |
CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindings |
CarePlan.activity.detail.status | required | CarePlanActivityStatus |
CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodes |
Id | Grade | Path | Details | Requirements |
cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both : detail.empty() or reference.empty() |