Create an appointment
POST/healthcare/{connection_id}/appointment
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 appointment
created_atdate-time
When the appointment was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
When the appointment was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
patient_idstring
The patient attending the appointment
practitioner_idsstring array
The practitioners participating in the appointment
location_idstring
Where the appointment takes place
slot_idsstring array
The schedule slots this appointment occupies
status enum
Status of the appointment
start_atdate-time
When the appointment starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atdate-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
Returns
| Response field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for the appointment |
created_at | string (date-time) | No | When the appointment was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the appointment was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
patient_id | string | No | The patient attending the appointment |
practitioner_ids | string[] | No | The practitioners participating in the appointment |
location_id | string | No | Where the appointment takes place |
slot_ids | string[] | No | The schedule slots this appointment occupies |
status | enum | No | Status of the appointment Values: PROPOSED, PENDING, BOOKED, ARRIVED, CHECKED_IN, FULFILLED, CANCELLED, NOSHOW, WAITLIST, ENTERED_IN_ERROR, OTHER |
start_at | string (date-time) | No | When the appointment starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | No | When the appointment ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
description | string | No | Short description shown on the appointment |
service_types | HealthcareCode[] | No | Codings for the service/visit type being booked |
service_types[].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) |
service_types[].code | string | No | The code within the system |
service_types[].display | string | No | Human-readable display text for the code |
reasons | HealthcareCode[] | No | Codings for the reason for the visit |
reasons[].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) |
reasons[].code | string | No | The code within the system |
reasons[].display | string | No | Human-readable display text for the code |
cancellation_reason | string | No | Why the appointment was cancelled |
notes | string | No | Free-text notes or comments |
metadata | HealthcareMetadata[] | No | |
metadata[].id | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT |
metadata[].extra_data | object | No | |
metadata[].slug | string | No |
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"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not 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/appointment',
headers: {
authorization: 'bearer .....'
},
data: undefined,
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know