US Core Implementation Guide
10.0.0-ballot - STU 10 Ballot
US Core Implementation Guide
10.0.0-ballot - STU 10 Ballot
US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 10.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/US-Core/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan | Version: 10.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: USCoreCarePlanProfile | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.15 | ||||
The US Core CarePlan Profile inherits from the FHIR CarePlan resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the CarePlan resource to record, search, and fetch assessment and plan of treatment data associated with a patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.
Example Usage Scenarios:
The following are example usage scenarios for this profile:
The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.
Each CarePlan Must Have:
Each CarePlan Must Support:
Additional USCDI Requirements:
These Additional USCDI Requirements elements are not Mandatory or Must Support but are required for ONC Health IT certification testing and are included in the formal definition of the profile and the CarePlan examples.
1,2 see guidance below
This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.
1The original US Core CarePlan Profile was designed to support the "Assessment and Plan" in a narrative Progress Note. Its future direction is to move from text-based content to discrete references to conditions/needs (CarePlan.addresses), goals (CarePlan.goal), and strategies (CarePlan.activities).
CarePlan.contributor communicates the individual level provenance author data corresponding to the U.S. Core Data for Interoperability (USCDI) Provenance Author Data Elements.Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 9.0.0:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| 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 | |
 text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile constrains the narrative content by fixing the status codes to generated and additional This profile does not constrain the narrative in regard to language specific sections This profile does not constrain the narrative in regard to traceability to data elements | |
 status |
1..1 | code | generated | additional Binding: US Core Narrative Status (required): Constrained value set of narrative statuses. | |
 div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 |
 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 | |
| category |
0..* | CodeableConcept | Type of plan Binding: CarePlanCategory (preferred) | |
 subject |
1..1 | Reference(US Core Patient Profile | Group) | Who the care plan is for | |
| contributor |
0..* | Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile | US Core Device Profile) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who provided the content of the care plan | |
| addresses |
0..* | Reference(US Core Condition Problems and Health Concerns Profile) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Health issues this plan addresses | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.text.status | Base | required | US Core Narrative Status | 📦10.0.0-ballot | This IG |
| 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 | preferred | Care Plan Category | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from CarePlan
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |
 text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
| status |
1..1 | code | generated | additional Binding: US Core Narrative Status (required): Constrained value set of narrative statuses. | |
| div |
1..1 | xhtml | Limited xhtml content | |
| 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 (preferred) | |
| subject |
1..1 | Reference(US Core Patient Profile | Group) | Who the care plan is for | |
| contributor |
0..* | Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile | US Core Device Profile) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who provided the content of the care plan | |
| addresses |
0..* | Reference(US Core Condition Problems and Health Concerns Profile) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Health issues this plan addresses | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.text.status | Base | required | US Core Narrative Status | 📦10.0.0-ballot | This IG |
| 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 | preferred | Care Plan Category | 📦4.0.1 | FHIR Std. |
| 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 constrains the narrative content by fixing the status codes to generated and additional This profile does not constrain the narrative in regard to language specific sections This profile does not constrain the narrative in regard to traceability to data elements | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| status |
1..1 | code | generated | additional Binding: US Core Narrative Status (required): Constrained value set of narrative statuses. | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| 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) | 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 (preferred) | |||||
| title |
0..1 | string | Human-friendly name for the care plan | |||||
| description |
0..1 | string | Summary of nature of plan | |||||
| subject |
1..1 | Reference(US Core Patient Profile | Group) | Who the care plan is for | |||||
| encounter |
0..1 | Reference(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(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile | US Core Device Profile) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who provided the content of the care plan | |||||
| careTeam |
0..* | Reference(CareTeam) | Who's involved in plan? | |||||
| addresses |
0..* | Reference(US Core Condition Problems and Health Concerns Profile) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | 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 |
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 |
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.text.status | Base | required | US Core Narrative Status | 📦10.0.0-ballot | This IG |
| 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 | preferred | 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 |
This structure is derived from CarePlan
Summary
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Maturity: 4
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 | |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile constrains the narrative content by fixing the status codes to generated and additional This profile does not constrain the narrative in regard to language specific sections This profile does not constrain the narrative in regard to traceability to data elements | |
| status |
1..1 | code | generated | additional Binding: US Core Narrative Status (required): Constrained value set of narrative statuses. | |
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 |
| 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 | |
| category |
0..* | CodeableConcept | Type of plan Binding: CarePlanCategory (preferred) | |
| subject |
1..1 | Reference(US Core Patient Profile | Group) | Who the care plan is for | |
| contributor |
0..* | Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile | US Core Device Profile) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who provided the content of the care plan | |
| addresses |
0..* | Reference(US Core Condition Problems and Health Concerns Profile) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Health issues this plan addresses | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.text.status | Base | required | US Core Narrative Status | 📦10.0.0-ballot | This IG |
| 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 | preferred | Care Plan Category | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from CarePlan
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlan | Healthcare plan for patient or group | |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
| status |
1..1 | code | generated | additional Binding: US Core Narrative Status (required): Constrained value set of narrative statuses. | |
| div |
1..1 | xhtml | Limited xhtml content | |
| 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 (preferred) | |
| subject |
1..1 | Reference(US Core Patient Profile | Group) | Who the care plan is for | |
| contributor |
0..* | Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile | US Core Device Profile) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who provided the content of the care plan | |
| addresses |
0..* | Reference(US Core Condition Problems and Health Concerns Profile) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Health issues this plan addresses | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.text.status | Base | required | US Core Narrative Status | 📦10.0.0-ballot | This IG |
| 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 | preferred | Care Plan Category | 📦4.0.1 | FHIR Std. |
Snapshot View
| 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 constrains the narrative content by fixing the status codes to generated and additional This profile does not constrain the narrative in regard to language specific sections This profile does not constrain the narrative in regard to traceability to data elements | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| status |
1..1 | code | generated | additional Binding: US Core Narrative Status (required): Constrained value set of narrative statuses. | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| 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) | 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 (preferred) | |||||
| title |
0..1 | string | Human-friendly name for the care plan | |||||
| description |
0..1 | string | Summary of nature of plan | |||||
| subject |
1..1 | Reference(US Core Patient Profile | Group) | Who the care plan is for | |||||
| encounter |
0..1 | Reference(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(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile | US Core Device Profile) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who provided the content of the care plan | |||||
| careTeam |
0..* | Reference(CareTeam) | Who's involved in plan? | |||||
| addresses |
0..* | Reference(US Core Condition Problems and Health Concerns Profile) | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: 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 | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | 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 |
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 |
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.text.status | Base | required | US Core Narrative Status | 📦10.0.0-ballot | This IG |
| 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 | preferred | 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 |
This structure is derived from CarePlan
Summary
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.
Servers providing access to care plan data SHALL support these US Core SMART Scopes:
<patient|user|system>/CarePlan.rs §The following search parameters and search parameter combinations SHALL be supported:
SHALL support searching using the combination of the patient and category search parameters
GET [base]/CarePlan?patient={Patient/}[id]&category={system|}[search_code]
Example:
- GET [base]/CarePlan?patient=Patient/1137192&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan
Implementation Notes: Fetches a bundle of all resources for the specified ="assess-plan" ( see how to search by reference and how to search by token).
The following search parameters and search parameter combinations SHOULD be supported
SHOULD support searching using the combination of the patient and category and date search parameters
Including optional support for AND search on date (e.g.date=[date]&date=[date]&...)
Including support for these date comparators: "gt", "lt", "ge", "le"
GET [base]/CarePlan?patient={Patient/}[id]&category={system|}[search_code]&date={gt|lt|ge|le}[dateTime]{&date={gt|lt|ge|le}[dateTime]&...}
Examples:
GET [base]/CarePlan?patient=Patient/1137192&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&date=ge2019-01-01T00:00:00Z
GET [base]/CarePlan?patient=Patient/1137192&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&date=ge2018-01-01T00:00:00Z&date=le2019-01-01T00:00:00Z
Implementation Notes: Fetches a bundle of all resources for the specified patient and category="assess-plan" and date ( see how to search by reference and how to search by token and how to search by date).
SHOULD support searching using the combination of the patient and category and status search parameters
status (e.g.status={system|}[code],{system|}[code],...)GET [base]/CarePlan?patient={Patient/}[id]&category={system|}[search_code]&status={system|}[search_code]{,{system|}[code],...}
Example:
- GET [base]/CarePlan?patient=Patient/1137192&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&status=active
Implementation Notes: Fetches a bundle of all resources for the specified patient and category="assess-plan" and status="active" ( see how to search by reference and how to search by token).
SHOULD support searching using the combination of the patient and category and status and date search parameters
Including support OR search on status (e.g.status={system|}[code],{system|}[code],...)
Including optional support for AND search on date (e.g.date=[date]&date=[date]&...)
Including support for these date comparators: "gt", "lt", "ge", "le"
GET [base]/CarePlan?patient={Patient/}[id]&category={system|}[search_code]&status={system|}[search_code]{,{system|}[code],...}&date={gt|lt|ge|le}[dateTime]{&date={gt|lt|ge|le}[dateTime]&...}
Examples:
GET [base]/CarePlan?patient=Patient/1137192&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&status=active&date=ge2019-01-01T00:00:00Z
GET [base]/CarePlan?patient=Patient/1137192&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&status=active&date=ge2018-01-01T00:00:00Z&date=le2019-01-01T00:00:00Z
Implementation Notes: Fetches a bundle of all resources for the specified patient and category="assess-plan" and status="active" and date ( see how to search by reference and how to search by token and how to search by date).
IG © 2027+ HL7 International / Cross-Group Projects. Package hl7.fhir.us.core#10.0.0-ballot based on FHIR 4.0.1. Generated 2026-10-17
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change