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. For example - if we block on missing insurance information and the customer returns a blank string as the resolution, the task will temporarily lose the blocker before adding it back again as the issue was not truly resolved.

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. For example - if we block on missing insurance information and the customer returns a blank string as the resolution, the task will temporarily lose the blocker before adding it back again as the issue was not truly resolved.

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.

INCOMPLETE_INSURANCE_INFORMATIONobject

We are missing information about the patient's insurance. Submit additional insurance information as specified by the blocker note.

INSURANCE_CARD_IMAGES_NEEDEDobject

We need the patient to upload their insurance card images to continue with the task. Use the Get Insurance Card Image Upload URLs endpoint to get presigned upload URLs, upload the images, and then mark this blocker as resolved using the Resolve Appointment Task Blocker endpoint.

We need the patient to upload their insurance card images to continue with the task. Use the [Get Insurance Card Image Upload URLs](/api-reference/appointment-embedded/get-insurance-card-image-upload-urls) endpoint to get presigned upload URLs, upload the images, and then mark this blocker as resolved using the [Resolve Appointment Task Blocker](/api-reference/appointment-embedded/resolve-appointment-task-blocker) endpoint.

INCOMPLETE_REASON_FOR_VISIT_INFORMATIONobject

The provided reason for visit is invalid or incomplete. Please provide a valid reason for visit. See the blocker note for more detail.

PROVIDER_OPTION_NOT_SELECTEDobject

Ferry is waiting on the patient's selection of a provider and to share their availability for an appointment.

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.

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.

UNABLE_TO_BOOK_ON_PATIENTS_BEHALFobject

Ferry is unable to book an appointment on the patient's behalf.

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.

1	import requests
2
3	url = "https://api.ferry.health/api/v1/appointment-tasks-embedded/ferry.task-appointment.a3327c6c-1cc2-4f56-a137-6c457550a04e/blockers"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	[
2	{
3	"type": "INCOMPLETE_INSURANCE_INFORMATION",
4	"id": "ferry.task-appointment-blocker.a3327c6c-1cc2-4f56-a137-6c457550a04e",
5	"note": "We are missing information about the patient's insurance."
6	}
7	]