Clinical Intelligence StandardsVersion 0.2

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

Resource content

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

NameCard.TypeFlagsDescription
protocol_key1..1codeIDefinition key of kind protocol.
cohort_membership_id0..1id—Membership that offered this protocol.
reason0..1string—Why it was assigned.

State machine

assigned → cancelled, compromised.

Frozen: cancelled and compromised.

Invariants

Operations

MethodPathMeaning
GET/v1/protocol-assignmentsList protocol assignment. Filter by patient_id, status, and where the model has them, encounter_id or definition_key.
POST/v1/protocol-assignmentsCreate 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}/transitionMove 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" }