Retrieve a report
GET/healthcare/{connection_id}/report/{id}
Retrieves a single HealthcareReport by its `id`. Obtain `id` values from the corresponding list endpoint. Use `fields` to return only the fields you need.
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
idstring required
ID of the Report
Returns
| Response 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 |
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: 'GET',
url: 'https://api.unified.to/healthcare/5de520f96e439b002043d8dc/report/5de520f96e439b002043d8d8',
headers: {
authorization: 'bearer .....'
},
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know