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.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/CarePlan/[id] |
| Vread | GET | /fhir/R4/CarePlan/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/CarePlan/[id] |
| Patch | PATCH | /fhir/R4/CarePlan/[id] |
| Delete | DELETE | /fhir/R4/CarePlan/[id] |
| Create | POST | /fhir/R4/CarePlan |
| Search | GET | /fhir/R4/CarePlan |
| History | GET | /fhir/R4/CarePlan/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | External Ids for this plan |
instantiatesCanonical | canonical | 0..* | Instantiates FHIR protocol or definition |
instantiatesUri | uri | 0..* | Instantiates external protocol or definition |
basedOn | Reference | 0..* | Fulfills CarePlan |
replaces | Reference | 0..* | CarePlan replaced by this CarePlan |
partOf | Reference | 0..* | Part of referenced CarePlan |
status | code | 1..1 | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
intent | code | 1..1 | proposal | plan | order | option |
category | CodeableConcept | 0..* | Type of plan |
title | string | 0..1 | Human-friendly name for the care plan |
description | string | 0..1 | Summary of nature of plan |
subject | Reference | 1..1 | Who the care plan is for |
encounter | Reference | 0..1 | Encounter created as part of |
period | Period | 0..1 | Time period plan covers |
created | dateTime | 0..1 | Date record was first recorded |
author | Reference | 0..1 | Who is the designated responsible party |
contributor | Reference | 0..* | Who provided the content of the care plan |
careTeam | Reference | 0..* | Who's involved in plan? |
addresses | Reference | 0..* | Health issues this plan addresses |
supportingInfo | Reference | 0..* | Information considered as part of plan |
goal | Reference | 0..* | Desired outcome of plan |
activity | BackboneElement | 0..* | Action to occur as part of plan |
note | Annotation | 0..* | Comments about the plan |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
activity-code | token | Detail type of activity |
activity-date | date | Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x] |
activity-reference | reference | Activity details defined in specific resource |
based-on | reference | Fulfills CarePlan |
care-team | reference | Who's involved in plan? |
category | token | Type of plan |
condition | reference | Health issues this plan addresses |
date | date | Multiple Resources: AllergyIntolerance: Date first version of the resource instance was recorded ; CarePlan: Time period plan covers ; CareTeam: Time period team covers ; ClinicalImpression: When the assessment was documented ; Composition: Composition editing time ; Consent: When this Consent was created or indexed ; DiagnosticReport: The clinically relevant time of the report ; Encounter: A date within the period the Encounter lasted ; EpisodeOfCare: The provided date search value falls within the episode of care's period ; FamilyMemberHistory: When history was recorded or last updated ; Flag: Time period when flag is active ; Immunization: Vaccination (non)-Administration Date ; List: When the list was prepared ; Observation: Obtained date/time. If the obtained element is a period, a date that falls in the period ; Procedure: When the procedure was performed ; RiskAssessment: When was assessment made? ; SupplyRequest: When the request was made |
encounter | reference | Encounter created as part of |
goal | reference | Desired outcome of plan |
identifier | token | Multiple Resources: AllergyIntolerance: External ids for this item ; CarePlan: External Ids for this plan ; CareTeam: External Ids for this team ; Composition: Version-independent identifier for the Composition ; Condition: A unique identifier of the condition record ; Consent: Identifier for this record (external references) ; DetectedIssue: Unique id for the detected issue ; DeviceRequest: Business identifier for request/order ; DiagnosticReport: An identifier for the report ; DocumentManifest: Unique Identifier for the set of documents ; DocumentReference: Master Version Specific Identifier ; Encounter: Identifier(s) by which this encounter is known ; EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare ; FamilyMemberHistory: A search by a record identifier ; Goal: External Ids for this goal ; ImagingStudy: Identifiers for the Study, such as DICOM Study Instance UID and Accession number ; Immunization: Business identifier ; List: Business identifier ; MedicationAdministration: Return administrations with this external identifier ; MedicationDispense: Returns dispenses with this external identifier ; MedicationRequest: Return prescriptions with this external identifier ; MedicationStatement: Return statements with this external identifier ; NutritionOrder: Return nutrition orders with this external identifier ; Observation: The unique id for a particular observation ; Procedure: A unique identifier for a procedure ; RiskAssessment: Unique identifier for the assessment ; ServiceRequest: Identifiers assigned to this order ; SupplyDelivery: External identifier ; SupplyRequest: Business Identifier for SupplyRequest ; VisionPrescription: Return prescriptions with this external identifier |
instantiates-canonical | reference | Instantiates FHIR protocol or definition |
instantiates-uri | uri | Instantiates external protocol or definition |
intent | token | proposal | plan | order | option |
part-of | reference | Part of referenced CarePlan |
patient | reference | Multiple Resources: AllergyIntolerance: Who the sensitivity is for ; CarePlan: Who the care plan is for ; CareTeam: Who care team is for ; ClinicalImpression: Patient or group assessed ; Composition: Who and/or what the composition is about ; Condition: Who has the condition? ; Consent: Who the consent applies to ; DetectedIssue: Associated patient ; DeviceRequest: Individual the service is ordered for ; DeviceUseStatement: Search by subject - a patient ; DiagnosticReport: The subject of the report if a patient ; DocumentManifest: The subject of the set of documents ; DocumentReference: Who/what is the subject of the document ; Encounter: The patient or group present at the encounter ; EpisodeOfCare: The patient who is the focus of this episode of care ; FamilyMemberHistory: The identity of a subject to list family member history items for ; Flag: The identity of a subject to list flags for ; Goal: Who this goal is intended for ; ImagingStudy: Who the study is about ; Immunization: The patient for the vaccination record ; List: If all resources have the same subject ; MedicationAdministration: The identity of a patient to list administrations for ; MedicationDispense: The identity of a patient to list dispenses for ; MedicationRequest: Returns prescriptions for a specific patient ; MedicationStatement: Returns statements for a specific patient. ; NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement ; Observation: The subject that the observation is about (if patient) ; Procedure: Search by subject - a patient ; RiskAssessment: Who/what does assessment apply to? ; ServiceRequest: Search by subject - a patient ; SupplyDelivery: Patient for whom the item is supplied ; VisionPrescription: The identity of a patient to list dispenses for |
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.) |
replaces | reference | CarePlan replaced by this CarePlan |
status | token | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
subject | reference | Who the care plan is for |
Reference
Official FHIR R4 spec: CarePlan.
Maturity: Trial Use 2 (FMM 2).