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
codes array
Codings for what was observed (e.g. LOINC)
status enum
Valid values:
"REGISTERED"
"PRELIMINARY"
"FINAL"
"AMENDED"
"CORRECTED"
Status of the observation result
type enum
Valid values:
"LABORATORY"
"VITAL_SIGNS"
"SOCIAL_HISTORY"
"IMAGING"
"SURVEY"
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
Valid values:
"NORMAL"
"ABNORMAL"
"LOW"
"HIGH"
"CRITICAL_LOW"
Interpretation of the result (e.g. high, low)
reference_rangeobject
Normal range for the result
components array
Component results (e.g. systolic and diastolic blood pressure)
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
metadata array

Returns

Response fieldTypeRequiredDescription
idstringNoUnique identifier for the observation
created_atstring (date-time)NoWhen the observation record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoWhen the observation record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
patient_idstringNoThe patient the observation is about
encounter_idstringNoThe encounter in which the observation was made
practitioner_idstringNoThe practitioner who performed the observation
namestringNoHuman-readable name of what was observed
codesHealthcareCode[]NoCodings for what was observed (e.g. LOINC)
codes[].systemstringNoThe code system URI (e.g. http://loinc.org, http://snomed.info/sct)
codes[].codestringNoThe code within the system
codes[].displaystringNoHuman-readable display text for the code
statusenumNoStatus of the observation result Values: REGISTERED, PRELIMINARY, FINAL, AMENDED, CORRECTED, CANCELLED, ENTERED_IN_ERROR, UNKNOWN, OTHER
typeenumNoCategory of the observation Values: LABORATORY, VITAL_SIGNS, SOCIAL_HISTORY, IMAGING, SURVEY, EXAM, PROCEDURE, THERAPY, ACTIVITY, OTHER
value_numbernumberNoNumeric result value
value_unitstringNoUnit of the numeric result (e.g. mg/dL)
value_textstringNoText or coded result value
interpretationenumNoInterpretation of the result (e.g. high, low) Values: NORMAL, ABNORMAL, LOW, HIGH, CRITICAL_LOW, CRITICAL_HIGH, OTHER
reference_rangeobjectNoNormal range for the result
reference_range.low_valuenumberNoLower bound of the range
reference_range.high_valuenumberNoUpper bound of the range
reference_range.unitstringNoUnit of the range bounds
reference_range.textstringNoText description of the range
componentsHealthcareObservationComponent[]NoComponent results (e.g. systolic and diastolic blood pressure)
components[].namestringNoHuman-readable name of the component
components[].codesHealthcareCode[]NoCodings for the component (e.g. LOINC)
components[].codes[].systemstringNoThe code system URI (e.g. http://loinc.org, http://snomed.info/sct)
components[].codes[].codestringNoThe code within the system
components[].codes[].displaystringNoHuman-readable display text for the code
components[].value_numbernumberNoNumeric component value
components[].value_unitstringNoUnit of the numeric component value
components[].value_textstringNoText or coded component value
components[].interpretationenumNoInterpretation of the component value Values: NORMAL, ABNORMAL, LOW, HIGH, CRITICAL_LOW, CRITICAL_HIGH, OTHER
observed_atstring (date-time)NoWhen the observation was made (effective time) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
issued_atstring (date-time)NoWhen the result was released (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
notesstringNoFree-text notes about the observation
metadataHealthcareMetadata[]No
metadata[].idstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT
metadata[].extra_dataobjectNo
metadata[].slugstringNo

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"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot 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
Was this page helpful?