This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Patient Care Work Group | Maturity Level: 1 | Compartments: Patient, Practitioner, RelatedPerson |
Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
Care Plans are used in many of areas of healthcare with a variety of scopes. They can be as simple as a general practitioner keeping track of when their patient is next due for a tetanus immunization through to a detailed plan for an oncology patient covering diet, chemotherapy, radiation, lab work and counseling with detailed timing relationships, pre-conditions and goals. They may be used in veterinary care or clinical research to describe the care of a herd or other collection of animals. In public health, they may describe education or immunization campaigns.
This resource takes an intermediate approach to complexity. It captures basic details about who is involved and what actions are intended without dealing in discrete data about dependencies and timing relationships. These can be supported where necessary using the extension mechanism.
The scope of care plans may vary widely. Examples include:
Note that this resource represents a specific plan instance for a particular patient or group. It is not intended to be used to define generic plans or protocols that are independent of a specific individual or group. I.e. It represents a specific intent, not a general definition. Protocols and order sets will be supported through future resources.
This resource can be used to represent both proposed plans (for example, recommendations from a decision support engine or returned as part of a consult report) as well as active plans. The nature of the plan is communicated by the status. Some systems may need to filter CarePlans to ensure that only appropriate plans are exposed via a given user interface.
For simplicity sake, CarePlan allows the in-line definition of activities as part of a plan using
the activity.detail
element. However, activities can also be defined using references
to the various "request" resources. These references could be to resources with a status of
"planned" or to an active order. It is possible for planned activities to exist (e.g. appointments)
without needing a CarePlan at all. CarePlans are used when there's a need to group activities,
goals and/or participants together to provide some degree of context.
CarePlans can be tied to specific Conditions however they can also be condition-independent and instead focused on a particular type of care (e.g. psychological, nutritional) or the care delivered by a particular practitioner or group of practitioners.
An ImmunizationRecommendation can be interpreted as a narrow type of Care Plan dealing only with immunization events. Where such information could appear in either resource, the immunization-specific resource is preferred.
PLANNED CHANGE:
CarePlan is one of the Request resources in the FHIR Workflow specification. As such, it is expected to be adjusted to align with the Request workflow pattern which will involve adding a number of additional data elements and potentially renaming a few elements. Note that the resource name will remain CarePlan, not CarePlanRequest or something similar. Any concerns about performing such alignment are welcome as ballot comments and/or tracker items.
This resource is referenced by ClinicalImpression, ImagingStudy, Procedure, QuestionnaireResponse and ReferralRequest
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | DomainResource | Healthcare plan for patient or group | ||
identifier | Σ | 0..* | Identifier | External Ids for this plan |
subject | Σ | 0..1 | Reference(Patient | Group) | Who care plan is for |
status | ?!Σ | 1..1 | code | proposed | draft | active | completed | cancelled CarePlanStatus (Required) |
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Created in context of |
period | Σ | 0..1 | Period | Time period plan covers |
author | Σ | 0..* | Reference(Patient | Practitioner | RelatedPerson | Organization) | Who is responsible for contents of the plan |
modified | Σ | 0..1 | dateTime | When last updated |
category | Σ | 0..* | CodeableConcept | Type of plan Care Plan Category (Example) |
description | Σ | 0..1 | string | Summary of nature of plan |
addresses | Σ | 0..* | Reference(Condition) | Health issues this plan addresses |
support | 0..* | Reference(Any) | Information considered as part of plan | |
relatedPlan | 0..* | BackboneElement | Plans related to this one | |
code | 0..1 | code | includes | replaces | fulfills CarePlanRelationship (Required) | |
plan | 1..1 | Reference(CarePlan) | Plan relationship exists with | |
careTeam | 0..* | Reference(CareTeam) | Who's involved in plan? | |
goal | 0..* | Reference(Goal) | Desired outcome of plan | |
activity | I | 0..* | BackboneElement | Action to occur as part of plan Provide a reference or detail, not both |
actionResulting | 0..* | Reference(Any) | Appointments, orders, etc. | |
outcome | 0..1 | CodeableConcept | Results of the activity | |
progress | 0..* | Annotation | Comments about the activity status/progress | |
reference | I | 0..1 | Reference(Appointment | CommunicationRequest | DeviceUseRequest | DiagnosticRequest | MedicationOrder | NutritionRequest | ProcedureRequest | ProcessRequest | ReferralRequest | SupplyRequest | VisionPrescription) | Activity details defined in specific resource |
detail | I | 0..1 | BackboneElement | In-line definition of activity |
category | 0..1 | CodeableConcept | diet | drug | encounter | observation | procedure | supply | other CarePlanActivityCategory (Example) | |
definition | 0..1 | Reference(PlanDefinition | Questionnaire) | Protocol or definition | |
code | 0..1 | CodeableConcept | Detail type of activity Care Plan Activity (Example) | |
reasonCode | 0..* | CodeableConcept | Why activity should be done Activity Reason (Example) | |
reasonReference | 0..* | Reference(Condition) | Condition triggering need for activity | |
goal | 0..* | Reference(Goal) | Goals this activity relates to | |
status | ?! | 0..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled CarePlanActivityStatus (Required) |
statusReason | 0..1 | CodeableConcept | Reason for current status GoalStatusReason (Example) | |
prohibited | ?! | 1..1 | boolean | Do NOT do |
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 | Organization | RelatedPerson | Patient) | Who will be responsible? | |
product[x] | 0..1 | What is to be administered/supplied SNOMED CT Medication Codes (Example) | ||
productCodeableConcept | CodeableConcept | |||
productReference | Reference(Medication | Substance) | |||
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..1 | Annotation | Comments about the plan | |
Documentation for this format |
UML Diagram (Legend)
XML Template
<CarePlan xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External Ids for this plan --></identifier> <subject><!-- 0..1 Reference(Patient|Group) Who care plan is for --></subject> <status value="[code]"/><!-- 1..1 proposed | draft | active | completed | cancelled --> <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Created in context of --></context> <period><!-- 0..1 Period Time period plan covers --></period> <author><!-- 0..* Reference(Patient|Practitioner|RelatedPerson|Organization) Who is responsible for contents of the plan --></author> <modified value="[dateTime]"/><!-- 0..1 When last updated --> <category><!-- 0..* CodeableConcept Type of plan --></category> <description value="[string]"/><!-- 0..1 Summary of nature of plan --> <addresses><!-- 0..* Reference(Condition) Health issues this plan addresses --></addresses> <support><!-- 0..* Reference(Any) Information considered as part of plan --></support> <relatedPlan> <!-- 0..* Plans related to this one --> <code value="[code]"/><!-- 0..1 includes | replaces | fulfills --> <plan><!-- 1..1 Reference(CarePlan) Plan relationship exists with --></plan> </relatedPlan> <careTeam><!-- 0..* Reference(CareTeam) Who's involved in plan? --></careTeam> <goal><!-- 0..* Reference(Goal) Desired outcome of plan --></goal> <activity> <!-- 0..* Action to occur as part of plan --> <actionResulting><!-- 0..* Reference(Any) Appointments, orders, etc. --></actionResulting> <outcome><!-- 0..1 CodeableConcept Results of the activity --></outcome> <progress><!-- 0..* Annotation Comments about the activity status/progress --></progress> <reference><!-- 0..1 Reference(Appointment|CommunicationRequest| DeviceUseRequest|DiagnosticRequest|MedicationOrder|NutritionRequest| ProcedureRequest|ProcessRequest|ReferralRequest|SupplyRequest| VisionPrescription) Activity details defined in specific resource --></reference> <detail> <!-- 0..1 In-line definition of activity --> <category><!-- 0..1 CodeableConcept diet | drug | encounter | observation | procedure | supply | other --></category> <definition><!-- 0..1 Reference(PlanDefinition|Questionnaire) Protocol or definition --></definition> <code><!-- 0..1 CodeableConcept Detail type of activity --></code> <reasonCode><!-- 0..* CodeableConcept Why activity should be done --></reasonCode> <reasonReference><!-- 0..* Reference(Condition) Condition triggering need for activity --></reasonReference> <goal><!-- 0..* Reference(Goal) Goals this activity relates to --></goal> <status value="[code]"/><!-- 0..1 not-started | scheduled | in-progress | on-hold | completed | cancelled --> <statusReason><!-- 0..1 CodeableConcept Reason for current status --></statusReason> <prohibited value="[boolean]"/><!-- 1..1 Do NOT do --> <scheduled[x]><!-- 0..1 Timing|Period|string When activity is to occur --></scheduled[x]> <location><!-- 0..1 Reference(Location) Where it should happen --></location> <performer><!-- 0..* Reference(Practitioner|Organization|RelatedPerson|Patient) Who will be responsible? --></performer> <product[x]><!-- 0..1 CodeableConcept|Reference(Medication|Substance) What is to be administered/supplied --></product[x]> <dailyAmount><!-- 0..1 Quantity(SimpleQuantity) How to consume/day? --></dailyAmount> <quantity><!-- 0..1 Quantity(SimpleQuantity) How much to administer/supply/consume --></quantity> <description value="[string]"/><!-- 0..1 Extra info describing activity to perform --> </detail> </activity> <note><!-- 0..1 Annotation Comments about the plan --></note> </CarePlan>
JSON Template
{ "resourceType" : "CarePlan", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // External Ids for this plan "subject" : { Reference(Patient|Group) }, // Who care plan is for "status" : "<code>", // R! proposed | draft | active | completed | cancelled "context" : { Reference(Encounter|EpisodeOfCare) }, // Created in context of "period" : { Period }, // Time period plan covers "author" : [{ Reference(Patient|Practitioner|RelatedPerson|Organization) }], // Who is responsible for contents of the plan "modified" : "<dateTime>", // When last updated "category" : [{ CodeableConcept }], // Type of plan "description" : "<string>", // Summary of nature of plan "addresses" : [{ Reference(Condition) }], // Health issues this plan addresses "support" : [{ Reference(Any) }], // Information considered as part of plan "relatedPlan" : [{ // Plans related to this one "code" : "<code>", // includes | replaces | fulfills "plan" : { Reference(CarePlan) } // R! Plan relationship exists with }], "careTeam" : [{ Reference(CareTeam) }], // Who's involved in plan? "goal" : [{ Reference(Goal) }], // Desired outcome of plan "activity" : [{ // Action to occur as part of plan "actionResulting" : [{ Reference(Any) }], // Appointments, orders, etc. "outcome" : { CodeableConcept }, // Results of the activity "progress" : [{ Annotation }], // Comments about the activity status/progress "reference" : { Reference(Appointment|CommunicationRequest| DeviceUseRequest|DiagnosticRequest|MedicationOrder|NutritionRequest| ProcedureRequest|ProcessRequest|ReferralRequest|SupplyRequest| VisionPrescription) }, // C? Activity details defined in specific resource "detail" : { // C? In-line definition of activity "category" : { CodeableConcept }, // diet | drug | encounter | observation | procedure | supply | other "definition" : { Reference(PlanDefinition|Questionnaire) }, // Protocol or definition "code" : { CodeableConcept }, // Detail type of activity "reasonCode" : [{ CodeableConcept }], // Why activity should be done "reasonReference" : [{ Reference(Condition) }], // Condition triggering need for activity "goal" : [{ Reference(Goal) }], // Goals this activity relates to "status" : "<code>", // not-started | scheduled | in-progress | on-hold | completed | cancelled "statusReason" : { CodeableConcept }, // Reason for current status "prohibited" : <boolean>, // R! Do NOT do // scheduled[x]: When activity is to occur. One of these 3: "scheduledTiming" : { Timing }, "scheduledPeriod" : { Period }, "scheduledString" : "<string>", "location" : { Reference(Location) }, // Where it should happen "performer" : [{ Reference(Practitioner|Organization|RelatedPerson|Patient) }], // Who will be responsible? // product[x]: What is to be administered/supplied. One of these 2: "productCodeableConcept" : { CodeableConcept }, "productReference" : { Reference(Medication|Substance) }, "dailyAmount" : { Quantity(SimpleQuantity) }, // How to consume/day? "quantity" : { Quantity(SimpleQuantity) }, // How much to administer/supply/consume "description" : "<string>" // Extra info describing activity to perform } }], "note" : { Annotation } // Comments about the plan }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:CarePlan; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:CarePlan.identifier [ Identifier ], ... ; # 0..* External Ids for this plan fhir:CarePlan.subject [ Reference(Patient|Group) ]; # 0..1 Who care plan is for fhir:CarePlan.status [ code ]; # 1..1 proposed | draft | active | completed | cancelled fhir:CarePlan.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 Created in context of fhir:CarePlan.period [ Period ]; # 0..1 Time period plan covers fhir:CarePlan.author [ Reference(Patient|Practitioner|RelatedPerson|Organization) ], ... ; # 0..* Who is responsible for contents of the plan fhir:CarePlan.modified [ dateTime ]; # 0..1 When last updated fhir:CarePlan.category [ CodeableConcept ], ... ; # 0..* Type of plan fhir:CarePlan.description [ string ]; # 0..1 Summary of nature of plan fhir:CarePlan.addresses [ Reference(Condition) ], ... ; # 0..* Health issues this plan addresses fhir:CarePlan.support [ Reference(Any) ], ... ; # 0..* Information considered as part of plan fhir:CarePlan.relatedPlan [ # 0..* Plans related to this one fhir:CarePlan.relatedPlan.code [ code ]; # 0..1 includes | replaces | fulfills fhir:CarePlan.relatedPlan.plan [ Reference(CarePlan) ]; # 1..1 Plan relationship exists with ], ...; fhir:CarePlan.careTeam [ Reference(CareTeam) ], ... ; # 0..* Who's involved in plan? fhir:CarePlan.goal [ Reference(Goal) ], ... ; # 0..* Desired outcome of plan fhir:CarePlan.activity [ # 0..* Action to occur as part of plan fhir:CarePlan.activity.actionResulting [ Reference(Any) ], ... ; # 0..* Appointments, orders, etc. fhir:CarePlan.activity.outcome [ CodeableConcept ]; # 0..1 Results of the activity fhir:CarePlan.activity.progress [ Annotation ], ... ; # 0..* Comments about the activity status/progress fhir:CarePlan.activity.reference [ Reference(Appointment|CommunicationRequest|DeviceUseRequest|DiagnosticRequest| MedicationOrder|NutritionRequest|ProcedureRequest|ProcessRequest| ReferralRequest|SupplyRequest|VisionPrescription) ]; # 0..1 Activity details defined in specific resource fhir:CarePlan.activity.detail [ # 0..1 In-line definition of activity fhir:CarePlan.activity.detail.category [ CodeableConcept ]; # 0..1 diet | drug | encounter | observation | procedure | supply | other fhir:CarePlan.activity.detail.definition [ Reference(PlanDefinition|Questionnaire) ]; # 0..1 Protocol or definition fhir:CarePlan.activity.detail.code [ CodeableConcept ]; # 0..1 Detail type of activity fhir:CarePlan.activity.detail.reasonCode [ CodeableConcept ], ... ; # 0..* Why activity should be done fhir:CarePlan.activity.detail.reasonReference [ Reference(Condition) ], ... ; # 0..* Condition triggering need for activity fhir:CarePlan.activity.detail.goal [ Reference(Goal) ], ... ; # 0..* Goals this activity relates to fhir:CarePlan.activity.detail.status [ code ]; # 0..1 not-started | scheduled | in-progress | on-hold | completed | cancelled fhir:CarePlan.activity.detail.statusReason [ CodeableConcept ]; # 0..1 Reason for current status fhir:CarePlan.activity.detail.prohibited [ boolean ]; # 1..1 Do NOT do # CarePlan.activity.detail.scheduled[x] : 0..1 When activity is to occur. One of these 3 fhir:CarePlan.activity.detail.scheduledTiming [ Timing ] fhir:CarePlan.activity.detail.scheduledPeriod [ Period ] fhir:CarePlan.activity.detail.scheduledString [ string ] fhir:CarePlan.activity.detail.location [ Reference(Location) ]; # 0..1 Where it should happen fhir:CarePlan.activity.detail.performer [ Reference(Practitioner|Organization|RelatedPerson|Patient) ], ... ; # 0..* Who will be responsible? # CarePlan.activity.detail.product[x] : 0..1 What is to be administered/supplied. One of these 2 fhir:CarePlan.activity.detail.productCodeableConcept [ CodeableConcept ] fhir:CarePlan.activity.detail.productReference [ Reference(Medication|Substance) ] fhir:CarePlan.activity.detail.dailyAmount [ Quantity(SimpleQuantity) ]; # 0..1 How to consume/day? fhir:CarePlan.activity.detail.quantity [ Quantity(SimpleQuantity) ]; # 0..1 How much to administer/supply/consume fhir:CarePlan.activity.detail.description [ string ]; # 0..1 Extra info describing activity to perform ]; ], ...; fhir:CarePlan.note [ Annotation ]; # 0..1 Comments about the plan ]
Changes since DSTU2
CarePlan | |
CarePlan.careTeam | added |
CarePlan.activity.outcome | added |
CarePlan.activity.reference | Remove Reference(DiagnosticOrder), Remove Reference(NutritionOrder), Remove Reference(Order), Add Reference(DiagnosticRequest), Add Reference(NutritionRequest) |
CarePlan.activity.detail.definition | added |
CarePlan.participant | deleted |
See the Full Difference for further information
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | DomainResource | Healthcare plan for patient or group | ||
identifier | Σ | 0..* | Identifier | External Ids for this plan |
subject | Σ | 0..1 | Reference(Patient | Group) | Who care plan is for |
status | ?!Σ | 1..1 | code | proposed | draft | active | completed | cancelled CarePlanStatus (Required) |
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Created in context of |
period | Σ | 0..1 | Period | Time period plan covers |
author | Σ | 0..* | Reference(Patient | Practitioner | RelatedPerson | Organization) | Who is responsible for contents of the plan |
modified | Σ | 0..1 | dateTime | When last updated |
category | Σ | 0..* | CodeableConcept | Type of plan Care Plan Category (Example) |
description | Σ | 0..1 | string | Summary of nature of plan |
addresses | Σ | 0..* | Reference(Condition) | Health issues this plan addresses |
support | 0..* | Reference(Any) | Information considered as part of plan | |
relatedPlan | 0..* | BackboneElement | Plans related to this one | |
code | 0..1 | code | includes | replaces | fulfills CarePlanRelationship (Required) | |
plan | 1..1 | Reference(CarePlan) | Plan relationship exists with | |
careTeam | 0..* | Reference(CareTeam) | Who's involved in plan? | |
goal | 0..* | Reference(Goal) | Desired outcome of plan | |
activity | I | 0..* | BackboneElement | Action to occur as part of plan Provide a reference or detail, not both |
actionResulting | 0..* | Reference(Any) | Appointments, orders, etc. | |
outcome | 0..1 | CodeableConcept | Results of the activity | |
progress | 0..* | Annotation | Comments about the activity status/progress | |
reference | I | 0..1 | Reference(Appointment | CommunicationRequest | DeviceUseRequest | DiagnosticRequest | MedicationOrder | NutritionRequest | ProcedureRequest | ProcessRequest | ReferralRequest | SupplyRequest | VisionPrescription) | Activity details defined in specific resource |
detail | I | 0..1 | BackboneElement | In-line definition of activity |
category | 0..1 | CodeableConcept | diet | drug | encounter | observation | procedure | supply | other CarePlanActivityCategory (Example) | |
definition | 0..1 | Reference(PlanDefinition | Questionnaire) | Protocol or definition | |
code | 0..1 | CodeableConcept | Detail type of activity Care Plan Activity (Example) | |
reasonCode | 0..* | CodeableConcept | Why activity should be done Activity Reason (Example) | |
reasonReference | 0..* | Reference(Condition) | Condition triggering need for activity | |
goal | 0..* | Reference(Goal) | Goals this activity relates to | |
status | ?! | 0..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled CarePlanActivityStatus (Required) |
statusReason | 0..1 | CodeableConcept | Reason for current status GoalStatusReason (Example) | |
prohibited | ?! | 1..1 | boolean | Do NOT do |
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 | Organization | RelatedPerson | Patient) | Who will be responsible? | |
product[x] | 0..1 | What is to be administered/supplied SNOMED CT Medication Codes (Example) | ||
productCodeableConcept | CodeableConcept | |||
productReference | Reference(Medication | Substance) | |||
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..1 | Annotation | Comments about the plan | |
Documentation for this format |
XML Template
<CarePlan xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External Ids for this plan --></identifier> <subject><!-- 0..1 Reference(Patient|Group) Who care plan is for --></subject> <status value="[code]"/><!-- 1..1 proposed | draft | active | completed | cancelled --> <context><!-- 0..1 Reference(Encounter|EpisodeOfCare) Created in context of --></context> <period><!-- 0..1 Period Time period plan covers --></period> <author><!-- 0..* Reference(Patient|Practitioner|RelatedPerson|Organization) Who is responsible for contents of the plan --></author> <modified value="[dateTime]"/><!-- 0..1 When last updated --> <category><!-- 0..* CodeableConcept Type of plan --></category> <description value="[string]"/><!-- 0..1 Summary of nature of plan --> <addresses><!-- 0..* Reference(Condition) Health issues this plan addresses --></addresses> <support><!-- 0..* Reference(Any) Information considered as part of plan --></support> <relatedPlan> <!-- 0..* Plans related to this one --> <code value="[code]"/><!-- 0..1 includes | replaces | fulfills --> <plan><!-- 1..1 Reference(CarePlan) Plan relationship exists with --></plan> </relatedPlan> <careTeam><!-- 0..* Reference(CareTeam) Who's involved in plan? --></careTeam> <goal><!-- 0..* Reference(Goal) Desired outcome of plan --></goal> <activity> <!-- 0..* Action to occur as part of plan --> <actionResulting><!-- 0..* Reference(Any) Appointments, orders, etc. --></actionResulting> <outcome><!-- 0..1 CodeableConcept Results of the activity --></outcome> <progress><!-- 0..* Annotation Comments about the activity status/progress --></progress> <reference><!-- 0..1 Reference(Appointment|CommunicationRequest| DeviceUseRequest|DiagnosticRequest|MedicationOrder|NutritionRequest| ProcedureRequest|ProcessRequest|ReferralRequest|SupplyRequest| VisionPrescription) Activity details defined in specific resource --></reference> <detail> <!-- 0..1 In-line definition of activity --> <category><!-- 0..1 CodeableConcept diet | drug | encounter | observation | procedure | supply | other --></category> <definition><!-- 0..1 Reference(PlanDefinition|Questionnaire) Protocol or definition --></definition> <code><!-- 0..1 CodeableConcept Detail type of activity --></code> <reasonCode><!-- 0..* CodeableConcept Why activity should be done --></reasonCode> <reasonReference><!-- 0..* Reference(Condition) Condition triggering need for activity --></reasonReference> <goal><!-- 0..* Reference(Goal) Goals this activity relates to --></goal> <status value="[code]"/><!-- 0..1 not-started | scheduled | in-progress | on-hold | completed | cancelled --> <statusReason><!-- 0..1 CodeableConcept Reason for current status --></statusReason> <prohibited value="[boolean]"/><!-- 1..1 Do NOT do --> <scheduled[x]><!-- 0..1 Timing|Period|string When activity is to occur --></scheduled[x]> <location><!-- 0..1 Reference(Location) Where it should happen --></location> <performer><!-- 0..* Reference(Practitioner|Organization|RelatedPerson|Patient) Who will be responsible? --></performer> <product[x]><!-- 0..1 CodeableConcept|Reference(Medication|Substance) What is to be administered/supplied --></product[x]> <dailyAmount><!-- 0..1 Quantity(SimpleQuantity) How to consume/day? --></dailyAmount> <quantity><!-- 0..1 Quantity(SimpleQuantity) How much to administer/supply/consume --></quantity> <description value="[string]"/><!-- 0..1 Extra info describing activity to perform --> </detail> </activity> <note><!-- 0..1 Annotation Comments about the plan --></note> </CarePlan>
JSON Template
{ "resourceType" : "CarePlan", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // External Ids for this plan "subject" : { Reference(Patient|Group) }, // Who care plan is for "status" : "<code>", // R! proposed | draft | active | completed | cancelled "context" : { Reference(Encounter|EpisodeOfCare) }, // Created in context of "period" : { Period }, // Time period plan covers "author" : [{ Reference(Patient|Practitioner|RelatedPerson|Organization) }], // Who is responsible for contents of the plan "modified" : "<dateTime>", // When last updated "category" : [{ CodeableConcept }], // Type of plan "description" : "<string>", // Summary of nature of plan "addresses" : [{ Reference(Condition) }], // Health issues this plan addresses "support" : [{ Reference(Any) }], // Information considered as part of plan "relatedPlan" : [{ // Plans related to this one "code" : "<code>", // includes | replaces | fulfills "plan" : { Reference(CarePlan) } // R! Plan relationship exists with }], "careTeam" : [{ Reference(CareTeam) }], // Who's involved in plan? "goal" : [{ Reference(Goal) }], // Desired outcome of plan "activity" : [{ // Action to occur as part of plan "actionResulting" : [{ Reference(Any) }], // Appointments, orders, etc. "outcome" : { CodeableConcept }, // Results of the activity "progress" : [{ Annotation }], // Comments about the activity status/progress "reference" : { Reference(Appointment|CommunicationRequest| DeviceUseRequest|DiagnosticRequest|MedicationOrder|NutritionRequest| ProcedureRequest|ProcessRequest|ReferralRequest|SupplyRequest| VisionPrescription) }, // C? Activity details defined in specific resource "detail" : { // C? In-line definition of activity "category" : { CodeableConcept }, // diet | drug | encounter | observation | procedure | supply | other "definition" : { Reference(PlanDefinition|Questionnaire) }, // Protocol or definition "code" : { CodeableConcept }, // Detail type of activity "reasonCode" : [{ CodeableConcept }], // Why activity should be done "reasonReference" : [{ Reference(Condition) }], // Condition triggering need for activity "goal" : [{ Reference(Goal) }], // Goals this activity relates to "status" : "<code>", // not-started | scheduled | in-progress | on-hold | completed | cancelled "statusReason" : { CodeableConcept }, // Reason for current status "prohibited" : <boolean>, // R! Do NOT do // scheduled[x]: When activity is to occur. One of these 3: "scheduledTiming" : { Timing }, "scheduledPeriod" : { Period }, "scheduledString" : "<string>", "location" : { Reference(Location) }, // Where it should happen "performer" : [{ Reference(Practitioner|Organization|RelatedPerson|Patient) }], // Who will be responsible? // product[x]: What is to be administered/supplied. One of these 2: "productCodeableConcept" : { CodeableConcept }, "productReference" : { Reference(Medication|Substance) }, "dailyAmount" : { Quantity(SimpleQuantity) }, // How to consume/day? "quantity" : { Quantity(SimpleQuantity) }, // How much to administer/supply/consume "description" : "<string>" // Extra info describing activity to perform } }], "note" : { Annotation } // Comments about the plan }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:CarePlan; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:CarePlan.identifier [ Identifier ], ... ; # 0..* External Ids for this plan fhir:CarePlan.subject [ Reference(Patient|Group) ]; # 0..1 Who care plan is for fhir:CarePlan.status [ code ]; # 1..1 proposed | draft | active | completed | cancelled fhir:CarePlan.context [ Reference(Encounter|EpisodeOfCare) ]; # 0..1 Created in context of fhir:CarePlan.period [ Period ]; # 0..1 Time period plan covers fhir:CarePlan.author [ Reference(Patient|Practitioner|RelatedPerson|Organization) ], ... ; # 0..* Who is responsible for contents of the plan fhir:CarePlan.modified [ dateTime ]; # 0..1 When last updated fhir:CarePlan.category [ CodeableConcept ], ... ; # 0..* Type of plan fhir:CarePlan.description [ string ]; # 0..1 Summary of nature of plan fhir:CarePlan.addresses [ Reference(Condition) ], ... ; # 0..* Health issues this plan addresses fhir:CarePlan.support [ Reference(Any) ], ... ; # 0..* Information considered as part of plan fhir:CarePlan.relatedPlan [ # 0..* Plans related to this one fhir:CarePlan.relatedPlan.code [ code ]; # 0..1 includes | replaces | fulfills fhir:CarePlan.relatedPlan.plan [ Reference(CarePlan) ]; # 1..1 Plan relationship exists with ], ...; fhir:CarePlan.careTeam [ Reference(CareTeam) ], ... ; # 0..* Who's involved in plan? fhir:CarePlan.goal [ Reference(Goal) ], ... ; # 0..* Desired outcome of plan fhir:CarePlan.activity [ # 0..* Action to occur as part of plan fhir:CarePlan.activity.actionResulting [ Reference(Any) ], ... ; # 0..* Appointments, orders, etc. fhir:CarePlan.activity.outcome [ CodeableConcept ]; # 0..1 Results of the activity fhir:CarePlan.activity.progress [ Annotation ], ... ; # 0..* Comments about the activity status/progress fhir:CarePlan.activity.reference [ Reference(Appointment|CommunicationRequest|DeviceUseRequest|DiagnosticRequest| MedicationOrder|NutritionRequest|ProcedureRequest|ProcessRequest| ReferralRequest|SupplyRequest|VisionPrescription) ]; # 0..1 Activity details defined in specific resource fhir:CarePlan.activity.detail [ # 0..1 In-line definition of activity fhir:CarePlan.activity.detail.category [ CodeableConcept ]; # 0..1 diet | drug | encounter | observation | procedure | supply | other fhir:CarePlan.activity.detail.definition [ Reference(PlanDefinition|Questionnaire) ]; # 0..1 Protocol or definition fhir:CarePlan.activity.detail.code [ CodeableConcept ]; # 0..1 Detail type of activity fhir:CarePlan.activity.detail.reasonCode [ CodeableConcept ], ... ; # 0..* Why activity should be done fhir:CarePlan.activity.detail.reasonReference [ Reference(Condition) ], ... ; # 0..* Condition triggering need for activity fhir:CarePlan.activity.detail.goal [ Reference(Goal) ], ... ; # 0..* Goals this activity relates to fhir:CarePlan.activity.detail.status [ code ]; # 0..1 not-started | scheduled | in-progress | on-hold | completed | cancelled fhir:CarePlan.activity.detail.statusReason [ CodeableConcept ]; # 0..1 Reason for current status fhir:CarePlan.activity.detail.prohibited [ boolean ]; # 1..1 Do NOT do # CarePlan.activity.detail.scheduled[x] : 0..1 When activity is to occur. One of these 3 fhir:CarePlan.activity.detail.scheduledTiming [ Timing ] fhir:CarePlan.activity.detail.scheduledPeriod [ Period ] fhir:CarePlan.activity.detail.scheduledString [ string ] fhir:CarePlan.activity.detail.location [ Reference(Location) ]; # 0..1 Where it should happen fhir:CarePlan.activity.detail.performer [ Reference(Practitioner|Organization|RelatedPerson|Patient) ], ... ; # 0..* Who will be responsible? # CarePlan.activity.detail.product[x] : 0..1 What is to be administered/supplied. One of these 2 fhir:CarePlan.activity.detail.productCodeableConcept [ CodeableConcept ] fhir:CarePlan.activity.detail.productReference [ Reference(Medication|Substance) ] fhir:CarePlan.activity.detail.dailyAmount [ Quantity(SimpleQuantity) ]; # 0..1 How to consume/day? fhir:CarePlan.activity.detail.quantity [ Quantity(SimpleQuantity) ]; # 0..1 How much to administer/supply/consume fhir:CarePlan.activity.detail.description [ string ]; # 0..1 Extra info describing activity to perform ]; ], ...; fhir:CarePlan.note [ Annotation ]; # 0..1 Comments about the plan ]
Changes since DSTU2
CarePlan | |
CarePlan.careTeam | added |
CarePlan.activity.outcome | added |
CarePlan.activity.reference | Remove Reference(DiagnosticOrder), Remove Reference(NutritionOrder), Remove Reference(Order), Add Reference(DiagnosticRequest), Add Reference(NutritionRequest) |
CarePlan.activity.detail.definition | added |
CarePlan.participant | deleted |
See the Full Difference for further information
Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)
Path | Definition | Type | Reference |
---|---|---|---|
CarePlan.status | Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | Required | CarePlanStatus |
CarePlan.category | Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | Example | Care Plan Category |
CarePlan.relatedPlan.code | Codes identifying the types of relationships between two plans. | Required | CarePlanRelationship |
CarePlan.activity.outcome | Identifies the results of the activity | Unknown | No details provided yet |
CarePlan.activity.detail.category | High-level categorization of the type of activity in a care plan. | Example | CarePlanActivityCategory |
CarePlan.activity.detail.code | Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | Example | Care Plan Activity |
CarePlan.activity.detail.reasonCode | 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. | Example | Activity Reason |
CarePlan.activity.detail.status | Indicates where the activity is at in its overall life cycle. | Required | CarePlanActivityStatus |
CarePlan.activity.detail.statusReason | Describes why the current activity has the status it does; e.g. "Recovering from injury" as a reason for non-started or on-hold, "Patient does not enjoy activity" as a reason for cancelling a planned activity. | Example | GoalStatusReason |
CarePlan.activity.detail.product[x] | A product supplied or administered as part of a care plan activity. | Example | SNOMED CT Medication Codes |
DSTU Note: During the Trial use period, feedback is welcome on two issues:
- This resource combines the concepts of "Care Plan" and "Care Team" into a single resource. Is this appropriate?
- At present, the patient element is optional to allow experimentation with care plan templates, though the resource was not designed for this use
Feedback here .
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths |
activitycode | token | Detail type of activity | CarePlan.activity.detail.code |
activitydate | date | Specified date occurs within period specified by CarePlan.activity.timingSchedule | CarePlan.activity.detail.scheduled[x] |
activityreference | reference | Activity details defined in specific resource | CarePlan.activity.reference (Appointment, ReferralRequest, NutritionRequest, ProcessRequest, VisionPrescription, ProcedureRequest, DeviceUseRequest, MedicationOrder, DiagnosticRequest, CommunicationRequest, SupplyRequest) |
careteam | reference | Who's involved in plan? | CarePlan.careTeam (CareTeam) |
category | token | Type of plan | CarePlan.category |
condition | reference | Health issues this plan addresses | CarePlan.addresses (Condition) |
date | date | Time period plan covers | CarePlan.period |
goal | reference | Desired outcome of plan | CarePlan.goal (Goal) |
patient | reference | Who care plan is for | CarePlan.subject (Patient) |
performer | reference | Matches if the practitioner is listed as a performer in any of the "simple" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.) | CarePlan.activity.detail.performer (Practitioner, Organization, Patient, RelatedPerson) |
related | composite | A combination of the type of relationship and the related plan | |
relatedcode | token | includes | replaces | fulfills | CarePlan.relatedPlan.code |
relatedplan | reference | Plan relationship exists with | CarePlan.relatedPlan.plan (CarePlan) |
subject | reference | Who care plan is for | CarePlan.subject (Group, Patient) |