healthcare

appointment

Update an appointment

patch/healthcare/{connection_id}/appointment/{id}

Request

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

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Appointment

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

Request body

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 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

Response

Successful