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
- Values live on NotePage blocks and then on Observation.
- Finalizing the record requires every page to be finalized.
Resource content
Elements this resource adds. It also carries the Instance, including patient_id.
| Name | Card. | Type | Flags | Description |
|---|---|---|---|---|
| encounter_id | 0..1 | id | — | Filled by the harness when omitted. |
| title | 1..1 | string | — | Defaults to Clinical record. |
State machine
pending/ initial — Started.saved— In progress.finalized— Closed. Frozen. Clinical.
pending → saved, finalized. saved → pending, finalized.
Frozen: finalized.
Invariants
ccs-rec-1— The record finalizes only when every note page in it is finalized.
Operations
| Method | Path | Meaning |
|---|---|---|
| GET | /v1/clinical-records | List clinical record. Filter by patient_id, status, and where the model has them, encounter_id or definition_key. |
| POST | /v1/clinical-records | Create 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}/transition | Move 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" }