Clinical Intelligence StandardsVersion 0.2

Functional standard / What is being done / Instance

Routine

A repeating duty. When it is due, the harness creates a Task.

Kind
routine
Collection
/v1/routines
Initial state
active
Classification
Operational

Scope and usage

Site-wide or for one patient. Optional duty_state limits it to on-shift or on-call.

Boundaries and relationships

Resource content

Elements this resource adds. It also carries the Instance.

NameCard.TypeFlagsDescription
patient_id0..1id—Set when the routine is for one patient.
title1..1string—Name of the duty.
assignee_role0..1code—Role.
assignee_id0..1id—Person.
duty_state0..1code—For example on_shift or on_call. Empty means always.
schedule1..1Schedule—every_days is required.
task_template0..1object—Fields copied onto each generated task.

State machine

active → paused, ended. paused → active, ended.

Frozen: ended.

Invariants

Operations

MethodPathMeaning
GET/v1/routinesList routine. Filter by patient_id, status, and where the model has them, encounter_id or definition_key.
POST/v1/routinesCreate a routine. Body is the resource minus harness-owned elements.
GET/v1/routines/{id}Read one routine.
PATCH/v1/routines/{id}Update elements that are not immutable, frozen, or harness-owned.
POST/v1/routines/{id}/transitionMove status. Body is { to, reason }. A gated move returns 202 and an Approval.
DELETE/v1/routines/{id}?reason=Soft-delete. Reason is required. Refused when the resource is not deletable or is frozen.
POST/v1/routines/runCreate tasks for occurrences that are due.

Notes

Example

{ "title": "Ward vitals", "assignee_role": "nurse", "schedule": { "every_days": 1 } }