Clinical Intelligence StandardsVersion 0.2

Functional standard / What is being done / PatientInstance

CareAction

Something the patient does or receives: an order, referral, education, journal, medication, self-care, lifestyle, or appointment.

Kind
care_action
Collection
/v1/care-actions
Initial state
planned
Classification
Clinical in some uses

Scope and usage

The patient-facing line of a care plan. Orders, referrals, and medications are clinical. An appointment action records that a visit is part of care. The calendar itself is a connector.

Boundaries and relationships

Resource content

Elements this resource adds. It also carries the Instance, including patient_id.

NameCard.TypeFlagsDescription
careplan_id0..1id—Plan this line belongs to.
action_type1..1codeBorder, referral, education, journal, medication, self_care, lifestyle, or appointment.
title1..1string—What the patient sees.
code0..1code—Service or order code. A billing connector may map this code to its item id.
details0..1object—Extra fields. Not a second clinical model.
setting_id0..1id—ClinicalSetting that fulfils an order or referral.
order_kind0..1codeBlab, imaging, procedure, vaccination, or other.
order_status0..1codeBproposed, signed, sent, resulted, or closed. Only a device actor may mark an order sent.
journal_plugin_key0..1code—Journal definition, when action_type is journal.
schedule0..1Schedule—every_days, anchor, until, grace_days.
completions0..*dateTime—Times it was done. The harness uses these for due, overdue, and missed.

State machine

planned → active, cancelled. active → completed, cancelled.

Frozen: completed and cancelled.

Terminology bindings

ElementStrengthValues
action_typerequiredorder | referral | education | journal | medication | self_care | lifestyle | appointment

Invariants

Operations

MethodPathMeaning
GET/v1/care-actionsList care action. Filter by patient_id, status, and where the model has them, encounter_id or definition_key.
POST/v1/care-actionsCreate a care action. Body is the resource minus harness-owned elements.
GET/v1/care-actions/{id}Read one care action.
PATCH/v1/care-actions/{id}Update elements that are not immutable, frozen, or harness-owned.
POST/v1/care-actions/{id}/transitionMove status. Body is { to, reason }. A gated move returns 202 and an Approval.
DELETE/v1/care-actions/{id}?reason=Soft-delete. Reason is required. Refused when the resource is not deletable or is frozen.
GET/v1/care-actions/{id}/scheduleDue, overdue, or missed from the cadence engine.

Example

{ "patient_id": "pat_…", "action_type": "appointment", "title": "Review in 2 weeks" }