HL7 Europe Hospital Discharge Report
1.0.0-ci - draft
150
HL7 Europe Hospital Discharge Report
1.0.0-ci - draft
150
HL7 Europe Hospital Discharge Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/hdr/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/hdr/StructureDefinition/carePlan-obl-eu-hdr | Version: 1.0.0-ci | |||
| Standards status: Informative | Maturity Level: 0 | Computable Name: CarePlanEuHdrObligation | ||
Copyright/Legal: Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0). |
||||
This profile defines obligations for the CarePlan resource for the purpose of this guide.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  CarePlan |
0..* | CarePlanEuHdr | Healthcare plan for patient
| |||||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
 text |
O | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| ||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| status |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown 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 | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||||||
| title |
OΣ | 0..1 | string | Human-friendly name for the care plan
| ||||||||
| description |
OΣ | 0..1 | string | Summary of nature of plan
| ||||||||
 subject |
Σ | 1..1 | Reference(Patient: obligations) | Who the care plan is for | ||||||||
| period |
OΣ | 0..1 | Period | Time period plan covers
| ||||||||
| addresses |
Σ | 0..* | Reference(Condition: obligations) | Health issues this plan addresses | ||||||||
 activity |
OC | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3, cpl-hdr-1
| ||||||||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| reference |
OC | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource
| ||||||||
| detail |
OC | 0..1 | BackboneElement | Deprecated in R5/R6
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| kind |
O | 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.
| ||||||||
| 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. | ||||||||
| doNotPerform |
?! | 0..1 | boolean | If true, activity is prohibiting action | ||||||||
 description |
O | 0..1 | string | Extra info describing activity to perform
| ||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| CarePlan.intent | Base | required | Care Plan Intent | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.kind | Base | required | Care Plan Activity Kind | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.status | Base | required | CarePlanActivityStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both |
detail.empty() or reference.empty()
|
| cpl-hdr-1 | warning | CarePlan.activity | CarePlan.activity.detail is deprecated and no more present in FHIR R5. |
detail.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 CarePlanEuHdr
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CarePlan |
CarePlanEuHdr |
| ||||||||||
 text |
O | 0..1 | Narrative | Text summary of the resource, for human interpretation
| ||||||||
| title |
O | 0..1 | string | Human-friendly name for the care plan
| ||||||||
| description |
O | 0..1 | string | Summary of nature of plan
| ||||||||
| subject |
1..1 | Reference(Patient: obligations) | Who the care plan is for | |||||||||
| period |
O | 0..1 | Period | Time period plan covers
| ||||||||
| addresses |
0..* | Reference(Condition: obligations) | Health issues this plan addresses | |||||||||
| activity |
O | 0..* | BackboneElement | Action to occur as part of plan
| ||||||||
| reference |
O | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource
| ||||||||
| detail |
O | 0..1 | BackboneElement | Deprecated in R5/R6
| ||||||||
| kind |
O | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
| ||||||||
| description |
O | 0..1 | string | Extra info describing activity to perform
| ||||||||
| Documentation for this format | ||||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CarePlan |
0..* | CarePlanEuHdr | Healthcare plan for patient
| |||||||||
| 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 |
O | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| ||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| identifier |
Σ | 0..* | Identifier | External Ids for this plan | ||||||||
| instantiatesCanonical |
Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiated Canonical | ||||||||
| instantiatesUri |
Σ | 0..* | uri | Instantiated URI | ||||||||
| basedOn |
Σ | 0..* | Reference(CarePlan) | Fulfills CarePlan | ||||||||
| replaces |
Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | ||||||||
| partOf |
Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | ||||||||
| status |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown 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 | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||||||
| category |
Σ | 0..* | CodeableConcept | Kind of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | ||||||||
| title |
OΣ | 0..1 | string | Human-friendly name for the care plan
| ||||||||
| description |
OΣ | 0..1 | string | Summary of nature of plan
| ||||||||
| subject |
Σ | 1..1 | Reference(Patient: obligations) | Who the care plan is for | ||||||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||||||
| period |
OΣ | 0..1 | Period | Time period plan covers
| ||||||||
| created |
Σ | 0..1 | dateTime | Date the plan was created | ||||||||
| author |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | 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(CareTeam) | Participants in the care plan | |||||||||
| addresses |
Σ | 0..* | Reference(Condition: obligations) | Health issues this plan addresses | ||||||||
| supportingInfo |
0..* | Reference(Resource) | Information considered as part of the care plan | |||||||||
| goal |
0..* | Reference(Goal (HDR)) | Desired outcome of plan | |||||||||
 activity |
OC | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3, cpl-hdr-1
| ||||||||
 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 | Codeable Outcome summary Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||||||
| outcomeReference |
0..* | Reference(Resource) | Outcome evidence | |||||||||
| progress |
0..* | Annotation | Notes about the progress of the activity | |||||||||
| reference |
OC | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource
| ||||||||
| detail |
OC | 0..1 | BackboneElement | Deprecated in R5/R6
| ||||||||
| 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 |
O | 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(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed | |||||||||
| goal |
0..* | Reference(Goal) | 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) | Where it should happen | |||||||||
| performer |
0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | 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(4.0.1) | How to consume/day? | |||||||||
| quantity |
0..1 | SimpleQuantity(4.0.1) | How much to administer/supply/consume | |||||||||
| description |
O | 0..1 | string | Extra info describing activity to perform
| ||||||||
| note |
0..* | Annotation | Comments about the plan | |||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| CarePlan.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| CarePlan.intent | Base | required | Care Plan Intent | 📍4.0.1 | FHIR Std. |
| CarePlan.category | Base | example | Care Plan Category | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.outcomeCodeableConcept | Base | example | Care Plan Activity Outcome | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.kind | Base | required | Care Plan Activity Kind | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.code | Base | example | Procedure Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.reasonCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.status | Base | required | CarePlanActivityStatus | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.product[x] | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both |
detail.empty() or reference.empty()
|
| cpl-hdr-1 | warning | CarePlan.activity | CarePlan.activity.detail is deprecated and no more present in FHIR R5. |
detail.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 CarePlanEuHdr
Summary
Structures
This structure refers to these other structures:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CarePlan |
0..* | CarePlanEuHdr | Healthcare plan for patient
| |||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| text |
O | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| ||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| status |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown 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 | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||||||
| title |
OΣ | 0..1 | string | Human-friendly name for the care plan
| ||||||||
| description |
OΣ | 0..1 | string | Summary of nature of plan
| ||||||||
| subject |
Σ | 1..1 | Reference(Patient: obligations) | Who the care plan is for | ||||||||
| period |
OΣ | 0..1 | Period | Time period plan covers
| ||||||||
| addresses |
Σ | 0..* | Reference(Condition: obligations) | Health issues this plan addresses | ||||||||
| activity |
OC | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3, cpl-hdr-1
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| reference |
OC | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource
| ||||||||
| detail |
OC | 0..1 | BackboneElement | Deprecated in R5/R6
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| kind |
O | 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.
| ||||||||
| 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. | ||||||||
| doNotPerform |
?! | 0..1 | boolean | If true, activity is prohibiting action | ||||||||
| description |
O | 0..1 | string | Extra info describing activity to perform
| ||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| CarePlan.intent | Base | required | Care Plan Intent | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.kind | Base | required | Care Plan Activity Kind | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.status | Base | required | CarePlanActivityStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both |
detail.empty() or reference.empty()
|
| cpl-hdr-1 | warning | CarePlan.activity | CarePlan.activity.detail is deprecated and no more present in FHIR R5. |
detail.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()
|
Differential View
This structure is derived from CarePlanEuHdr
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CarePlan |
CarePlanEuHdr |
| ||||||||||
| text |
O | 0..1 | Narrative | Text summary of the resource, for human interpretation
| ||||||||
| title |
O | 0..1 | string | Human-friendly name for the care plan
| ||||||||
| description |
O | 0..1 | string | Summary of nature of plan
| ||||||||
| subject |
1..1 | Reference(Patient: obligations) | Who the care plan is for | |||||||||
| period |
O | 0..1 | Period | Time period plan covers
| ||||||||
| addresses |
0..* | Reference(Condition: obligations) | Health issues this plan addresses | |||||||||
| activity |
O | 0..* | BackboneElement | Action to occur as part of plan
| ||||||||
| reference |
O | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource
| ||||||||
| detail |
O | 0..1 | BackboneElement | Deprecated in R5/R6
| ||||||||
| kind |
O | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
| ||||||||
| description |
O | 0..1 | string | Extra info describing activity to perform
| ||||||||
| Documentation for this format | ||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CarePlan |
0..* | CarePlanEuHdr | Healthcare plan for patient
| |||||||||
| 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 |
O | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| ||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
| identifier |
Σ | 0..* | Identifier | External Ids for this plan | ||||||||
| instantiatesCanonical |
Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiated Canonical | ||||||||
| instantiatesUri |
Σ | 0..* | uri | Instantiated URI | ||||||||
| basedOn |
Σ | 0..* | Reference(CarePlan) | Fulfills CarePlan | ||||||||
| replaces |
Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | ||||||||
| partOf |
Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | ||||||||
| status |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown 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 | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||||||
| category |
Σ | 0..* | CodeableConcept | Kind of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | ||||||||
| title |
OΣ | 0..1 | string | Human-friendly name for the care plan
| ||||||||
| description |
OΣ | 0..1 | string | Summary of nature of plan
| ||||||||
| subject |
Σ | 1..1 | Reference(Patient: obligations) | Who the care plan is for | ||||||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||||||
| period |
OΣ | 0..1 | Period | Time period plan covers
| ||||||||
| created |
Σ | 0..1 | dateTime | Date the plan was created | ||||||||
| author |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | 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(CareTeam) | Participants in the care plan | |||||||||
| addresses |
Σ | 0..* | Reference(Condition: obligations) | Health issues this plan addresses | ||||||||
| supportingInfo |
0..* | Reference(Resource) | Information considered as part of the care plan | |||||||||
| goal |
0..* | Reference(Goal (HDR)) | Desired outcome of plan | |||||||||
| activity |
OC | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3, cpl-hdr-1
| ||||||||
| 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 | Codeable Outcome summary Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||||||
| outcomeReference |
0..* | Reference(Resource) | Outcome evidence | |||||||||
| progress |
0..* | Annotation | Notes about the progress of the activity | |||||||||
| reference |
OC | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource
| ||||||||
| detail |
OC | 0..1 | BackboneElement | Deprecated in R5/R6
| ||||||||
| 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 |
O | 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(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed | |||||||||
| goal |
0..* | Reference(Goal) | 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) | Where it should happen | |||||||||
| performer |
0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | 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(4.0.1) | How to consume/day? | |||||||||
| quantity |
0..1 | SimpleQuantity(4.0.1) | How much to administer/supply/consume | |||||||||
| description |
O | 0..1 | string | Extra info describing activity to perform
| ||||||||
| note |
0..* | Annotation | Comments about the plan | |||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| CarePlan.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| CarePlan.intent | Base | required | Care Plan Intent | 📍4.0.1 | FHIR Std. |
| CarePlan.category | Base | example | Care Plan Category | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.outcomeCodeableConcept | Base | example | Care Plan Activity Outcome | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.kind | Base | required | Care Plan Activity Kind | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.code | Base | example | Procedure Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.reasonCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.status | Base | required | CarePlanActivityStatus | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.product[x] | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both |
detail.empty() or reference.empty()
|
| cpl-hdr-1 | warning | CarePlan.activity | CarePlan.activity.detail is deprecated and no more present in FHIR R5. |
detail.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 CarePlanEuHdr
Summary
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 Europe. Package hl7.fhir.eu.hdr#1.0.0-ci based on FHIR 4.0.1. Generated 2026-06-26
