Clinical Intelligence StandardsVersion 0.2

Functional standard / Interactions / PatientInstance

ClinicalRecord

The set of note pages for one encounter. The record holds no clinical values itself.

Kind
clinical_record
Collection
/v1/clinical-records
Initial state
pending
Classification
Clinical in some uses

Scope and usage

Always belongs to an encounter. If none is given, the harness creates one.

Boundaries and relationships

Resource content

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

NameCard.TypeFlagsDescription
encounter_id0..1id—Filled by the harness when omitted.
title1..1string—Defaults to Clinical record.

State machine

pending → saved, finalized. saved → pending, finalized.

Frozen: finalized.

Invariants

Operations

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

Example

{ "patient_id": "pat_…", "encounter_id": "enc_…", "title": "OPD note" }