healthcare
observation

Retrieve an observation

get/healthcare/{connection_id}/observation/{id}

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/healthcare/{connection_id}/observation/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Observation

Query parameters

fieldsstring[]

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

Response

Successful

idstring

Unique identifier for the observation

created_atstring date-time

When the observation record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-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'REGISTERED' | 'PRELIMINARY' | 'FINAL' | 'AMENDED' | 'CORRECTED' | 'CANCELLED' | 'ENTERED_IN_ERROR' | 'UNKNOWN' | 'OTHER'

Status of the observation result

type'LABORATORY' | 'VITAL_SIGNS' | 'SOCIAL_HISTORY' | 'IMAGING' | 'SURVEY' | 'EXAM' | 'PROCEDURE' | 'THERAPY' | 'ACTIVITY' | 'OTHER'

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'NORMAL' | 'ABNORMAL' | 'LOW' | 'HIGH' | 'CRITICAL_LOW' | 'CRITICAL_HIGH' | 'OTHER'

Interpretation of the result (e.g. high, low)

observed_atstring date-time

When the observation was made (effective time) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

issued_atstring date-time

When the result was released (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

notesstring

Free-text notes about the observation

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.