Appointment Embedded

Get Appointment Task Blockers

Load the blockers for an appointment task by its ID. If there are 1 or more blockers on the task, the task is considered “blocked” and requires patient input in the form of a blocker resolution to proceed.

It is possible to have multiple block-resolution combos before a task is able to proceed.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

appointmentTaskIdstringRequired
The ID of the task to load the blockers for.

Response

This endpoint returns a list of objects.
PROVIDER_OPTION_NOT_SELECTEDobject
Ferry is waiting on the patient's selection of a provider and to share their availability for an appointment.
OR
UNABLE_TO_BOOK_DUE_TO_AVAILABILITYobject
The practices' availability does not match up with the patient's availability and an appointment has not been booked.
OR
UNABLE_TO_BOOK_WITHOUT_REFERRALobject
Ferry is unable to book an appointment because the practice requires a referral to be received before they will book.
OR
UNABLE_TO_BOOK_ON_PATIENTS_BEHALFobject
Ferry is unable to book an appointment on the patient's behalf.
OR
UNABLE_TO_CANCEL_WITHOUT_FEESobject
If Ferry were to cancel the appointment the patient would be responsible for a cancellation fee. Ferry will not cancel appointment until this blocker is resolved.