Functional standard / What can be done / PatientInstance
ProtocolAssignment
A protocol assigned to a patient. Assignment instantiates the protocol's templates.
- Kind
- protocol_assignment
- Collection
- /v1/protocol-assignments
- Initial state
- assigned
- Classification
- Clinical
Scope and usage
The care program offered to this person. Templates that are clinical are proposed. Templates that are not clinical are created.
Boundaries and relationships
- The protocol text and PICO live on the Definition.
- Assigning is not prescribing. Regimens inside the protocol still need a clinician.
Resource content
Elements this resource adds. It also carries the Instance, including patient_id.
| Name | Card. | Type | Flags | Description |
|---|---|---|---|---|
| protocol_key | 1..1 | code | I | Definition key of kind protocol. |
| cohort_membership_id | 0..1 | id | — | Membership that offered this protocol. |
| reason | 0..1 | string | — | Why it was assigned. |
State machine
assigned/ initial — In force. Templates have been instantiated or proposed.cancelled— Withdrawn before completion.compromised— Could not be followed.
assigned → cancelled, compromised.
Frozen: cancelled and compromised.
Invariants
ccs-pro-1— Patient criteria on the protocol must match.ccs-pro-2— No second active assignment of the same protocol.
Operations
| Method | Path | Meaning |
|---|---|---|
| GET | /v1/protocol-assignments | List protocol assignment. Filter by patient_id, status, and where the model has them, encounter_id or definition_key. |
| POST | /v1/protocol-assignments | Create a protocol assignment. Body is the resource minus harness-owned elements. |
| GET | /v1/protocol-assignments/{id} | Read one protocol assignment. |
| PATCH | /v1/protocol-assignments/{id} | Update elements that are not immutable, frozen, or harness-owned. |
| POST | /v1/protocol-assignments/{id}/transition | Move status. Body is { to, reason }. A gated move returns 202 and an Approval. |
Example
{ "patient_id": "pat_…", "protocol_key": "proto_mdd_acute_phase", "reason": "Accepted the acute-phase program" }