---
title: "Entity: Care Plan"
canonical: "https://wiki.patientsknowbest.com/space/api/3743252481/Entity%3A%20Care%20Plan"
format: markdown
---
> Macro (toc)

# Class Diagram

<u>[Care Plan](https://miro.com/app/board/uXjVMNT4240=/?share_link_id=172889430202)</u>

# Display

Care Plans appear in the Treatment > Plans page of the patient's record.

Please see[ ](https://www.google.com/url?q=https%3A%2F%2Fmanual.patientsknowbest.com%2Fpatient%2Fplans&sa=D&sntz=1&usg=AOvVaw1yMfcjICpeQZhOgk5ACP_f)<u>[the manual](https://www.google.com/url?q=https%3A%2F%2Fmanual.patientsknowbest.com%2Fpatient%2Fplans&sa=D&sntz=1&usg=AOvVaw1yMfcjICpeQZhOgk5ACP_f)</u> for more information.

# Mappings

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| ** ** | **HL7 API** | **FHIR API**<br>(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
|  |  | **Facade (STU3)** | **Aggregated (R4)** |  |  |
| **Summary of interactions** |
| Create | [MDM T02/care plan](https://dev.patientsknowbest.com/home/hl7-api/messages/mdm-t02/care-plan) |  |  | [Plans](https://manual.patientsknowbest.com/patient/plans) | [/v1/treatmentPlans](https://sandbox.patientsknowbest.com/api/index.html#!/Treatments/createTreatmentPlan) |
| Read |  |  |  | [Plans](https://manual.patientsknowbest.com/patient/plans) | [/v2-beta/careplans/[patientId]](https://sandbox.patientsknowbest.com/api/index.html#!/Careplans/getCarePlansForPatient)  
[/treatmentPlans/forPatient/[id]](https://sandbox.patientsknowbest.com/api/index.html#!/Treatment_Plans/getTreatmentPlansForPatient)  
[/v1/treatmentPlans/mine](https://sandbox.patientsknowbest.com/api/index.html#!/Treatments/getUsersTreatmentPlans) |
| Update | [MDM T02/care plan](https://dev.patientsknowbest.com/home/hl7-api/messages/mdm-t02/care-plan) |  |  | [Plans](https://manual.patientsknowbest.com/patient/plans) |  |
| Delete |  |  |  |  |  |
| **Entity: Care Plan - Extends: ****[Data Point](https://wiki.patientsknowbest.com/space/api/3750395905/Entity%3A+Data+Point)** |
| **Name** `String`<br>The name of the care plan. | [OBX-3.2 (MDM T02/care plan)](https://dev.patientsknowbest.com/home/hl7-api/messages/mdm-t02/care-plan)  
[OBX-3.5 (MDM T02/care plan)](https://dev.patientsknowbest.com/home/hl7-api/messages/mdm-t02/care-plan) |  |  | Shown. |  |
| **Created Timestamp** `Timestamp`<br>The timestamp when the care plan was first created. | [TXA-4.1 (MDM T02/care plan)](https://dev.patientsknowbest.com/home/hl7-api/messages/mdm-t02/care-plan) |  |  | Shown. |  |
| **Last Edited Timestamp** `Timestamp`<br>The timestamp when the care plan was last edited. | [TXA-4.1 (MDM T02/care plan)](https://dev.patientsknowbest.com/home/hl7-api/messages/mdm-t02/care-plan) |  |  | Shown. |  |
| **Review Date** `Timestamp`<br>When the care plan is due to be reviewed. |  |  |  | Shown. |  |
| **Action Plan** `String or Binary`<br>The main body of the care plan.<br>This can be plaintext, HTML or a PDF file. | [OBX-5.5 (MDM T02/care plan)](https://dev.patientsknowbest.com/home/hl7-api/messages/mdm-t02/care-plan) |  |  | Shown. |  |
| **Green** `String`<br>An explanation of what to expect when the condition is under control.<br>This can be plaintext or HTML. |  |  |  | Shown. |  |
| **Amber** `String`<br>An explanation of what might need attention.<br>This can be plaintext or HTML. |  |  |  | Shown. |  |
| **Red** `String`<br>An explanation of what needs urgent attention.<br>This can be plaintext or HTML. |  |  |  | Shown. |  |
| **Creator** `Ref: [[User.Public ID]]`<br>If applicable, the user who created the care plan. |  |  |  | Shown. |  |
| **Status** `Enum`<br>- INDRAFT
- ACTIVE |  |  |  | Shown. |  |
| **Entity: Care Plan Attachment - Extends: ****[Data Point](https://wiki.patientsknowbest.com/space/api/3750395905/Entity%3A+Data+Point)** |
| **Is Main Content** `Boolean`<br>Whether or not this attachment represents the Action Plan. |  |  |  | The UI automatically shows this appropriately. |  |
| **Entity: Care Plan Template** |
| **ID** `String`<br>An ID for this template. |  |  |  |  |  |
| **Status** `Enum`<br>- ACTIVE
- INDRAFT
- INACTIVE |  |  |  |  |  |
| **Entity: Care Plan Metric** |
| **ID** `String`<br>An ID for this metric. |  |  |  |  |  |
| **Type** `Enum`<br>- LAB_TEST
- MEASUREMENT
- SYMPTOM |  |  |  |  |  |
| **Name** `String`<br>A display name for the metric. |  |  |  |  |  |
| **Data Type ID** `String`<br>An identifier which uniquely identifies the specific data type instance. For example, this would be the ID of the relevant LOINC test entry for a metric type of LAB_TEST. |  |  |  |  |  |


|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| ** ** | **HL7 API** | **FHIR API**<br>(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
|  |  | **Facade (STU3)** | **Aggregated (R4)** |  |  |
| **Summary of interactions** |
| Create |  |  |  | A Professional can [export a care plan](https://manual.patientsknowbest.com/professional/plans), or a Team Coordinator can [export a care plan for a Professional to receive](https://manual.patientsknowbest.com/coordinator/plans#h.p_p6VP5mujhM8k). |  |
| Read |  |  |  | A Professional can [view exported care plans](https://manual.patientsknowbest.com/professional/plans). |  |
| Update |  |  |  |  |  |
| Delete |  |  |  |  |  |
| **Entity: Care Plan Export - Extends: ****[Data Point](https://wiki.patientsknowbest.com/space/api/3750395905/Entity%3A+Data+Point)** |
| **Export Date **`Timestamp`<br>When the export was requested. |  |  |  | The date portion of the timestamp is shown. |  |
| **Name** `String`<br>An automatically generated name for this export. |  |  |  | This is used as the name of the file to be downloaded. |  |
| **Exporter** `Ref: [[User.Public ID]]`<br>The user who requested the export. |  |  |  | The name of the exporter is shown. |  |
| **Content** `Binary`<br>The content of the export. |  |  |  | The content is available for download. |  |