Appointment

Create Appointment Task

Create an appointment task for a patient.

Once you create a task, Ferry will asynchronously process the task to find providers with validated availability. You can poll for the status of the task with the Get Appointment Task endpoint.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
patientstring or objectRequired

Either a patient ID or a patient object.

If you supply a patient object, we will first create the patient (or update it, if a patient already exists with the provided phone number).

providerSpecialtystringRequired
The specialty of the provider that the patient needs to see.
reasonForVisitstringRequired
The reason for the patient's visit.
providerSubspecialtystringOptional
The subspecialty of the provider that the patient needs to see.
timeFramestringOptional
The time frame in which the patient needs to have the appointment. This can be in any reasonable format.
distanceInMilesdoubleOptional

The maximum distance (in miles) from the patient’s home where the provider can be located.

npislist of strings or list of lists of stringsOptional
The NPIs to prioritize in the search.
patientPreferencesstringOptional

Any preferences the patient has for the appointment (provider gender, age, language, etc.).

Response

This endpoint returns an object.
appointmentTaskIdstring

The ID of the newly created appointment task. Ferry will asynchronously process the task before it is ready for the patient to act on it. You can poll for the status of the task with the Get Appointment Task endpoint.