healthcare
encounter

List all encounters

get/healthcare/{connection_id}/encounter

Request

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

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring date-time

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sort'name' | 'updated_at' | 'created_at'
order'asc' | 'desc'
querystring

Query string to search. eg. email address or name

patient_idstring

The patient ID to filter by

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 encounter

created_atstring date-time

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

updated_atstring date-time

When the encounter record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

patient_idstring

The patient seen in the encounter

practitioner_idsstring[]

The practitioners who participated in the encounter

location_idstring

Where the encounter took place

appointment_idstring

The appointment that scheduled this encounter

condition_idsstring[]

Conditions diagnosed or addressed during the encounter

status'PLANNED' | 'ARRIVED' | 'TRIAGED' | 'IN_PROGRESS' | 'ONLEAVE' | 'FINISHED' | 'CANCELLED' | 'ENTERED_IN_ERROR' | 'UNKNOWN' | 'OTHER'

Status of the encounter

type'AMBULATORY' | 'EMERGENCY' | 'INPATIENT' | 'OBSERVATION' | 'HOME_HEALTH' | 'VIRTUAL' | 'OTHER'

Class of the encounter (e.g. ambulatory, inpatient)

start_atstring date-time

When the encounter started (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time

When the encounter ended (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

rawunknown

Changes

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