CarePlan
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.
- Backends
- PostgreSQLElasticsearch
- Interactions
- CreateReadUpdatePatchDelete
- Search
- 19 of 20 parameters tested
Structure
| Element | Card. | Type | Description |
|---|---|---|---|
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 |
statusRequired?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknownBinding (required): request-status |
intentRequired?!Σ | 1..1 | code | proposal | plan | order | optionBinding (required): care-plan-intent |
categoryΣ | 0..* | CodeableConcept | Type of planBinding (example): care-plan-category |
titleΣ | 0..1 | string | Human-friendly name for the care plan |
descriptionΣ | 0..1 | string | Summary of nature of plan |
subjectRequiredΣ | 1..1 | Reference(Patient | 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(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who provided the content of the care 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 | 0..* | BackboneElement | Action to occur as part of plan |
outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activityBinding (example): care-plan-activity-outcome |
outcomeReference | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. |
progress | 0..* | Annotation | Comments about the activity status/progress |
reference | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource |
detail | 0..1 | BackboneElement | In-line definition of activity |
kind | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescriptionBinding (required): care-plan-activity-kind |
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 activityBinding (example): procedure-code |
reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibitedBinding (example): clinical-findings |
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed |
goal | 0..* | Reference(Goal) | Goals this activity relates to |
statusRequired?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-errorBinding (required): care-plan-activity-status |
statusReason | 0..1 | CodeableConcept | Reason for current status |
doNotPerform?! | 0..1 | boolean | If true, activity is prohibiting action |
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 | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? |
product[x] | 0..1 | CodeableConcept | Reference(Medication | Substance) | What is to be administered/suppliedBinding (example): medication-codes |
dailyAmount | 0..1 | Quantity | How to consume/day? |
quantity | 0..1 | Quantity | How much to administer/supply/consume |
description | 0..1 | string | Extra info describing activity to perform |
note | 0..* | Annotation | Comments about the plan |
Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey
Search parameters
Query with GET [base]/CarePlan?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.
| Parameter | Type | Description | PG | ES |
|---|---|---|---|---|
activity-code | token | Detail type of activity CarePlan.activity.detail.code | ||
activity-date | date | Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x] CarePlan.activity.detail.scheduled | ||
activity-reference | reference | Activity details defined in specific resource CarePlan.activity.reference | ||
based-on | reference | Fulfills CarePlan CarePlan.basedOn | ||
care-team | reference | Who's involved in plan? CarePlan.careTeam | ||
category | token | Type of plan CarePlan.category | ||
condition | reference | Health issues this plan addresses CarePlan.addresses | ||
date | date | Time period plan covers CarePlan.period | ||
encounter | reference | Encounter created as part of CarePlan.encounter | ||
goal | reference | Desired outcome of plan CarePlan.goal | ||
identifier | token | External Ids for this plan CarePlan.identifier | ||
instantiates-canonical | reference | Instantiates FHIR protocol or definition CarePlan.instantiatesCanonical | ||
instantiates-uri | uri | Instantiates external protocol or definition CarePlan.instantiatesUri | ||
intent | token | proposal | plan | order | option CarePlan.intent | ||
part-of | reference | Part of referenced CarePlan CarePlan.partOf | ||
patient | reference | Who the care plan is for CarePlan.subject.where(resolve() is 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 | ||
replaces | reference | CarePlan replaced by this CarePlan CarePlan.replaces | ||
status | token | draft | active | on-hold | revoked | completed | entered-in-error | unknown CarePlan.status | ||
subject | reference | Who the care plan is for CarePlan.subject |
PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet. The author of the resource Logical id of this artifact When the resource version last changed Profiles this resource claims to conform to Security Labels applied to this resource Identifies where the resource comes from Tags applied to this resource Derived from the R4B DefinitionCommon parameters on every resource (8)
_haste-health-authorreference _idtoken _lastUpdateddate _profileuri _securitytoken _sourceuri _tagtoken _typetoken