Create an observation
POST/healthcare/{connection_id}/observation
Parameters
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
Payload
idstring
Unique identifier for the observation
created_atdate-time
When the observation record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
When the observation record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
patient_idstring
The patient the observation is about
encounter_idstring
The encounter in which the observation was made
practitioner_idstring
The practitioner who performed the observation
namestring
Human-readable name of what was observed
status enum
Status of the observation result
type enum
Category of the observation
value_numbernumber
Numeric result value
value_unitstring
Unit of the numeric result (e.g. mg/dL)
value_textstring
Text or coded result value
interpretation enum
Interpretation of the result (e.g. high, low)
observed_atdate-time
When the observation was made (effective time) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
issued_atdate-time
When the result was released (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
notesstring
Free-text notes about the observation
Returns
| Response 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 |
Errors
Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).
{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to unified.to API; max requests per minute: N"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not supported by this integration. |
Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.
429 Too Many Requests
A 429 has two possible sources:
- The integration's own rate limit, passed through.
- Unified's workspace limit: a rolling 60 seconds, set by plan, with the message
Too many requests to unified.to API; max requests per minute: N.
const options = {
method: 'POST',
url: 'https://api.unified.to/healthcare/5de520f96e439b002043d8dc/observation',
headers: {
authorization: 'bearer .....'
},
data: undefined,
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know