Skip to main content

Outside Patient Coverage


Use the Outside Patient Coverage screen to notify the doctor that the selected appointment time does not fall within the patient’s active insurance or service coverage window.
The app presents this screen when backend validation identifies a coverage conflict.

This screen supports authenticated doctors only and loads as a redirect from scheduling or approval workflows.

This screen includes:

  • A static message explaining the coverage conflict.
  • A Chat now button that opens the embedded support module.
  • A blocking state that removes all scheduling or approval options.
  • No interactive inputs, fields, or datetime controls.

Workflow

  1. The doctor selects an appointment time in any supported workflow, such as:
  2. The backend checks whether the proposed time fits within the patient’s valid coverage window.
  3. If coverage does not apply, the app redirects to Outside Patient Coverage.
  4. The doctor selects Chat now to request assistance from Air Doctor support.

Validations

These scenarios describe how the system validates coverage and what the SDK produces.

ScenarioApp BehaviorSDK OutputExample
The proposed time does not fall within the patient’s coverage period.The app redirects to Outside Patient Coverage and blocks all appointment actions.Page object with the coverage warning screen.
The doctor attempts to approve, schedule, or suggest alternatives.The app ignores the attempt and stays on the coverage screen.No-op update set; action remains blocked.
The parent workflow contains invalid or missing coverage metadata.The app displays the coverage message and activates support interaction.Coverage error code in the page response.
The appointment status changes during review.The app revalidates and may redirect again if the time conflicts with coverage limits.Update set that refreshes the coverage screen.

Actions

These scenarios describe how the doctor interacts with this screen and how the SDK responds.

ScenarioApp BehaviorSDK OutputExample
The doctor selects Chat now.The app launches the embedded support module for real-time communication.Update set that opens the support fragment.
The doctor attempts to dismiss the screen.The app blocks navigation to prevent unsupported scheduling.No-op or block-state update set.
The doctor selects a blocked action from the parent workflow.The app prevents progression and displays only the coverage message.Update set showing coverage conflict remains active.

Endpoint Resources

Approve Note

PUT 

/profile/appointments/{appointment-id}/outside-patient-coverage

Produces the Outside Patient Coverage page when backend validation determines that the proposed time exceeds the patient’s coverage window.

  • A static explanatory message
  • A Chat now action
  • A fully blocked workflow state that prevents scheduling or approval

UI Element Types

LevelReferenceTypeValuePlacement
1outside-patient-coverageRegularThe proposed time is outside the patient's coverage. Contact support to book the appointment within the coverage period.
1chat-nowButtonChat now