Clinical Intelligence StandardsVersion 0.2

Functional standard / Interactions / PatientInstance

NotePage

One page of a record: a case sheet of blocks, or a chart of observations.

Kind
note_page
Collection
/v1/note-pages
Initial state
drafted
Classification
Clinical in some uses

Scope and usage

Draft, then optionally approve, then finalize. Finalizing writes observations for blocks that carry an observation code. After that, only addenda.

Boundaries and relationships

Resource content

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

NameCard.TypeFlagsDescription
record_id1..1idIClinical record. Immutable.
page_type1..1codeBcase_sheet or chart.
title1..1string—Page title.
blocks0..1object—Block key to captured value.
chart0..1object—Chart query and component, when page_type is chart.
page_clinical_data0..*object—Canvas sections. Values are also stored in blocks.
template_metadata0..1object—Template name and key for the canvas.
addenda0..*AddendumRtext, by, at. Harness-owned. Added only after finalize.
ai_drafted1..1booleanRTrue when an agent created the draft. Harness-owned.

State machine

drafted → unapproved, approved, finalized. unapproved → drafted, approved. approved → finalized.

Frozen: approved and finalized.

Invariants

Operations

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

Notes

Example

{ "patient_id": "pat_…", "record_id": "rec_…", "definition_key": "note_page_general_case_sheet", "title": "Case sheet" }