Report 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 report |
created_at | string (date-time) | No | When the report record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the report record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
patient_id | string | No | The patient the report is about |
encounter_id | string | No | The encounter the report relates to |
practitioner_ids | string[] | No | The practitioners responsible for the report |
observation_ids | string[] | No | The individual results included in the report |
name | string | No | Human-readable name of the report (e.g. Complete blood count) |
codes | HealthcareCode[] | No | Codings for the report (e.g. LOINC panel) |
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 report Values: REGISTERED, PARTIAL, PRELIMINARY, FINAL, AMENDED, CORRECTED, APPENDED, CANCELLED, ENTERED_IN_ERROR, UNKNOWN, OTHER |
type | enum | No | Category of the report Values: LABORATORY, IMAGING, PATHOLOGY, CARDIOLOGY, OTHER |
conclusion | string | No | Clinical conclusion or interpretation of the report |
observed_at | string (date-time) | No | When the specimen was taken or the study was performed (effective time) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
issued_at | string (date-time) | No | When the report was released (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