ℹ️In 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
| Endpoint | Operation | Description |
|---|
POST/main/DocumentReference | Create DocumentReference | Create a clinical note in a patient profile |
Property | Description |
|---|
status | string
Defaults to current
|
docStatus | enum required
The status of the clinical note
preliminary - Draft
final - Published
|
subject | Reference(Patient) required
The patient profile to create this clinical note for
"type": "Patient"
"reference": "/main/Patient/123456"
See: Patient |
date | date-time
The date and time when the clinical note was created
|
author | Reference(PractitionerRole) required
The practitioner and practice location linked as the clinical note's owner
"type": "PractitionerRole"
"reference": "/main/PractitionerRole/PR-123456"
See: PractitionerRole |
description | string required
The title of the clinical note
|
content | The content of the clinical note contentType string
The format of the content - only text/html supported data string
The text input for the note content
e.g.
<h1>Summary</h1>
<p>The patient has been suffering discomfort.</p> |
attachments | array of objects - POST only
File attachments to the clinical note
contentType enum required
The format of the file attachment
Supported formats:
application/msword
application/vnd.ms-excel
application/vnd.openxmlformats-officedocument.wordprocessingml.document
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/pdf
image/jpeg
image/png data required
File must be encoded to base64
Maximum file size: 20MB title string required
The file name |
