The DocumentReference resource represents a clinical note in a patient record
ContextIn Halaxy, DocumentReference is referred to as a clinical note. DocumentReference only includes the "text input" type of clinical note. This does not include other types of clinical notes such as clinical tools and clinical orders (prescription, imaging, pathology).
For more information, see article: Guide to clinical notes
Endpoints
| Endpoint | Operation | Description |
|---|---|---|
POST/main/DocumentReference | Create DocumentReference | Create a clinical note in a patient profile |
Schema
| Property | Description |
|---|---|
| status | stringDefaults to current |
| docStatus | enum requiredThe status of the clinical note preliminary - Draftfinal - Published |
| subject | Reference(Patient) requiredThe patient profile to create this clinical note for "type": "Patient""reference": "/main/Patient/123456"See: Patient |
| date | date-time read-onlyThe date and time when the clinical note was created. Halaxy sets this on creation. A value sent in the request body is accepted but not stored. |
| author | array of Reference(PractitionerRole) requiredAt least one The practitioner and practice location linked as the clinical note's owner "type": "PractitionerRole""reference": "/main/PractitionerRole/PR-123456"See: PractitionerRole |
| description | string requiredThe title of the clinical note |
| content | array of objectsAt least one element The content of the clinical note. Each element wraps a single attachment object.The first element is the note body. Every element after it is treated as a file attachment. There is no separate property for file attachments — they go here. |
| content[].attachment.contentType | enum requiredThe format of this element Note body: text/html onlyFile attachments: application/mswordapplication/vnd.ms-excelapplication/vnd.openxmlformats-officedocument.wordprocessingml.documentapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheetapplication/pdfimage/jpegimage/png |
| content[].attachment.data | string requiredNote body: the HTML content of the note File attachments: the file encoded to base64 Maximum file size: 20MB |
| content[].attachment.title | stringThe file name |