Home Visit Details
Use the Home Visit Details screen to provide the visit address for a home appointment.
This screen collects location information, evaluates service availability, and updates the appointment cost based on the entered address.
This screen includes
- An Address field that accepts street, number, and city.
- Optional Floor and Apartment or Room number fields.
- An optional Notes field for access or location instructions.
- A cost notice that reflects the appointment cost based on the entered location.
- A Next button that advances the flow when required fields are valid.
- Informational text that states the app shares the provided details with the doctor.
Workflow
This workflow describes how the app processes home visit location details.
- Open the Home Visit Details section after selecting a home visit appointment type.
- Enter a valid address.
- Review the updated appointment cost based on the entered location.
- Select Next to continue.
If the location is outside the doctor’s service range, the app marks the home visit option as unavailable.
Validations
These validations run before the app allows the user to proceed.
| Scenario | App Behavior | SDK Output |
|---|---|---|
| Required address field is missing. | Blocks navigation and highlights the Address field. | Returns a required field validation error. |
| Address cannot be resolved or falls outside the service area. | Displays an out-of-range notice and prevents selection of the home visit option. | Returns an availability or range validation error. |
| Address input changes. | Recalculates the appointment cost based on location. | Returns updated pricing data. |
| Input exceeds allowed field length. | Prevents additional input. | Returns a field length validation error. |
The app validates address data and availability before advancing to the next step.
Actions
Home visit handling depends on availability and integration level.
Home Visit Actions
| Scenario | App Behavior | SDK Output | Integration Level Impact |
|---|---|---|---|
| User enters a valid address within service range. | Stores the address and updates the appointment cost. | Returns updated request data and pricing. | Levels 1–2: Air Doctor controls pricing and navigation. Levels 3–4: Air Doctor emits update events. Levels 5–6: Host app consumes updates via SDK or OpenAPI. |
| User enters an address outside service range. | Displays an out-of-range notice and disables the home visit option. | Returns an availability error. | All levels: Availability handling depends on integration. |
| User selects Next with valid input. | Advances to the next screen in the request flow. | Returns updated appointment request state. | All levels: Navigation follows integration rules. |
| User navigates back before proceeding. | Discards unsaved address changes. | No update occurs. | All levels: Navigation depends on the integration. |
| Backend validation fails. | Displays an error and keeps the user on the Home Visit Details screen. | Returns an address validation error. | All levels: Error handling follows integration rules. |
Endpoint Resources
🧰 Endpoint Resources under construction