healthcare
appointment

List all appointments

get/healthcare/{connection_id}/appointment

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/healthcare/{connection_id}/appointment
  • 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

practitioner_idstring

The practitioner ID to filter by

location_idstring

The location ID to filter by

status'PROPOSED' | 'PENDING' | 'BOOKED' | 'ARRIVED' | 'CHECKED_IN' | 'FULFILLED' | 'CANCELLED' | 'NOSHOW' | 'WAITLIST' | 'ENTERED_IN_ERROR' | 'OTHER'
start_gtestring

The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_ltstring

The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

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 appointment

created_atstring date-time

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

updated_atstring date-time

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

patient_idstring

The patient attending the appointment

practitioner_idsstring[]

The practitioners participating in the appointment

location_idstring

Where the appointment takes place

slot_idsstring[]

The schedule slots this appointment occupies

status'PROPOSED' | 'PENDING' | 'BOOKED' | 'ARRIVED' | 'CHECKED_IN' | 'FULFILLED' | 'CANCELLED' | 'NOSHOW' | 'WAITLIST' | 'ENTERED_IN_ERROR' | 'OTHER'

Status of the appointment

start_atstring date-time

When the appointment starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time

When the appointment ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

descriptionstring

Short description shown on the appointment

cancellation_reasonstring

Why the appointment was cancelled

notesstring

Free-text notes or comments

rawunknown

Changes

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