Observation 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 observation |
created_at | string (date-time) | No | When the observation record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the observation record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
patient_id | string | No | The patient the observation is about |
encounter_id | string | No | The encounter in which the observation was made |
practitioner_id | string | No | The practitioner who performed the observation |
name | string | No | Human-readable name of what was observed |
codes | HealthcareCode[] | No | Codings for what was observed (e.g. LOINC) |
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 observation result Values: REGISTERED, PRELIMINARY, FINAL, AMENDED, CORRECTED, CANCELLED, ENTERED_IN_ERROR, UNKNOWN, OTHER |
type | enum | No | Category of the observation Values: LABORATORY, VITAL_SIGNS, SOCIAL_HISTORY, IMAGING, SURVEY, EXAM, PROCEDURE, THERAPY, ACTIVITY, OTHER |
value_number | number | No | Numeric result value |
value_unit | string | No | Unit of the numeric result (e.g. mg/dL) |
value_text | string | No | Text or coded result value |
interpretation | enum | No | Interpretation of the result (e.g. high, low) Values: NORMAL, ABNORMAL, LOW, HIGH, CRITICAL_LOW, CRITICAL_HIGH, OTHER |
reference_range | object | No | Normal range for the result |
reference_range.low_value | number | No | Lower bound of the range |
reference_range.high_value | number | No | Upper bound of the range |
reference_range.unit | string | No | Unit of the range bounds |
reference_range.text | string | No | Text description of the range |
components | HealthcareObservationComponent[] | No | Component results (e.g. systolic and diastolic blood pressure) |
components[].name | string | No | Human-readable name of the component |
components[].codes | HealthcareCode[] | No | Codings for the component (e.g. LOINC) |
components[].codes[].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) |
components[].codes[].code | string | No | The code within the system |
components[].codes[].display | string | No | Human-readable display text for the code |
components[].value_number | number | No | Numeric component value |
components[].value_unit | string | No | Unit of the numeric component value |
components[].value_text | string | No | Text or coded component value |
components[].interpretation | enum | No | Interpretation of the component value Values: NORMAL, ABNORMAL, LOW, HIGH, CRITICAL_LOW, CRITICAL_HIGH, OTHER |
observed_at | string (date-time) | No | When the observation was made (effective time) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
issued_at | string (date-time) | No | When the result was released (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
notes | string | No | Free-text notes about the observation |
metadata | HealthcareMetadata[] | No | |
metadata[].id | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT |
metadata[].extra_data | object | No | |
metadata[].slug | string | No |
Are we missing anything? Let us know