Home Visit Out of Range
Use Home Visit Out of Range when the selected doctor cannot attend the specified address.
The patient must select another doctor.
This screen includes:
| # | Element | Description |
|---|---|---|
| 1 | Availability message | States that the doctor cannot attend the address |
| 2 | OK action | Returns the patient to doctor selection |
| 3 | Close action | Dismisses the popup |
Workflow
- Validate the selected doctor against the specified address.
- Detect that the address is outside the doctor’s service area.
- Call
PUT /api/v3/appointments/book/error/home-out-of-range. - Display the Home Visit Out of Range popup.
- Select OK.
- Return to doctor selection.
Validations
| Scenario | App behavior | SDK output |
|---|---|---|
| Address is outside the doctor’s service area | Display the popup | Page object |
| Doctor can attend the address | Continue the appointment request | No error page |
Request returns 405 | Display an application error | Error response |
| Session is invalid | Reject the request | Authentication error |
Actions
| Scenario | App behavior | SDK output |
|---|---|---|
| OK selected | Return to doctor selection | Navigation event |
| Close selected | Dismiss the popup | Close event |
Endpoint Resources
Home Out of Range
PUT
v3/appointments/book/error/home-out-of-range
Returns a popup when the selected doctor cannot attend the specified address.