Document data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for the document |
created_at | string (date-time) | No | When the document record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the document record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
patient_id | string | No | The patient the document is about |
encounter_id | string | No | The encounter the document relates to |
practitioner_id | string | No | The practitioner who authored the document |
name | string | No | Title or description of the document |
type | enum | No | Unified, normalized kind of clinical document (OTHER when unmappable) Values: PROGRESS_NOTE, CONSULTATION_NOTE, HISTORY_AND_PHYSICAL, DISCHARGE_SUMMARY, PROCEDURE_NOTE, REFERRAL_NOTE, SUMMARY, LABORATORY_REPORT, IMAGING_REPORT, CONSENT, OTHER |
codes | HealthcareCode[] | No | Codings for the kind of document (e.g. LOINC document type) |
codes[].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) |
codes[].code | string | No | The code within the system |
codes[].display | string | No | Human-readable display text for the code |
status | enum | No | Status of the document Values: CURRENT, SUPERSEDED, ENTERED_IN_ERROR, OTHER |
filename | string | No | File name of the document |
mime_type | string | No | MIME type of the document content (e.g. text/plain, application/pdf) |
document_url | string | No | Download link for the document content, expires after 1 hour |
document_data | string | No | Base64-encoded document content for create |
authored_at | string (date-time) | No | When the document was written (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metadata | HealthcareMetadata[] | No | Custom field values |
metadata[].id | string | No | Identifier of the custom field |
metadata[].value | object | No | The custom field value |
metadata[].namespace | string | No | The scope or origin of the custom field |
metadata[].format | enum | No | The data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT |
metadata[].extra_data | object | No | Additional data about the custom field |
metadata[].slug | string | No | The custom field key |
Are we missing anything? Let us know