US Core Implementation Guide (Release 1)
This page is part of the US Core (v1.0.0: STU1) based on FHIR R3. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions 
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 identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.
Example Usage Scenarios:
The following are example usage scenarios for the US Core-CarePlan profile:
The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each CarePlan must have:
Profile specific implementation guidance:
The official URL for this profile is:
http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan
This profile builds on CarePlan.
This profile was published on Mon Aug 01 00:00:00 AEST 2016 as a draft by HL7 US Realm Steering Committee.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
CarePlan.text
CarePlan.status
CarePlan.intent
Careplan.category which must have:
Careplan.category.coding.system= “http://hl7.org/fhir/us/CodeSystem/careplan-category”Careplan.category.coding.code=“assess-plan”CarePlan.subject| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CarePlan | 0..* | US Core CarePlan Profile | ||
  text | S | 1..1 | Narrative | |
   status | S | 1..1 | code | Binding: Narrative Status (required) |
| status | S | 1..1 | code | Binding: CarePlanStatus (required) |
| intent | S | 1..1 | code | Binding: CarePlanIntent (required) |
| category | SI | 1..* | CodeableConcept | us-core-1: Must have a category of 'assess-plan' and a code system 'http://hl7.org/fhir/us/core/CodeSystem/careplan-category' |
 subject | S | 1..1 | Reference(US Core Patient Profile) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CarePlan | I | 0..* | US Core CarePlan Profile | |
| 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: Common Languages (extensible) | |
| text | SI | 1..1 | Narrative | Text summary of the resource, for human interpretation |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| status | S | 1..1 | code | generated | extensions | additional | empty Binding: Narrative Status (required) |
| div | I | 1..1 | xhtml | Limited xhtml content txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content |
 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 |
| definition | Σ | 0..* | Reference(PlanDefinition), Reference(Questionnaire) | Protocol or definition |
| basedOn | Σ | 0..* | Reference(CarePlan) | Fulfills care plan |
| replaces | Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan |
| partOf | Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan |
| status | ?!SΣ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled | unknown Binding: CarePlanStatus (required) |
| intent | ?!SΣ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required) |
| category | SΣI | 1..* | CodeableConcept | Type of plan Binding: Care Plan Category (example) us-core-1: Must have a category of 'assess-plan' and a code system 'http://hl7.org/fhir/us/core/CodeSystem/careplan-category' |
| title | Σ | 0..1 | string | Human-friendly name for the CarePlan |
| description | Σ | 0..1 | string | Summary of nature of plan |
| subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who care plan is for |
| context | Σ | 0..1 | Reference(Encounter), Reference(EpisodeOfCare) | Created in context of |
| period | Σ | 0..1 | Period | Time period plan covers |
| author | Σ | 0..* | Reference(Patient), Reference(Practitioner), Reference(RelatedPerson), Reference(Organization), Reference(CareTeam) | Who is responsible for contents of the plan |
| careTeam | 0..* | Reference(CareTeam) | Who's involved in plan? | |
| addresses | Σ | 0..* | Reference(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 | I | 0..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Binding: Care Plan Activity Outcome (example) | |
| outcomeReference | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |
| progress | 0..* | Annotation | Comments about the activity status/progress | |
| reference | I | 0..1 | Reference(Appointment), Reference(CommunicationRequest), Reference(DeviceRequest), Reference(MedicationRequest), Reference(NutritionOrder), Reference(Task), Reference(ProcedureRequest), Reference(ReferralRequest), Reference(VisionPrescription), Reference(RequestGroup) | Activity details defined in specific resource |
| detail | I | 0..1 | BackboneElement | In-line definition of activity |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| category | 0..1 | CodeableConcept | diet | drug | encounter | observation | procedure | supply | other Binding: CarePlanActivityCategory (example) | |
| definition | 0..1 | Reference(PlanDefinition), Reference(ActivityDefinition), Reference(Questionnaire) | Protocol or definition | |
| code | 0..1 | CodeableConcept | Detail type of activity Binding: Care Plan Activity (example) | |
| reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: Activity Reason (example) | |
| reasonReference | 0..* | Reference(Condition) | Condition triggering need for activity | |
| goal | 0..* | Reference(Goal) | Goals this activity relates to | |
| status | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown Binding: CarePlanActivityStatus (required) |
| statusReason | 0..1 | string | Reason for current status | |
| prohibited | ?! | 0..1 | boolean | Do NOT do |
 scheduled[x] | 0..1 | Timing, Period, string | When activity is to occur | |
| location | 0..1 | Reference(Location) | Where it should happen | |
| performer | 0..* | Reference(Practitioner), Reference(Organization), Reference(RelatedPerson), Reference(Patient), Reference(CareTeam) | Who will be responsible? | |
| product[x] | 0..1 | CodeableConcept, Reference(Medication), Reference(Substance) | What is to be administered/supplied Binding: SNOMED CT Medication Codes (example) | |
| dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |
| quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |
| description | 0..1 | string | Extra info describing activity to perform | |
| note | 0..* | Annotation | Comments about the plan | |
| Documentation for this format | ||||
CarePlan.text
CarePlan.status
CarePlan.intent
Careplan.category which must have:
Careplan.category.coding.system= “http://hl7.org/fhir/us/CodeSystem/careplan-category”Careplan.category.coding.code=“assess-plan”CarePlan.subjectDifferential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CarePlan | 0..* | US Core CarePlan Profile | ||
| text | S | 1..1 | Narrative | |
| status | S | 1..1 | code | Binding: Narrative Status (required) |
| status | S | 1..1 | code | Binding: CarePlanStatus (required) |
| intent | S | 1..1 | code | Binding: CarePlanIntent (required) |
| category | SI | 1..* | CodeableConcept | us-core-1: Must have a category of 'assess-plan' and a code system 'http://hl7.org/fhir/us/core/CodeSystem/careplan-category' |
| subject | S | 1..1 | Reference(US Core Patient Profile) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CarePlan | I | 0..* | US Core CarePlan Profile | |
| 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: Common Languages (extensible) | |
| text | SI | 1..1 | Narrative | Text summary of the resource, for human interpretation |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| status | S | 1..1 | code | generated | extensions | additional | empty Binding: Narrative Status (required) |
| div | I | 1..1 | xhtml | Limited xhtml content txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content |
| 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 |
| definition | Σ | 0..* | Reference(PlanDefinition), Reference(Questionnaire) | Protocol or definition |
| basedOn | Σ | 0..* | Reference(CarePlan) | Fulfills care plan |
| replaces | Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan |
| partOf | Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan |
| status | ?!SΣ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled | unknown Binding: CarePlanStatus (required) |
| intent | ?!SΣ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required) |
| category | SΣI | 1..* | CodeableConcept | Type of plan Binding: Care Plan Category (example) us-core-1: Must have a category of 'assess-plan' and a code system 'http://hl7.org/fhir/us/core/CodeSystem/careplan-category' |
| title | Σ | 0..1 | string | Human-friendly name for the CarePlan |
| description | Σ | 0..1 | string | Summary of nature of plan |
| subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who care plan is for |
| context | Σ | 0..1 | Reference(Encounter), Reference(EpisodeOfCare) | Created in context of |
| period | Σ | 0..1 | Period | Time period plan covers |
| author | Σ | 0..* | Reference(Patient), Reference(Practitioner), Reference(RelatedPerson), Reference(Organization), Reference(CareTeam) | Who is responsible for contents of the plan |
| careTeam | 0..* | Reference(CareTeam) | Who's involved in plan? | |
| addresses | Σ | 0..* | Reference(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 | I | 0..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Binding: Care Plan Activity Outcome (example) | |
| outcomeReference | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |
| progress | 0..* | Annotation | Comments about the activity status/progress | |
| reference | I | 0..1 | Reference(Appointment), Reference(CommunicationRequest), Reference(DeviceRequest), Reference(MedicationRequest), Reference(NutritionOrder), Reference(Task), Reference(ProcedureRequest), Reference(ReferralRequest), Reference(VisionPrescription), Reference(RequestGroup) | Activity details defined in specific resource |
| detail | I | 0..1 | BackboneElement | In-line definition of activity |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| category | 0..1 | CodeableConcept | diet | drug | encounter | observation | procedure | supply | other Binding: CarePlanActivityCategory (example) | |
| definition | 0..1 | Reference(PlanDefinition), Reference(ActivityDefinition), Reference(Questionnaire) | Protocol or definition | |
| code | 0..1 | CodeableConcept | Detail type of activity Binding: Care Plan Activity (example) | |
| reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: Activity Reason (example) | |
| reasonReference | 0..* | Reference(Condition) | Condition triggering need for activity | |
| goal | 0..* | Reference(Goal) | Goals this activity relates to | |
| status | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown Binding: CarePlanActivityStatus (required) |
| statusReason | 0..1 | string | Reason for current status | |
| prohibited | ?! | 0..1 | boolean | Do NOT do |
| scheduled[x] | 0..1 | Timing, Period, string | When activity is to occur | |
| location | 0..1 | Reference(Location) | Where it should happen | |
| performer | 0..* | Reference(Practitioner), Reference(Organization), Reference(RelatedPerson), Reference(Patient), Reference(CareTeam) | Who will be responsible? | |
| product[x] | 0..1 | CodeableConcept, Reference(Medication), Reference(Substance) | What is to be administered/supplied Binding: SNOMED CT Medication Codes (example) | |
| dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |
| quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |
| description | 0..1 | string | Extra info describing activity to perform | |
| note | 0..* | Annotation | Comments about the plan | |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron
Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the US Core Server for a complete list of supported RESTful operations and search parameters for this IG.
GET /CarePlan?patient=[id]&category=assess-plan
Example: GET [base]/CarePlan?patient=1137192&category=assess-plan
Support: Mandatory to support search by patient.
Implementation Notes: Search for all patient assessments and plans of treatment for a patient. Fetches a bundle of all CarePlan resources for the specified patient (how to search by reference) and (how to search by token).
GET /CarePlan?patient=[id]&category=assess-plan&date=[date]
Example:
Support: Mandatory to support search by date
Implementation Notes: Search for all assessment and plan of treatment for a patient within a time period. Fetches a bundle of all CarePlan resources for the specified patient for a specified time period. (how to search by reference), (how to search by token) and (how to search by date).
GET /CarePlan?patient=[id]&category=assess-plan&status=active
Example: GET [base]/CarePlan?patient=1137192&status=active
Support: SHOULD support search by patient and status = ‘active’.
Implementation Notes: SHOULD support search by reference and status. (how to search by reference), (how to search by token).
GET /CarePlan?patient=[id]&category=assess-plan&status=active&date=[date]
Example: GET [base]/CarePlan?patient=1137192&category=assess-plan&datatus=active&date=ge2015-01-14
Support: SHOULD support search by patient and status = ‘active’ and date.
Implementation Notes: Search for all active assessment and plan of treatment for a patient within a time period. Fetches a bundle of all active (careplan = “active”) CarePlan resources for the specified patient for a specified time period. (how to search by reference), (how to search by token) and (how to search by date).
US Core © v1.0.0 (STU1) based on FHIR Release 3 (STU; 3.0.0) generated on Tue, Mar 21, 2017 11:28+1100. |
