# CarePlan

Canonical page: https://docs.ovok.com/api/fhir/r4/care-plan

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 [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | External Ids for this plan |
| <span id="element-instantiates-canonical"></span>`instantiatesCanonical` | [canonical](/fhir-elements/primitive/canonical) | `0..*` | Instantiates FHIR protocol or definition |
| <span id="element-instantiates-uri"></span>`instantiatesUri` | [uri](/fhir-elements/primitive/uri) | `0..*` | Instantiates external protocol or definition |
| <span id="element-based-on"></span>`basedOn` | [Reference](/fhir-elements/complex/reference) | `0..*` | Fulfills CarePlan |
| <span id="element-replaces"></span>`replaces` | [Reference](/fhir-elements/complex/reference) | `0..*` | CarePlan replaced by this CarePlan |
| <span id="element-part-of"></span>`partOf` | [Reference](/fhir-elements/complex/reference) | `0..*` | Part of referenced CarePlan |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown |
| <span id="element-intent"></span>`intent` | [code](/fhir-elements/primitive/code) | `1..1` | proposal \| plan \| order \| option |
| <span id="element-category"></span>`category` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Type of plan |
| <span id="element-title"></span>`title` | [string](/fhir-elements/primitive/string) | `0..1` | Human-friendly name for the care plan |
| <span id="element-description"></span>`description` | [string](/fhir-elements/primitive/string) | `0..1` | Summary of nature of plan |
| <span id="element-subject"></span>`subject` | [Reference](/fhir-elements/complex/reference) | `1..1` | Who the care plan is for |
| <span id="element-encounter"></span>`encounter` | [Reference](/fhir-elements/complex/reference) | `0..1` | Encounter created as part of |
| <span id="element-period"></span>`period` | [Period](/fhir-elements/complex/period) | `0..1` | Time period plan covers |
| <span id="element-created"></span>`created` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | Date record was first recorded |
| <span id="element-author"></span>`author` | [Reference](/fhir-elements/complex/reference) | `0..1` | Who is the designated responsible party |
| <span id="element-contributor"></span>`contributor` | [Reference](/fhir-elements/complex/reference) | `0..*` | Who provided the content of the care plan |
| <span id="element-care-team"></span>`careTeam` | [Reference](/fhir-elements/complex/reference) | `0..*` | Who's involved in plan? |
| <span id="element-addresses"></span>`addresses` | [Reference](/fhir-elements/complex/reference) | `0..*` | Health issues this plan addresses |
| <span id="element-supporting-info"></span>`supportingInfo` | [Reference](/fhir-elements/complex/reference) | `0..*` | Information considered as part of plan |
| <span id="element-goal"></span>`goal` | [Reference](/fhir-elements/complex/reference) | `0..*` | Desired outcome of plan |
| <span id="element-activity"></span>`activity` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Action to occur as part of plan |
| <span id="element-note"></span>`note` | [Annotation](/fhir-elements/complex/annotation) | `0..*` | Comments about the plan |

## Resource-specific search parameters [#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 [#reference]

Official FHIR R4 spec: [CarePlan](https://hl7.org/fhir/R4/careplan.html).  
Maturity: Trial Use 2 (FMM 2).
