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
Valid values:
"PROPOSED"
"PENDING"
"BOOKED"
"ARRIVED"
"CHECKED_IN"
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
service_types array
Codings for the service/visit type being booked
reasons array
Codings for the reason for the visit
cancellation_reasonstring
Why the appointment was cancelled
notesstring
Free-text notes or comments
metadata array

Returns

Response fieldTypeRequiredDescription
idstringNoUnique identifier for the appointment
created_atstring (date-time)NoWhen the appointment was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoWhen the appointment was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
patient_idstringNoThe patient attending the appointment
practitioner_idsstring[]NoThe practitioners participating in the appointment
location_idstringNoWhere the appointment takes place
slot_idsstring[]NoThe schedule slots this appointment occupies
statusenumNoStatus of the appointment Values: PROPOSED, PENDING, BOOKED, ARRIVED, CHECKED_IN, FULFILLED, CANCELLED, NOSHOW, WAITLIST, ENTERED_IN_ERROR, OTHER
start_atstring (date-time)NoWhen the appointment starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)NoWhen the appointment ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
descriptionstringNoShort description shown on the appointment
service_typesHealthcareCode[]NoCodings for the service/visit type being booked
service_types[].systemstringNoThe code system URI (e.g. http://loinc.org, http://snomed.info/sct)
service_types[].codestringNoThe code within the system
service_types[].displaystringNoHuman-readable display text for the code
reasonsHealthcareCode[]NoCodings for the reason for the visit
reasons[].systemstringNoThe code system URI (e.g. http://loinc.org, http://snomed.info/sct)
reasons[].codestringNoThe code within the system
reasons[].displaystringNoHuman-readable display text for the code
cancellation_reasonstringNoWhy the appointment was cancelled
notesstringNoFree-text notes or comments
metadataHealthcareMetadata[]No
metadata[].idstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT
metadata[].extra_dataobjectNo
metadata[].slugstringNo

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"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot 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
Was this page helpful?