FHIR Release 3 (STU)
Clinical SummaryThis page is part of the FHIR Specification (v3.0.2: STU 3). 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: 2 | Trial Use | 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.
CarePlan is one of the request resources in the FHIR workflow specification.
Care Plans are used in many 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:
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.
CarePlans represent 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. CarePlan represents a specific intent, not a general definition. Protocols and order sets are supported through PlanDefinition.
This resource is referenced by DiagnosticReport, GuidanceResponse, ImagingStudy, MedicationRequest, MedicationStatement, Observation, Procedure, QuestionnaireResponse and ReferralRequest
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CarePlan | DomainResource | Healthcare plan for patient or group Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
  identifier | Σ | 0..* | Identifier | External Ids for this plan |
 definition | Σ | 0..* | Reference(PlanDefinition | 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 | ?!Σ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled | unknown CarePlanStatus (Required) |
| intent | ?!Σ | 1..1 | code | proposal | plan | order | option CarePlanIntent (Required) |
| category | Σ | 0..* | CodeableConcept | Type of plan Care Plan Category (Example) |
| title | Σ | 0..1 | string | Human-friendly name for the CarePlan |
| description | Σ | 0..1 | string | Summary of nature of plan |
| subject | Σ | 1..1 | Reference(Patient | Group) | Who care plan is for |
| 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 | 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(Any) | 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 + Provide a reference or detail, not both |
 outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Care Plan Activity Outcome (Example) | |
| outcomeReference | 0..* | Reference(Any) | Appointment, Encounter, Procedure, etc. | |
| progress | 0..* | Annotation | Comments about the activity status/progress | |
| reference | I | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup) | 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 | ActivityDefinition | Questionnaire) | Protocol or definition | |
| code | 0..1 | CodeableConcept | Detail type of activity Care Plan Activity (Example) | |
| reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited 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 CarePlanActivityStatus (Required) |
| statusReason | 0..1 | string | Reason for current status | |
| prohibited | ?! | 0..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 | CareTeam) | 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..* | 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> <definition><!-- 0..* Reference(PlanDefinition|Questionnaire) Protocol or definition --></definition> <basedOn><!-- 0..* Reference(CarePlan) Fulfills care plan --></basedOn> <replaces><!-- 0..* Reference(CarePlan) CarePlan replaced by this CarePlan --></replaces> <partOf><!-- 0..* Reference(CarePlan) Part of referenced CarePlan --></partOf> <status value="[code]"/><!-- 1..1 draft | active | suspended | completed | entered-in-error | cancelled | unknown --> <intent value="[code]"/><!-- 1..1 proposal | plan | order | option --> <category><!-- 0..* CodeableConcept Type of plan --></category> <title value="[string]"/><!-- 0..1 Human-friendly name for the CarePlan --> <description value="[string]"/><!-- 0..1 Summary of nature of plan --> <subject><!-- 1..1 Reference(Patient|Group) Who care plan is for --></subject> <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| CareTeam) Who is responsible for contents of the plan --></author> <careTeam><!-- 0..* Reference(CareTeam) Who's involved in plan? --></careTeam> <addresses><!-- 0..* Reference(Condition) Health issues this plan addresses --></addresses> <supportingInfo><!-- 0..* Reference(Any) Information considered as part of plan --></supportingInfo> <goal><!-- 0..* Reference(Goal) Desired outcome of plan --></goal> <activity> <!-- 0..* Action to occur as part of plan --> <outcomeCodeableConcept><!-- 0..* CodeableConcept Results of the activity --></outcomeCodeableConcept> <outcomeReference><!-- 0..* Reference(Any) Appointment, Encounter, Procedure, etc. --></outcomeReference> <progress><!-- 0..* Annotation Comments about the activity status/progress --></progress> <reference><!--
0..1 Reference(Appointment|CommunicationRequest|DeviceRequest| MedicationRequest|NutritionOrder|Task|ProcedureRequest|ReferralRequest| VisionPrescription|RequestGroup) Activity details defined in specific resource --></reference> <detail> <!--
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
"definition" : [{ Reference(PlanDefinition|Questionnaire) }], // Protocol or definition
"basedOn" : [{ Reference(CarePlan) }], // Fulfills care plan
"replaces" : [{ Reference(CarePlan) }], // CarePlan replaced by this CarePlan
"partOf" : [{ Reference(CarePlan) }], // Part of referenced CarePlan
"status" : "<code>", // R! draft | active | suspended | completed | entered-in-error | cancelled | unknown
"intent" : "<code>", // R! proposal | plan | order | option
"category" : [{ CodeableConcept }], // Type of plan
"title" : "<string>", // Human-friendly name for the CarePlan
"description" : "<string>", // Summary of nature of plan
"subject" : { Reference(Patient|Group) }, // R! Who care plan is for
"context" : { Reference(Encounter|EpisodeOfCare) }, // Created in context of
"period" : { Period }, // Time period plan covers
"author" : [{ Reference(Patient|Practitioner|RelatedPerson|Organization|
CareTeam) }], // Who is responsible for contents of the plan
"careTeam" : [{ Reference(CareTeam) }], // Who's involved in plan?
"addresses" : [{ Reference(Condition) }], // Health issues this plan addresses
"supportingInfo" : [{ Reference(Any) }], // Information considered as part of plan
"goal" : [{ Reference(Goal) }], // Desired outcome of plan
"activity" : [{ // Action to occur as part of plan
"outcomeCodeableConcept" : [{ CodeableConcept }], // Results of the activity
"outcomeReference" : [{ Reference(Any) }], // Appointment, Encounter, Procedure, etc.
"progress" : [{ Annotation }], // Comments about the activity status/progress
"reference" : { Reference(Appointment|CommunicationRequest|DeviceRequest|
MedicationRequest|NutritionOrder|Task|ProcedureRequest|ReferralRequest|
VisionPrescription|RequestGroup) }, // 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|ActivityDefinition|
Questionnaire) }, // Protocol or definition
"code" : { CodeableConcept }, // Detail type of activity
"reasonCode" : [{ CodeableConcept }], // Why activity should be done or why activity was prohibited
"reasonReference" : [{ Reference(Condition) }], // Condition triggering need for activity
"goal" : [{ Reference(Goal) }], // Goals this activity relates to
"status" : "<code>", // R! not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown
"statusReason" : "<string>", // Reason for current status
"prohibited" : <boolean>, // 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|
CareTeam) }], // 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/> .
Changes since DSTU2
| CarePlan | |
| CarePlan.definition |
|
| CarePlan.basedOn |
|
| CarePlan.replaces |
|
| CarePlan.partOf |
|
| CarePlan.intent |
|
| CarePlan.title |
|
| CarePlan.subject |
|
| CarePlan.author |
|
| CarePlan.careTeam |
|
| CarePlan.supportingInfo |
|
| CarePlan.activity.outcomeCodeableConcept |
|
| CarePlan.activity.outcomeReference |
|
| CarePlan.activity.reference |
|
| CarePlan.activity.detail.definition |
|
| CarePlan.activity.detail.status |
|
| CarePlan.activity.detail.statusReason |
|
| CarePlan.activity.detail.prohibited |
|
| CarePlan.activity.detail.performer |
|
| CarePlan.note |
|
| CarePlan.modified |
|
| CarePlan.relatedPlan |
|
| CarePlan.participant |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R2 <--> R3 Conversion Maps (status = 10 tests that all execute ok. 8 fail round-trip testing and 10 r3 resources are invalid (33 errors).).
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CarePlan | DomainResource | Healthcare plan for patient or group Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | ||
| identifier | Σ | 0..* | Identifier | External Ids for this plan |
| definition | Σ | 0..* | Reference(PlanDefinition | 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 | ?!Σ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled | unknown CarePlanStatus (Required) |
| intent | ?!Σ | 1..1 | code | proposal | plan | order | option CarePlanIntent (Required) |
| category | Σ | 0..* | CodeableConcept | Type of plan Care Plan Category (Example) |
| title | Σ | 0..1 | string | Human-friendly name for the CarePlan |
| description | Σ | 0..1 | string | Summary of nature of plan |
| subject | Σ | 1..1 | Reference(Patient | Group) | Who care plan is for |
| 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 | 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(Any) | 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 + Provide a reference or detail, not both |
| outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Care Plan Activity Outcome (Example) | |
| outcomeReference | 0..* | Reference(Any) | Appointment, Encounter, Procedure, etc. | |
| progress | 0..* | Annotation | Comments about the activity status/progress | |
| reference | I | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup) | 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 | ActivityDefinition | Questionnaire) | Protocol or definition | |
| code | 0..1 | CodeableConcept | Detail type of activity Care Plan Activity (Example) | |
| reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited 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 CarePlanActivityStatus (Required) |
| statusReason | 0..1 | string | Reason for current status | |
| prohibited | ?! | 0..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 | CareTeam) | 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..* | Annotation | Comments about the plan | |
| Documentation for this format | ||||
XML Template
<CarePlan xmlns="http://hl7.org/fhir">
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
"definition" : [{ Reference(PlanDefinition|Questionnaire) }], // Protocol or definition
"basedOn" : [{ Reference(CarePlan) }], // Fulfills care plan
"replaces" : [{ Reference(CarePlan) }], // CarePlan replaced by this CarePlan
"partOf" : [{ Reference(CarePlan) }], // Part of referenced CarePlan
"status" : "<code>", // R! draft | active | suspended | completed | entered-in-error | cancelled | unknown
"intent" : "<code>", // R! proposal | plan | order | option
"category" : [{ CodeableConcept }], // Type of plan
"title" : "<string>", // Human-friendly name for the CarePlan
"description" : "<string>", // Summary of nature of plan
"subject" : { Reference(Patient|Group) }, // R! Who care plan is for
"context" : { Reference(Encounter|EpisodeOfCare) }, // Created in context of
"period" : { Period }, // Time period plan covers
"author" : [{ Reference(Patient|Practitioner|RelatedPerson|Organization|
CareTeam) }], // Who is responsible for contents of the plan
"careTeam" : [{ Reference(CareTeam) }], // Who's involved in plan?
"addresses" : [{ Reference(Condition) }], // Health issues this plan addresses
"supportingInfo" : [{ Reference(Any) }], // Information considered as part of plan
"goal" : [{ Reference(Goal) }], // Desired outcome of plan
"activity" : [{ // Action to occur as part of plan
"outcomeCodeableConcept" : [{ CodeableConcept }], // Results of the activity
"outcomeReference" : [{ Reference(Any) }], // Appointment, Encounter, Procedure, etc.
"progress" : [{ Annotation }], // Comments about the activity status/progress
"reference" : { Reference(Appointment|CommunicationRequest|DeviceRequest|
MedicationRequest|NutritionOrder|Task|ProcedureRequest|ReferralRequest|
VisionPrescription|RequestGroup) }, // 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|ActivityDefinition|
Questionnaire) }, // Protocol or definition
"code" : { CodeableConcept }, // Detail type of activity
"reasonCode" : [{ CodeableConcept }], // Why activity should be done or why activity was prohibited
"reasonReference" : [{ Reference(Condition) }], // Condition triggering need for activity
"goal" : [{ Reference(Goal) }], // Goals this activity relates to
"status" : "<code>", // R! not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown
"statusReason" : "<string>", // Reason for current status
"prohibited" : <boolean>, // 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|
CareTeam) }], // 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/> .
Changes since DSTU2
| CarePlan | |
| CarePlan.definition |
|
| CarePlan.basedOn |
|
| CarePlan.replaces |
|
| CarePlan.partOf |
|
| CarePlan.intent |
|
| CarePlan.title |
|
| CarePlan.subject |
|
| CarePlan.author |
|
| CarePlan.careTeam |
|
| CarePlan.supportingInfo |
|
| CarePlan.activity.outcomeCodeableConcept |
|
| CarePlan.activity.outcomeReference |
|
| CarePlan.activity.reference |
|
| CarePlan.activity.detail.definition |
|
| CarePlan.activity.detail.status |
|
| CarePlan.activity.detail.statusReason |
|
| CarePlan.activity.detail.prohibited |
|
| CarePlan.activity.detail.performer |
|
| CarePlan.note |
|
| CarePlan.modified |
|
| CarePlan.relatedPlan |
|
| CarePlan.participant |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R2 <--> R3 Conversion Maps (status = 10 tests that all execute ok. 8 fail round-trip testing and 10 r3 resources are invalid (33 errors).).
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.intent | Codes indicating the degree of authority/intentionality associated with a care plan | Required | CarePlanIntent |
| 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.activity.outcomeCodeableConcept | Identifies the results of the activity | Example | Care Plan Activity Outcome |
| 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.product[x] | A product supplied or administered as part of a care plan activity. | Example | SNOMED CT Medication Codes |
on CarePlan.activity: detail.empty() or reference.empty())The Provenance resource can be used for detailed review information, such as when the care plan was last reviewed and by whom.
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 | Expression | In Common |
| activity-code | token | Detail type of activity | CarePlan.activity.detail.code | |
| activity-date | date | Specified date occurs within period specified by CarePlan.activity.timingSchedule | CarePlan.activity.detail.scheduled | |
| activity-reference | reference | Activity details defined in specific resource | CarePlan.activity.reference (Appointment, ReferralRequest, MedicationRequest, Task, NutritionOrder, RequestGroup, VisionPrescription, ProcedureRequest, DeviceRequest, CommunicationRequest) | |
| based-on | reference | Fulfills care plan | CarePlan.basedOn (CarePlan) | |
| care-team | 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) | |
| context | reference | Created in context of | CarePlan.context (EpisodeOfCare, Encounter) | |
| date | date | Time period plan covers | CarePlan.period | 18 Resources |
| definition | reference | Protocol or definition | CarePlan.definition (Questionnaire, PlanDefinition) | |
| encounter | reference | Created in context of | CarePlan.context (Encounter) | |
| goal | reference | Desired outcome of plan | CarePlan.goal (Goal) | |
| identifier | token | External Ids for this plan | CarePlan.identifier | 26 Resources |
| intent | token | proposal | plan | order | option | CarePlan.intent | |
| part-of | reference | Part of referenced CarePlan | CarePlan.partOf (CarePlan) | |
| patient | reference | Who care plan is for | CarePlan.subject (Patient) | 31 Resources |
| 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, CareTeam, Patient, RelatedPerson) | |
| replaces | reference | CarePlan replaced by this CarePlan | CarePlan.replaces (CarePlan) | |
| status | token | draft | active | suspended | completed | entered-in-error | cancelled | unknown | CarePlan.status | |
| subject | reference | Who care plan is for | CarePlan.subject (Group, Patient) |
®© HL7.org 2011+. FHIR Release 3 (STU; v3.0.2-11200) generated on Thurs, Oct 24, 2019 11:53+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU2 |
|
Propose a change
