Skip to main content

Outside Patient Coverage

Use Outside Patient Coverage when the proposed appointment time falls outside the patient’s coverage period.

The screen blocks appointment approval and directs the doctor to Air Doctor support.



This screen includes:

#ElementDescription
1Coverage messageStates that the proposed time falls outside the patient’s coverage
2Chat now actionOpens Air Doctor support

Workflow​

  1. Select an appointment time in a supported appointment workflow.
  2. Validate the proposed time against the patient’s coverage period.
  3. Detect that the proposed time falls outside the coverage period.
  4. Call PUT /api/v3/profile/appointments/{appointment-id}/outside-patient-coverage.
  5. Display Outside Patient Coverage.
  6. Select Chat now to contact Air Doctor support.

The screen can appear from these workflows:

Validations​

ScenarioApp behaviorSDK output
Proposed time falls outside the coverage periodDisplay the coverage screenPage object
Proposed time falls within the coverage periodContinue the parent workflowNo coverage page
Request returns 200Render the returned pagePage object
Request returns 405Display an application errorError response
Session is invalidReject the requestAuthentication error

Actions​

ScenarioApp behaviorSDK output
Chat now selectedOpen Air Doctor supportNavigation event

Endpoint Resources​

Approve Note​

PUT 

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

Displays the Outside Patient Coverage page when the proposed appointment time falls outside the patient’s coverage period.

Path Parameters​

ParameterTypeRequiredDescription
appointment-idIntegerYesIdentifies the appointment

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—