Clinical Practice Guidelines
3.0.0-ballot - STU 3 Ballot
Clinical Practice Guidelines
3.0.0-ballot - STU 3 Ballot
Clinical Practice Guidelines, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-careplan | Version: 3.0.0-ballot | ||||
| Active as of 2026-11-10 | Computable Name: CPGCarePlan | ||||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.48.42.22 | |||||
CPG care plan represents the care plan for a specific patient. The care plan may be associated with management of a specific condition, and instantiated based on a particular pathway or strategy, or it may be a combined care plan, focused on the patient, and managing treatment for multiple conditions, instantiated based on multiple pathways and strategies
This is a domain case/instance profile
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:messages |
0..1 | Reference(OperationOutcome) | Messages from logic evaluation URL: http://hl7.org/fhir/StructureDefinition/cqf-messages | |
 extension:planFor |
0..* | Reference(CPG Case) | CPG Plan For Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-planFor | |
 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 | |
| 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 | Type 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 |
0..1 | string | Human-friendly name for the care plan | |
| description |
0..1 | string | Summary of nature of plan | |
 subject |
1..1 | Reference(CPG Patient) | Who the care plan is for | |
| encounter |
0..1 | Reference(CPG Encounter) | Encounter created as part of | |
| period |
0..1 | Period | Time period plan covers | |
| created |
0..1 | dateTime | Date record was first recorded | |
| careTeam |
0..* | Reference(CPG Care Team) | Who's involved in plan? | |
| addresses |
0..* | Reference(CPG Condition) | Health issues this plan addresses | |
| goal |
0..* | Reference(Goal) | Desired outcome of plan | |
 activity |
C | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3 |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| outcomeReference |
0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |
| reference |
C | 0..1 | Reference(Appointment | CPG Communication Request | CPG Medication Request | CPG Task | CPG Service Request | CPG Strategy) | Activity details defined in specific resource |
| detail |
C | 0..1 | BackboneElement | In-line definition of activity |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| kind |
1..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 | |
| code |
1..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |
| 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. | |
| 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 | |
 scheduled[x] |
0..1 | When activity is to occur | ||
| scheduledTiming |
Timing | |||
 scheduledPeriod |
Period | |||
| location |
0..1 | Reference(CPG Location) | Where it should happen | |
| performer |
0..* | Reference(CPG Practitioner | CPG Practitioner Role | CPG Organization | CPG Related Person | CPG Patient | CPG Care Team) | Who will be responsible? | |
| description |
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.category | Base | example | Care Plan Category | 📍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. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:messages |
0..1 | Reference(OperationOutcome) | Messages from logic evaluation URL: http://hl7.org/fhir/StructureDefinition/cqf-messages | |
| extension:planFor |
0..* | Reference(CPG Case) | CPG Plan For Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-planFor | |
 identifier |
0..* | Identifier | External Ids for this plan | |
| instantiatesCanonical |
0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | |
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown | |
| intent |
1..1 | code | proposal | plan | order | option | |
| category |
0..* | CodeableConcept | Type of plan | |
| title |
0..1 | string | Human-friendly name for the care plan | |
| description |
0..1 | string | Summary of nature of plan | |
| subject |
1..1 | Reference(CPG Patient) | Who the care plan is for | |
| encounter |
0..1 | Reference(CPG Encounter) | Encounter created as part of | |
| period |
0..1 | Period | Time period plan covers | |
| created |
0..1 | dateTime | Date record was first recorded | |
| careTeam |
0..* | Reference(CPG Care Team) | Who's involved in plan? | |
| addresses |
0..* | Reference(CPG Condition) | Health issues this plan addresses | |
| goal |
0..* | Reference(Goal) | Desired outcome of plan | |
| activity |
0..* | BackboneElement | Action to occur as part of plan | |
| outcomeReference |
0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |
| reference |
0..1 | Reference(Appointment | CPG Communication Request | CPG Medication Request | CPG Task | CPG Service Request | CPG Strategy) | Activity details defined in specific resource | |
| detail |
0..1 | BackboneElement | In-line definition of activity | |
| kind |
1..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | |
| instantiatesCanonical |
0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |
| code |
1..1 | CodeableConcept | Detail type of activity | |
| reasonCode |
0..* | CodeableConcept | Why activity should be done or why activity was prohibited | |
| status |
1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error | |
| doNotPerform |
0..1 | boolean | If true, activity is prohibiting action | |
| scheduled[x] |
0..1 | When activity is to occur | ||
| scheduledTiming |
Timing | |||
| scheduledPeriod |
Period | |||
| location |
0..1 | Reference(CPG Location) | Where it should happen | |
| performer |
0..* | Reference(CPG Practitioner | CPG Practitioner Role | CPG Organization | CPG Related Person | CPG Patient | CPG Care Team) | Who will be responsible? | |
| description |
0..1 | string | Extra info describing activity to perform | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:messages |
0..1 | Reference(OperationOutcome) | Messages from logic evaluation URL: http://hl7.org/fhir/StructureDefinition/cqf-messages | |||||
| extension:planFor |
0..* | Reference(CPG Case) | CPG Plan For Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-planFor | |||||
| 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 | |||||
| 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 | Type 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 |
0..1 | string | Human-friendly name for the care plan | |||||
| description |
0..1 | string | Summary of nature of plan | |||||
| subject |
1..1 | Reference(CPG Patient) | Who the care plan is for | |||||
| encounter |
0..1 | Reference(CPG Encounter) | Encounter created as part of | |||||
| period |
0..1 | Period | Time period plan covers | |||||
| created |
0..1 | dateTime | Date record was first recorded | |||||
| 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(CPG Care Team) | Who's involved in plan? | |||||
| addresses |
0..* | Reference(CPG Condition) | Health issues this plan addresses | |||||
| supportingInfo |
0..* | Reference(Resource) | Information considered as part of plan | |||||
| goal |
0..* | Reference(Goal) | Desired outcome of plan | |||||
| activity |
C | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3 | ||||
| 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) | Appointment, Encounter, Procedure, etc. | |||||
| progress |
0..* | Annotation | Comments about the activity status/progress | |||||
| reference |
C | 0..1 | Reference(Appointment | CPG Communication Request | CPG Medication Request | CPG Task | CPG Service Request | CPG Strategy) | Activity details defined in specific resource | ||||
| detail |
C | 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 |
1..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 |
1..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |||||
| 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 | |||||||
| location |
0..1 | Reference(CPG Location) | Where it should happen | |||||
| performer |
0..* | Reference(CPG Practitioner | CPG Practitioner Role | CPG Organization | CPG Related Person | CPG Patient | CPG Care Team) | 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 |
C | 0..1 | SimpleQuantity(4.0.1) | How to consume/day? Constraints: sqty-1 | ||||
| quantity |
C | 0..1 | SimpleQuantity(4.0.1) | How much to administer/supply/consume Constraints: sqty-1 | ||||
| description |
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()
|
| 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()
|
This structure is derived from CarePlan
Summary
Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 29 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:messages |
0..1 | Reference(OperationOutcome) | Messages from logic evaluation URL: http://hl7.org/fhir/StructureDefinition/cqf-messages | |
| extension:planFor |
0..* | Reference(CPG Case) | CPG Plan For Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-planFor | |
| 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 | |
| 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 | Type 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 |
0..1 | string | Human-friendly name for the care plan | |
| description |
0..1 | string | Summary of nature of plan | |
| subject |
1..1 | Reference(CPG Patient) | Who the care plan is for | |
| encounter |
0..1 | Reference(CPG Encounter) | Encounter created as part of | |
| period |
0..1 | Period | Time period plan covers | |
| created |
0..1 | dateTime | Date record was first recorded | |
| careTeam |
0..* | Reference(CPG Care Team) | Who's involved in plan? | |
| addresses |
0..* | Reference(CPG Condition) | Health issues this plan addresses | |
| goal |
0..* | Reference(Goal) | Desired outcome of plan | |
| activity |
C | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| outcomeReference |
0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |
| reference |
C | 0..1 | Reference(Appointment | CPG Communication Request | CPG Medication Request | CPG Task | CPG Service Request | CPG Strategy) | Activity details defined in specific resource |
| detail |
C | 0..1 | BackboneElement | In-line definition of activity |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| kind |
1..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 | |
| code |
1..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |
| 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. | |
| 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 | |
| scheduled[x] |
0..1 | When activity is to occur | ||
| scheduledTiming |
Timing | |||
| scheduledPeriod |
Period | |||
| location |
0..1 | Reference(CPG Location) | Where it should happen | |
| performer |
0..* | Reference(CPG Practitioner | CPG Practitioner Role | CPG Organization | CPG Related Person | CPG Patient | CPG Care Team) | Who will be responsible? | |
| description |
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.category | Base | example | Care Plan Category | 📍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. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:messages |
0..1 | Reference(OperationOutcome) | Messages from logic evaluation URL: http://hl7.org/fhir/StructureDefinition/cqf-messages | |
| extension:planFor |
0..* | Reference(CPG Case) | CPG Plan For Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-planFor | |
| identifier |
0..* | Identifier | External Ids for this plan | |
| instantiatesCanonical |
0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | |
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown | |
| intent |
1..1 | code | proposal | plan | order | option | |
| category |
0..* | CodeableConcept | Type of plan | |
| title |
0..1 | string | Human-friendly name for the care plan | |
| description |
0..1 | string | Summary of nature of plan | |
| subject |
1..1 | Reference(CPG Patient) | Who the care plan is for | |
| encounter |
0..1 | Reference(CPG Encounter) | Encounter created as part of | |
| period |
0..1 | Period | Time period plan covers | |
| created |
0..1 | dateTime | Date record was first recorded | |
| careTeam |
0..* | Reference(CPG Care Team) | Who's involved in plan? | |
| addresses |
0..* | Reference(CPG Condition) | Health issues this plan addresses | |
| goal |
0..* | Reference(Goal) | Desired outcome of plan | |
| activity |
0..* | BackboneElement | Action to occur as part of plan | |
| outcomeReference |
0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |
| reference |
0..1 | Reference(Appointment | CPG Communication Request | CPG Medication Request | CPG Task | CPG Service Request | CPG Strategy) | Activity details defined in specific resource | |
| detail |
0..1 | BackboneElement | In-line definition of activity | |
| kind |
1..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | |
| instantiatesCanonical |
0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |
| code |
1..1 | CodeableConcept | Detail type of activity | |
| reasonCode |
0..* | CodeableConcept | Why activity should be done or why activity was prohibited | |
| status |
1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error | |
| doNotPerform |
0..1 | boolean | If true, activity is prohibiting action | |
| scheduled[x] |
0..1 | When activity is to occur | ||
| scheduledTiming |
Timing | |||
| scheduledPeriod |
Period | |||
| location |
0..1 | Reference(CPG Location) | Where it should happen | |
| performer |
0..* | Reference(CPG Practitioner | CPG Practitioner Role | CPG Organization | CPG Related Person | CPG Patient | CPG Care Team) | Who will be responsible? | |
| description |
0..1 | string | Extra info describing activity to perform | |
| Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:messages |
0..1 | Reference(OperationOutcome) | Messages from logic evaluation URL: http://hl7.org/fhir/StructureDefinition/cqf-messages | |||||
| extension:planFor |
0..* | Reference(CPG Case) | CPG Plan For Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-planFor | |||||
| 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 | |||||
| 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 | Type 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 |
0..1 | string | Human-friendly name for the care plan | |||||
| description |
0..1 | string | Summary of nature of plan | |||||
| subject |
1..1 | Reference(CPG Patient) | Who the care plan is for | |||||
| encounter |
0..1 | Reference(CPG Encounter) | Encounter created as part of | |||||
| period |
0..1 | Period | Time period plan covers | |||||
| created |
0..1 | dateTime | Date record was first recorded | |||||
| 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(CPG Care Team) | Who's involved in plan? | |||||
| addresses |
0..* | Reference(CPG Condition) | Health issues this plan addresses | |||||
| supportingInfo |
0..* | Reference(Resource) | Information considered as part of plan | |||||
| goal |
0..* | Reference(Goal) | Desired outcome of plan | |||||
| activity |
C | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3 | ||||
| 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) | Appointment, Encounter, Procedure, etc. | |||||
| progress |
0..* | Annotation | Comments about the activity status/progress | |||||
| reference |
C | 0..1 | Reference(Appointment | CPG Communication Request | CPG Medication Request | CPG Task | CPG Service Request | CPG Strategy) | Activity details defined in specific resource | ||||
| detail |
C | 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 |
1..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 |
1..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |||||
| 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 | |||||||
| location |
0..1 | Reference(CPG Location) | Where it should happen | |||||
| performer |
0..* | Reference(CPG Practitioner | CPG Practitioner Role | CPG Organization | CPG Related Person | CPG Patient | CPG Care Team) | 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 |
C | 0..1 | SimpleQuantity(4.0.1) | How to consume/day? Constraints: sqty-1 | ||||
| quantity |
C | 0..1 | SimpleQuantity(4.0.1) | How much to administer/supply/consume Constraints: sqty-1 | ||||
| description |
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()
|
| 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()
|
This structure is derived from CarePlan
Summary
Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 29 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Clinical Decision Support.
Package hl7.fhir.uv.cpg#3.0.0-ballot based on FHIR 4.0.1.
Generated
2026-11-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change