Create Imaging Task

Beta

Create an imaging task for a patient.

Once you create a task, Ferry will asynchronously process the task to find imaging facilities with validated availability. You can poll for the status of the task with the Get Imaging 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).

imagingRequestobjectRequired
The imaging request from the patient.
patientAvailabilitystringOptional
The availability of the patient for the imaging.
referringProviderobjectOptional
The provider who referred the patient for an imaging appointment.
preferredImagingCenterstringOptional
The preferred imaging center for the patient.
notesstringOptional
Additional notes from the patient.
eligibilityEndDatestringOptional
The end date of the patient's eligibility for the imaging request. If provided, the imaging appointment must be scheduled before this date. This can be in any reasonable format.

Response

This endpoint returns an object.
imagingTaskIdstring

The ID of the newly created imaging 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 Imaging Task endpoint.