Functional standard / Definition kinds / Constrains ClinicalDocument
clinical_document
A printable template: type, letterhead slots, body placeholders, sharing and protection.
Runtime
Moving to ready signs it. Share still checks consent. Placeholders are filled from the source record.
Elements
| Name | Card. | Type | Description |
|---|---|---|---|
| defaults | 0..1 | object | Fields copied onto a new instance. Values given at creation win. |
| approval_required_for | 0..* | code | Extra states that need an Approval to enter. |
| doc_type | 1..1 | code | prescription, clinical_report, consent_form, or a local type. |
| header_html | 0..1 | string | Letterhead HTML. |
| footer_html | 0..1 | string | Footer HTML. |
| watermark | 0..1 | string | Watermark. |
| body_template | 0..1 | string | HTML with {placeholders}. |
| shareable_with_patient | 1..1 | boolean | Whether share is offered. |
| protected | 1..1 | boolean | Protected documents are not shared. |
| expires_after_days | 0..1 | integer | Sets expires_at from the ready time. |
| consent_scope | 0..1 | code | Consent forms: the scope this form grants. |
| signers | 0..* | code | Consent forms: patient, clinician, or witness. |
| require_otp | 1..1 | boolean | Consent forms: the patient's signing link asks for a one-time code. |
| link_expiry_minutes | 1..1 | integer | Consent forms: signing link lifetime, default 30. |
| language | 1..1 | code | BCP 47 language tag of the form, default en. |
Example
{ "doc_type": "prescription", "shareable_with_patient": true, "body_template": "<p>{drugs}</p>" }