Functional standard / What is being done / PatientInstance
Careplan
What is planned: care actions for the patient and tasks for the team.
- Kind
- careplan
- Collection
- /v1/careplans
- Initial state
- draft
- Classification
- Clinical in some uses
Scope and usage
A plan starts as a draft. Activating it is a clinical decision and activates its planned actions.
Boundaries and relationships
- The plan is not the prescription detail. Drugs live on Regimen and Medication.
- Goals are Outcome ids, not free text targets.
Resource content
Elements this resource adds. It also carries the Instance, including patient_id.
| Name | Card. | Type | Flags | Description |
|---|---|---|---|---|
| title | 1..1 | string | — | Plan title. |
| protocol_assignment_id | 0..1 | id | — | Protocol that instantiated it. |
| encounter_id | 0..1 | id | — | Encounter it was opened in. |
| goals | 0..* | id | — | Outcome ids this plan aims at. |
State machine
draft/ initial — Being composed.active— In force. Clinical transition.completed— Finished. Frozen.cancelled— Withdrawn. Frozen.
draft → active, cancelled. active → completed, cancelled.
Frozen: completed and cancelled.
Invariants
ccs-plan-1— Activating a care plan activates its planned care actions, under the deciding person's name.
Operations
| Method | Path | Meaning |
|---|---|---|
| GET | /v1/careplans | List care plan. Filter by patient_id, status, and where the model has them, encounter_id or definition_key. |
| POST | /v1/careplans | Create a care plan. Body is the resource minus harness-owned elements. |
| GET | /v1/careplans/{id} | Read one care plan. |
| PATCH | /v1/careplans/{id} | Update elements that are not immutable, frozen, or harness-owned. |
| POST | /v1/careplans/{id}/transition | Move status. Body is { to, reason }. A gated move returns 202 and an Approval. |
| DELETE | /v1/careplans/{id}?reason= | Soft-delete. Reason is required. Refused when the resource is not deletable or is frozen. |
Notes
- Definition kind careplan.
Example
{ "patient_id": "pat_…", "title": "Acute phase plan", "definition_key": "careplan_mdd" }