Skip to main content

Overview


Use the Air Doctor Patient App to expose medical care services inside your platform without implementing medical workflows or business logic on the client.

The Patient App integrates through hosted screens, client SDKs, or the Open API. The selected integration level determines the degree of UI and navigation control while the server continues to define all medical workflows.

The Patient App follows the Air Doctor v3 architecture, which enforces a strict separation between logic, state, and presentation. This architecture supports predictable integration, stable user flows, and low client maintenance.

important

The Air Doctor server defines all medical workflows, validations, and screen composition.
Client applications render instructions and do not contain medical business logic.

The Patient App and Doctor App use the same Open API specification, authentication model, and data structures. This alignment reduces integration effort and ensures consistent behavior across roles.

System architecture showing how both the Doctor App and Patient App connect through the SDK and API layers to the Air Doctor backend.

What the Patient App Provides

The Patient App exposes patient-facing medical workflows that operate inside your application context.

🔹
Authentication
Authenticate users through email, social providers, or single sign-on.
🔹
Coverage Validation
Confirm eligibility using Air Doctor or partner-provided coverage data.
🔹
Doctor Booking
Search doctors and create clinic, hotel, or video appointments.
🔹
Post-Booking Access
Expose confirmations, reminders, documents, and follow-up details.

Core User Workflows

The Patient App exposes standard patient-facing workflows. The server defines required fields, validations, and permitted actions for each workflow.

Workflow behavior

Each workflow follows server-defined actions and transitions.
The client does not determine screen order or validation rules.

Patient Account Creation

The account creation workflow registers a new patient profile.

Integration PointDescription
POST /profileCreate a patient profile.
SDK Entry PointAirDoctorSDK.createAccount()
Required Fieldsemail, firstName, lastName, password

The server validates input and returns the next available actions.

User Authentication

Users authenticate through supported identity providers.

  • Email and password.
  • Apple.
  • Google.
  • Facebook.
  • Single sign-on.

The server issues a session token that authorizes subsequent operations.

note

Authentication behavior remains consistent across all integration levels.

Coverage Validation

Coverage validation confirms eligibility before booking.

  1. Collect coverage data.
  2. Submit data to the server.
  3. Receive eligibility confirmation or required next steps.

The client does not enforce coverage rules.

Doctor Search and Appointment Booking

The booking workflow guides users through doctor discovery and appointment creation.

Integration PointDescription
GET /doctors/searchReturn doctors based on server-defined filters.
POST /bookingsCreate an appointment and return the booking identifier.
SDK Entry PointsSearch and booking methods exposed by the SDK.

The server controls availability, pricing, coverage rules, and confirmation behavior.