Skip to main content

First Available Doctor


Use First Available Appointment Request to collect patient, coverage, and contact details for the first available doctor flow.

The selected visit type and matching result determine the request details.


First Available Appointment Request screen with doctor summary and patient details

This screen includes:

#ElementDescription
1Appointment summaryDisplays matched doctor type, visit type, date, and price range
2Patient detailsSelects or displays the patient
3Coverage sectionDisplays payment or coverage context
4Contact informationCollects required contact details
5Continue actionProceeds when required fields are valid
6Profile sharing noticeDisplays data-sharing notice

Workflow​

  1. Open the Home screen.
  2. Locate the First available doctor section.
  3. Select a supported appointment type.
    First Available Doctor appointment type selector
  4. Start the first available doctor flow.
  5. Render the appointment request form.
  6. Confirm patient details.
  7. Review coverage context.
  8. Enter required contact information.
  9. Continue to the next booking step.

Validations​

ScenarioApp BehaviorSDK Output
Patient missingBlock continuationerror = patient_required
Required contact field missingBlock continuationerror = required_field
Email invalidDisplay validation errorerror = invalid_email
Coverage unavailableDisplay private-pay contextcoverage = private
Required fields validEnable Continue actionstate = ready
Request rejectedDisplay error statestatus = 405

Actions​

ScenarioApp BehaviorSDK Output
Request screen openedLoad appointment request formPUT /api/v3/wizard/asap
Patient selectedUpdate patient contextpatient = selected
Contact details updatedUpdate form statecontact = updated
Continue selectedSubmit request detailsstate = submitted
Request succeedsContinue booking flownavigation = next
Request failsPreserve editable statestate = error

Endpoint Resources​

Appointment Workflow​

MethodEndpointPurpose
PUTv3/appointments/bookReturns the regular appointment wizard for the selected provider, location, and date.
PATCHv3/appointments/book/steps/nextSaves the current step and opens the next wizard step.
PATCHv3/appointments/book/steps/previousOpens the previous wizard step.
PATCHv3/appointments/book/checkoutUpdates the checkout state for the current appointment flow.
POSTv3/appointments/book/createCreates an appointment from the current wizard data.
POSTv3/appointments/book/updateUpdates an existing appointment from the revised booking data.

Address Selection​

MethodEndpointPurpose
PATCHv3/appointments/book/addresses/searchReturns home-visit address suggestions from the search text and appointment filters.
PATCHv3/appointments/book/addresses/selectSelects an address suggestion and populates the booking address fields.

Appointment Options​

MethodEndpointPurpose
PATCHv3/appointments/book/sms/availabilityChecks SMS availability and sets SMS consent visibility.
PATCHv3/appointments/book/update/agreementUpdates the consent section from the agreement status.
PATCHv3/appointments/book/update/homeUpdates the appointment location options from the selected visit type.
PATCHv3/appointments/book/update/interpreterUpdates interpreter preferences for the consultation.
PATCHv3/appointments/book/update/preferencesUpdates preferred languages for the video consultation.
PATCHv3/appointments/book/update/medicationsUpdates the medication section from the selected medication status.