Book a Regular Appointment
Use the Regular Appointment Request screen to create a scheduled appointment after the user selects a provider, location, date, and time.
Unlike other appointment request flows, this flow uses a specific appointment slot selected by the user.
This screen includes:
| # | Element | Description |
|---|---|---|
| 1 | Header | Displays the Appointment request title and navigation action |
| 2 | Provider card | Displays provider, appointment, and visit information |
| 3 | Coverage section | Displays the selected coverage or payment option |
| 4 | Patient details section | Displays the selected patient profile |
| 5 | Contact information section | Collects contact details and notification preferences |
| 6 | Medications section | Collects medication usage information |
| 7 | Medical issue section | Collects medical condition details |
| 8 | Attachment action | Adds supporting documents |
| 9 | Home visit details section | Collects the visit address |
| 10 | Address search input | Searches for the home visit location |
| 11 | Country or region selector | Selects the visit country or region |
| 12 | Address fields | Collects address details required for the visit |
| 13 | Pricing section | Displays the calculated home visit fee |
| 14 | Primary action | Continues the appointment request flow |
| 15 | Data-sharing notice | Explains that appointment details are shared with the provider |
Workflow
- Open the Appointment Request screen.
- Review provider and appointment details.
- Select coverage and patient information.
- Enter required contact information.
- Complete medical information.
- Enter visit location details.
- Select Continue.
Validations
| Scenario | App Behavior | SDK Output |
|---|---|---|
| Session invalid | Block coverage verification | state = unauthenticated |
| Coverage provider missing | Disable Continue | validation = coverage_required |
| Policy number missing | Disable Continue | validation = policy_number_required |
| Policy details incomplete | Disable Continue | validation = coverage_details_required |
| Provider records do not match | Display wrong data popup | error = wrong_policy_data |
| Coverage verified | Continue coverage flow | coverage = verified |
| Request rejected | Display error state | status = 405 |
Actions
| Scenario | App Behavior | SDK Output |
|---|---|---|
| Screen opens | Load add coverage form | PUT /api/v3/coverage/add/new-coverage |
| Coverage provider selected | Update coverage provider | coverage = selected |
| Policy number entered | Update policy details | policyNumber = updated |
| Continue selected | Submit coverage verification | POST /api/v3/coverage/add/new-coverage |
| Wrong data returned | Load wrong data popup | PUT /api/v3/coverage/add/new-coverage/error/wrong-policy-data |
| Private user selected | Continue without verified coverage | coverageMode = private_user |
| Contact Us selected | Open support contact flow | action = contact_support |
| Close selected | Return to add coverage form | state = dismissed |
Endpoints Resources
Use the appointment booking endpoints to load the booking flow, update wizard state, create an appointment, or submit revisions to an existing appointment.
Appointment Workflow
| Method | Endpoint | Purpose |
|---|---|---|
| PUT | v3/appointments/book | Returns the regular appointment wizard for the selected provider, location, and date. |
| PATCH | v3/appointments/book/steps/next | Saves the current step and opens the next wizard step. |
| PATCH | v3/appointments/book/steps/previous | Opens the previous wizard step. |
| POST | v3/appointments/book/create | Creates an appointment from the current wizard data. |
| POST | v3/appointments/book/update | Updates an existing appointment from the revised booking data. |
Address Selection
| Method | Endpoint | Purpose |
|---|---|---|
| PATCH | v3/appointments/book/addresses/search | Returns home-visit address suggestions from the search text and appointment filters. |
| PATCH | v3/appointments/book/addresses/select | Selects an address suggestion and populates the booking address fields. |
Promo Code
| Method | Endpoint | Purpose |
|---|---|---|
| PATCH | v3/appointments/book/promo/accessibility | Sets promo code action availability for the entered value. |
| PATCH | v3/appointments/book/promo/apply | Applies a promo code and updates the appointment price or eligibility. |
| PATCH | v3/appointments/book/promo/delete | Removes the promo code and refreshes the appointment price. |
Appointment Options
| Method | Endpoint | Purpose |
|---|---|---|
| PATCH | v3/appointments/book/sms/availability | Checks SMS availability and sets SMS consent visibility. |
| PATCH | v3/appointments/book/update/agreement | Updates the consent section from the agreement status. |
| PATCH | v3/appointments/book/update/home | Updates the appointment location options from the selected visit type. |
| PATCH | v3/appointments/book/update/interpreter | Updates interpreter preferences for the consultation. |
| PATCH | v3/appointments/book/update/preferences | Updates preferred languages for the video consultation. |
| PATCH | v3/appointments/book/update/medications | Updates the medication section from the selected medication status. |