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 |
See: Patient |
| date | date-timeThe date and time when the clinical note was created |
| author |
See: PractitionerRole |
| description | string requiredThe title of the clinical note |
| content | The content of the clinical note contentType data |
| attachments | array of objects - POST onlyFile attachments to the clinical note contentType enum requiredThe format of the file attachment Supported formats: application/mswordapplication/vnd.ms-excelapplication/vnd.openxmlformats-officedocument.wordprocessingml.documentapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheetapplication/pdfimage/jpegimage/pngdata required File must be encoded to base64 Maximum file size: 20MB hash required The hash of the file (sha-1 or base64) title string requiredThe file name |