Clinical Intelligence StandardsVersion 0.2

Functional standard / Interactions / PatientInstance

ClinicalDocument

A printable document that leaves the system: prescription, report, consent form, medical-legal note.

Kind
clinical_document
Collection
/v1/clinical-documents
Initial state
draft
Classification
Clinical in some uses

Scope and usage

Rendered from a template into HTML and an optional blob. Sharing with the patient needs data_sharing consent, and the document must be shareable, unprotected, and ready.

Boundaries and relationships

Resource content

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

NameCard.TypeFlagsDescription
doc_type1..1code—prescription, clinical_report, mlc, consent_form, diet_chart, or a local type.
title1..1string—Title.
source_kind0..1code—clinical_record, note_page, or assessment.
source_id0..1id—That source.
body_html0..1string—Rendered body.
header_html0..1string—Letterhead. Branding comes from the site profile when the template says so.
footer_html0..1string—Footer.
watermark0..1string—Watermark text.
blob_ref0..1uriRWhere the file was stored. Harness-owned.
shareable_with_patient1..1boolean—Whether share is even offered.
protected1..1boolean—Protected documents are not shared through the portal.
signed1..1booleanRHarness-owned.
signed_by0..1idRHarness-owned.
expires_at0..1dateTime—Optional expiry.

State machine

draft → ready. ready → expired.

Frozen: ready and expired.

Invariants

Operations

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

Notes

Example

{ "patient_id": "pat_…", "doc_type": "prescription", "title": "Prescription", "definition_key": "clinical_document_prescription" }