Create Task For Invited Patient

curl -X POST https://api.ferry.health/api/v1/patient-invitations/create-task \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "invitation": {
    "phoneNumber": "+12234567890",
    "seedData": {
      "firstName": "Jane",
      "lastName": "Smith"
    }
  },
  "providerSpecialty": "Gastroenterologist",
  "reasonForVisit": "Ulcerative Colitis",
  "distanceInMiles": 5,
  "timeFrame": "Within the next month"
}'

{
  "type": "PENDING",
  "invitationId": "ferry.patient-invitation.84396f99-a7d1-44f9-ae8b-01741931269e",
  "pendingTasks": [
    {
      "taskAppointmentId": "ferry.task-appointment.84396f99-a7d1-44f9-ae8b-01741931269e",
      "providerSpecialty": "Gastroenterologist",
      "reasonForVisit": "Ulcerative Colitis",
      "timeFrame": "Within the next month",
      "distanceInMiles": 5
    }
  ],
  "phoneNumber": "+12234567890",
  "seedData": {
    "firstName": "Jane",
    "lastName": "Smith"
  }
}

Create a task for an invited patient.

If the patient has already enrolled in Ferry, this endpoint will behave identically to the create appointment task endpoint.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

invitationstring or objectRequired

providerSpecialtystringRequired

The specialty of the provider that the patient needs to see.

reasonForVisitstringRequired

The reason for the patient's visit.

addressstringOptional

The address to center our search for providers. If not provided, the patient's home address will be used.

distanceInMilesdoubleOptional

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

patientPreferencesstringOptional

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

preferredProvidersobjectOptional

The practices and providers to prioritize in the search.

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.

npislist of strings or list of lists of stringsOptionalDeprecated

This field is deprecated and will be removed in a future version. Use the preferredProviders field instead

The NPIs to prioritize in the search.

<Error> This field is deprecated and will be removed in a future version. Use the `preferredProviders` field instead </Error> The NPIs to prioritize in the search.

Response

This endpoint returns an object.

PENDINGobject

ENROLLEDobject