HL7 Europe Discharge Report
1.0.0-ci-build - ci-build 150

HL7 Europe Discharge Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/discharge-report/ and changes regularly. See the Directory of published versions

Resource Profile: CarePlan (DR)

Official URL: http://hl7.eu/fhir/discharge-report/StructureDefinition/carePlan-eu-dr Version: 1.0.0-ci-build
Standards status: Draft Maturity Level: 1 Computable Name: CarePlanEuDr

Copyright/Legal: Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0).

This profile constrains the CarePlan resource for the purpose of this guide.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CarePlan 0..* CarePlan Healthcare plan for patient
CarePlan.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
CarePlan.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
CarePlan.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
CarePlan.identifier This element is included in summaries. 0..* Identifier External Ids for this plan
CarePlan.instantiatesCanonical This element is included in summaries. 0..* canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiated Canonical
CarePlan.instantiatesUri This element is included in summaries. 0..* uri Instantiated URI
CarePlan.status This element is a modifier element. This element is included in summaries. 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.
CarePlan.intent This element is a modifier element. This element is included in summaries. 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
CarePlan.category This element is included in summaries. 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.
CarePlan.title This element is included in summaries. 0..1 string Human-friendly name for the care plan
CarePlan.description This element is included in summaries. 0..1 string Summary of nature of plan
CarePlan.subject This element is included in summaries. 1..1 Reference(Patient (EU core)) Who the care plan is for
CarePlan.period This element is included in summaries. 0..1 Period Time period plan covers
CarePlan.created This element is included in summaries. 0..1 dateTime Date the plan was created
CarePlan.author This element is included in summaries. 0..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who is the designated responsible party
CarePlan.careTeam 0..* Reference(CareTeam) Participants in the care plan
CarePlan.addresses This element is included in summaries. 0..* Reference(Condition (EU core)) Health issues this plan addresses
CarePlan.supportingInfo 0..* Reference(Resource) Information considered as part of the care plan
CarePlan.goal 0..* Reference(Goal (DR)) Desired outcome of plan
CarePlan.activity C 0..* BackboneElement Action to occur as part of plan
Constraints: cpl-3
CarePlan.activity.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CarePlan.activity.outcomeCodeableConcept 0..* CodeableConcept Codeable Outcome summary
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.
CarePlan.activity.outcomeReference 0..* Reference(Resource) Outcome evidence
CarePlan.activity.progress 0..* Annotation Notes about the progress of the activity
CarePlan.activity.reference C 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
CarePlan.activity.detail C 0..1 BackboneElement Deprecated in R5/R6
CarePlan.activity.detail.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CarePlan.activity.detail.status This element is a modifier element. 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.
CarePlan.activity.detail.doNotPerform This element is a modifier element. 0..1 boolean If true, activity is prohibiting action

doco Documentation for this format

Terminology Bindings

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.​status Base required CarePlanActivityStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CarePlan 0..* CarePlan Healthcare plan for patient
CarePlan.language 0..1 code Language of the resource content
CarePlan.identifier 0..* Identifier External Ids for this plan
CarePlan.instantiatesCanonical 0..* canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiated Canonical
CarePlan.status 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
CarePlan.category 0..* CodeableConcept Kind of plan
CarePlan.title 0..1 string Human-friendly name for the care plan
CarePlan.description 0..1 string Summary of nature of plan
CarePlan.subject 1..1 Reference(Patient (EU core)) Who the care plan is for
CarePlan.period 0..1 Period Time period plan covers
CarePlan.created 0..1 dateTime Date the plan was created
CarePlan.author 0..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who is the designated responsible party
CarePlan.careTeam 0..* Reference(CareTeam) Participants in the care plan
CarePlan.addresses 0..* Reference(Condition (EU core)) Health issues this plan addresses
CarePlan.supportingInfo 0..* Reference(Resource) Information considered as part of the care plan
CarePlan.goal 0..* Reference(Goal (DR)) Desired outcome of plan
CarePlan.activity 0..* BackboneElement Action to occur as part of plan
CarePlan.activity.outcomeCodeableConcept 0..* CodeableConcept Codeable Outcome summary
CarePlan.activity.outcomeReference 0..* Reference(Resource) Outcome evidence
CarePlan.activity.progress 0..* Annotation Notes about the progress of the activity
CarePlan.activity.reference 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
CarePlan.activity.detail 0..1 BackboneElement Deprecated in R5/R6

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
CarePlan 0..* CarePlan Healthcare plan for patient
CarePlan.id This element is included in summaries. 0..1 id Logical id of this artifact
CarePlan.meta This element is included in summaries. 0..1 Meta Metadata about the resource
CarePlan.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
CarePlan.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
CarePlan.text 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
CarePlan.contained 0..* Resource Contained, inline Resources
CarePlan.extension 0..* Extension Additional content defined by implementations
CarePlan.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
CarePlan.identifier This element is included in summaries. 0..* Identifier External Ids for this plan
CarePlan.instantiatesCanonical This element is included in summaries. 0..* canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiated Canonical
CarePlan.instantiatesUri This element is included in summaries. 0..* uri Instantiated URI
CarePlan.basedOn This element is included in summaries. 0..* Reference(CarePlan) Fulfills CarePlan
CarePlan.replaces This element is included in summaries. 0..* Reference(CarePlan) CarePlan replaced by this CarePlan
CarePlan.partOf This element is included in summaries. 0..* Reference(CarePlan) Part of referenced CarePlan
CarePlan.status This element is a modifier element. This element is included in summaries. 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.
CarePlan.intent This element is a modifier element. This element is included in summaries. 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
CarePlan.category This element is included in summaries. 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.
CarePlan.title This element is included in summaries. 0..1 string Human-friendly name for the care plan
CarePlan.description This element is included in summaries. 0..1 string Summary of nature of plan
CarePlan.subject This element is included in summaries. 1..1 Reference(Patient (EU core)) Who the care plan is for
CarePlan.encounter This element is included in summaries. 0..1 Reference(Encounter) Encounter created as part of
CarePlan.period This element is included in summaries. 0..1 Period Time period plan covers
CarePlan.created This element is included in summaries. 0..1 dateTime Date the plan was created
CarePlan.author This element is included in summaries. 0..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who is the designated responsible party
CarePlan.contributor 0..* Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who provided the content of the care plan
CarePlan.careTeam 0..* Reference(CareTeam) Participants in the care plan
CarePlan.addresses This element is included in summaries. 0..* Reference(Condition (EU core)) Health issues this plan addresses
CarePlan.supportingInfo 0..* Reference(Resource) Information considered as part of the care plan
CarePlan.goal 0..* Reference(Goal (DR)) Desired outcome of plan
CarePlan.activity C 0..* BackboneElement Action to occur as part of plan
Constraints: cpl-3
CarePlan.activity.id 0..1 string Unique id for inter-element referencing
CarePlan.activity.extension 0..* Extension Additional content defined by implementations
CarePlan.activity.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CarePlan.activity.outcomeCodeableConcept 0..* CodeableConcept Codeable Outcome summary
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.
CarePlan.activity.outcomeReference 0..* Reference(Resource) Outcome evidence
CarePlan.activity.progress 0..* Annotation Notes about the progress of the activity
CarePlan.activity.reference C 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
CarePlan.activity.detail C 0..1 BackboneElement Deprecated in R5/R6
CarePlan.activity.detail.id 0..1 string Unique id for inter-element referencing
CarePlan.activity.detail.extension 0..* Extension Additional content defined by implementations
CarePlan.activity.detail.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CarePlan.activity.detail.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.
CarePlan.activity.detail.instantiatesCanonical 0..* canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) Instantiates FHIR protocol or definition
CarePlan.activity.detail.instantiatesUri 0..* uri Instantiates external protocol or definition
CarePlan.activity.detail.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.
CarePlan.activity.detail.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.
CarePlan.activity.detail.reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why activity is needed
CarePlan.activity.detail.goal 0..* Reference(Goal) Goals this activity relates to
CarePlan.activity.detail.status This element is a modifier element. 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.
CarePlan.activity.detail.statusReason 0..1 CodeableConcept Reason for current status
CarePlan.activity.detail.doNotPerform This element is a modifier element. 0..1 boolean If true, activity is prohibiting action
CarePlan.activity.detail.scheduled[x] 0..1 When activity is to occur
CarePlan.activity.detail.scheduled[x].scheduledTiming Timing
CarePlan.activity.detail.scheduled[x].scheduledPeriod Period
CarePlan.activity.detail.scheduled[x].scheduledString string
CarePlan.activity.detail.location 0..1 Reference(Location) Where it should happen
CarePlan.activity.detail.performer 0..* Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Who will be responsible?
CarePlan.activity.detail.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.
CarePlan.activity.detail.product[x].productCodeableConcept CodeableConcept
CarePlan.activity.detail.product[x].productReference Reference(Medication | Substance)
CarePlan.activity.detail.dailyAmount C 0..1 SimpleQuantity(4.0.1) How to consume/day?
Constraints: sqty-1
CarePlan.activity.detail.quantity C 0..1 SimpleQuantity(4.0.1) How much to administer/supply/consume
Constraints: sqty-1
CarePlan.activity.detail.description 0..1 string Extra info describing activity to perform
CarePlan.note 0..* Annotation Comments about the plan

doco Documentation for this format

Terminology Bindings

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.

Constraints

Id Grade Path(s) Description Expression
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()
sqty-1 error CarePlan.activity.detail.dailyAmount, CarePlan.activity.detail.quantity The comparator is not used on a SimpleQuantity comparator.empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CarePlan 0..* CarePlan Healthcare plan for patient
CarePlan.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
CarePlan.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
CarePlan.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
CarePlan.identifier This element is included in summaries. 0..* Identifier External Ids for this plan
CarePlan.instantiatesCanonical This element is included in summaries. 0..* canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiated Canonical
CarePlan.instantiatesUri This element is included in summaries. 0..* uri Instantiated URI
CarePlan.status This element is a modifier element. This element is included in summaries. 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.
CarePlan.intent This element is a modifier element. This element is included in summaries. 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
CarePlan.category This element is included in summaries. 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.
CarePlan.title This element is included in summaries. 0..1 string Human-friendly name for the care plan
CarePlan.description This element is included in summaries. 0..1 string Summary of nature of plan
CarePlan.subject This element is included in summaries. 1..1 Reference(Patient (EU core)) Who the care plan is for
CarePlan.period This element is included in summaries. 0..1 Period Time period plan covers
CarePlan.created This element is included in summaries. 0..1 dateTime Date the plan was created
CarePlan.author This element is included in summaries. 0..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who is the designated responsible party
CarePlan.careTeam 0..* Reference(CareTeam) Participants in the care plan
CarePlan.addresses This element is included in summaries. 0..* Reference(Condition (EU core)) Health issues this plan addresses
CarePlan.supportingInfo 0..* Reference(Resource) Information considered as part of the care plan
CarePlan.goal 0..* Reference(Goal (DR)) Desired outcome of plan
CarePlan.activity C 0..* BackboneElement Action to occur as part of plan
Constraints: cpl-3
CarePlan.activity.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CarePlan.activity.outcomeCodeableConcept 0..* CodeableConcept Codeable Outcome summary
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.
CarePlan.activity.outcomeReference 0..* Reference(Resource) Outcome evidence
CarePlan.activity.progress 0..* Annotation Notes about the progress of the activity
CarePlan.activity.reference C 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
CarePlan.activity.detail C 0..1 BackboneElement Deprecated in R5/R6
CarePlan.activity.detail.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CarePlan.activity.detail.status This element is a modifier element. 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.
CarePlan.activity.detail.doNotPerform This element is a modifier element. 0..1 boolean If true, activity is prohibiting action

doco Documentation for this format

Terminology Bindings

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.​status Base required CarePlanActivityStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

Differential View

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CarePlan 0..* CarePlan Healthcare plan for patient
CarePlan.language 0..1 code Language of the resource content
CarePlan.identifier 0..* Identifier External Ids for this plan
CarePlan.instantiatesCanonical 0..* canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiated Canonical
CarePlan.instantiatesUri 0..* uri Instantiated URI
CarePlan.status 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
CarePlan.category 0..* CodeableConcept Kind of plan
CarePlan.title 0..1 string Human-friendly name for the care plan
CarePlan.description 0..1 string Summary of nature of plan
CarePlan.subject 1..1 Reference(Patient (EU core)) Who the care plan is for
CarePlan.period 0..1 Period Time period plan covers
CarePlan.created 0..1 dateTime Date the plan was created
CarePlan.author 0..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who is the designated responsible party
CarePlan.careTeam 0..* Reference(CareTeam) Participants in the care plan
CarePlan.addresses 0..* Reference(Condition (EU core)) Health issues this plan addresses
CarePlan.supportingInfo 0..* Reference(Resource) Information considered as part of the care plan
CarePlan.goal 0..* Reference(Goal (DR)) Desired outcome of plan
CarePlan.activity 0..* BackboneElement Action to occur as part of plan
CarePlan.activity.outcomeCodeableConcept 0..* CodeableConcept Codeable Outcome summary
CarePlan.activity.outcomeReference 0..* Reference(Resource) Outcome evidence
CarePlan.activity.progress 0..* Annotation Notes about the progress of the activity
CarePlan.activity.reference 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
CarePlan.activity.detail 0..1 BackboneElement Deprecated in R5/R6

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CarePlan 0..* CarePlan Healthcare plan for patient
CarePlan.id This element is included in summaries. 0..1 id Logical id of this artifact
CarePlan.meta This element is included in summaries. 0..1 Meta Metadata about the resource
CarePlan.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
CarePlan.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
CarePlan.text 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
CarePlan.contained 0..* Resource Contained, inline Resources
CarePlan.extension 0..* Extension Additional content defined by implementations
CarePlan.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
CarePlan.identifier This element is included in summaries. 0..* Identifier External Ids for this plan
CarePlan.instantiatesCanonical This element is included in summaries. 0..* canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiated Canonical
CarePlan.instantiatesUri This element is included in summaries. 0..* uri Instantiated URI
CarePlan.basedOn This element is included in summaries. 0..* Reference(CarePlan) Fulfills CarePlan
CarePlan.replaces This element is included in summaries. 0..* Reference(CarePlan) CarePlan replaced by this CarePlan
CarePlan.partOf This element is included in summaries. 0..* Reference(CarePlan) Part of referenced CarePlan
CarePlan.status This element is a modifier element. This element is included in summaries. 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.
CarePlan.intent This element is a modifier element. This element is included in summaries. 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
CarePlan.category This element is included in summaries. 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.
CarePlan.title This element is included in summaries. 0..1 string Human-friendly name for the care plan
CarePlan.description This element is included in summaries. 0..1 string Summary of nature of plan
CarePlan.subject This element is included in summaries. 1..1 Reference(Patient (EU core)) Who the care plan is for
CarePlan.encounter This element is included in summaries. 0..1 Reference(Encounter) Encounter created as part of
CarePlan.period This element is included in summaries. 0..1 Period Time period plan covers
CarePlan.created This element is included in summaries. 0..1 dateTime Date the plan was created
CarePlan.author This element is included in summaries. 0..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who is the designated responsible party
CarePlan.contributor 0..* Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who provided the content of the care plan
CarePlan.careTeam 0..* Reference(CareTeam) Participants in the care plan
CarePlan.addresses This element is included in summaries. 0..* Reference(Condition (EU core)) Health issues this plan addresses
CarePlan.supportingInfo 0..* Reference(Resource) Information considered as part of the care plan
CarePlan.goal 0..* Reference(Goal (DR)) Desired outcome of plan
CarePlan.activity C 0..* BackboneElement Action to occur as part of plan
Constraints: cpl-3
CarePlan.activity.id 0..1 string Unique id for inter-element referencing
CarePlan.activity.extension 0..* Extension Additional content defined by implementations
CarePlan.activity.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CarePlan.activity.outcomeCodeableConcept 0..* CodeableConcept Codeable Outcome summary
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.
CarePlan.activity.outcomeReference 0..* Reference(Resource) Outcome evidence
CarePlan.activity.progress 0..* Annotation Notes about the progress of the activity
CarePlan.activity.reference C 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
CarePlan.activity.detail C 0..1 BackboneElement Deprecated in R5/R6
CarePlan.activity.detail.id 0..1 string Unique id for inter-element referencing
CarePlan.activity.detail.extension 0..* Extension Additional content defined by implementations
CarePlan.activity.detail.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
CarePlan.activity.detail.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.
CarePlan.activity.detail.instantiatesCanonical 0..* canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) Instantiates FHIR protocol or definition
CarePlan.activity.detail.instantiatesUri 0..* uri Instantiates external protocol or definition
CarePlan.activity.detail.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.
CarePlan.activity.detail.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.
CarePlan.activity.detail.reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why activity is needed
CarePlan.activity.detail.goal 0..* Reference(Goal) Goals this activity relates to
CarePlan.activity.detail.status This element is a modifier element. 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.
CarePlan.activity.detail.statusReason 0..1 CodeableConcept Reason for current status
CarePlan.activity.detail.doNotPerform This element is a modifier element. 0..1 boolean If true, activity is prohibiting action
CarePlan.activity.detail.scheduled[x] 0..1 When activity is to occur
CarePlan.activity.detail.scheduled[x].scheduledTiming Timing
CarePlan.activity.detail.scheduled[x].scheduledPeriod Period
CarePlan.activity.detail.scheduled[x].scheduledString string
CarePlan.activity.detail.location 0..1 Reference(Location) Where it should happen
CarePlan.activity.detail.performer 0..* Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Who will be responsible?
CarePlan.activity.detail.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.
CarePlan.activity.detail.product[x].productCodeableConcept CodeableConcept
CarePlan.activity.detail.product[x].productReference Reference(Medication | Substance)
CarePlan.activity.detail.dailyAmount C 0..1 SimpleQuantity(4.0.1) How to consume/day?
Constraints: sqty-1
CarePlan.activity.detail.quantity C 0..1 SimpleQuantity(4.0.1) How much to administer/supply/consume
Constraints: sqty-1
CarePlan.activity.detail.description 0..1 string Extra info describing activity to perform
CarePlan.note 0..* Annotation Comments about the plan

doco Documentation for this format

Terminology Bindings

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.

Constraints

Id Grade Path(s) Description Expression
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()
sqty-1 error CarePlan.activity.detail.dailyAmount, CarePlan.activity.detail.quantity The comparator is not used on a SimpleQuantity comparator.empty()

 

Other representations of profile: CSV, Excel, Schematron