Overview
Use the Air Doctor Patient App to deliver medical care services inside your platform. Integrate the Patient App through the SDK or through hosted screens, and operate within a unified architecture.
The Air Doctor Patient App and Doctor App expose the same SDK structure, OpenAPI endpoints, authentication flows, and data models. Use this alignment to reduce implementation effort and maintain consistent behavior across all roles.
Integration Scope
Integrate the Patient App to support core medical care workflows inside your environment.
Use the unified SDK and OpenAPI endpoints to interact with Air Doctor services.
Enable the following capabilities:
- Single sign-on and social login with Apple, Google, and Facebook
- Coverage validation through partner or Air Doctor endpoints
- Doctor search and booking for in-person and video visits
- Access to confirmations, reminders, documents, and follow-up information
Partner Implementation Overview
Embed the SDK or host screens inside your application and control authentication entry points. Provide identity and coverage context to the SDK and receive callbacks with booking and document states.
Each workflow defines required endpoints, SDK entry points, and expected data formats.
User Workflows
Create a Patient Account
- Collect identity fields.
- Capture consent for Terms of Use and optional marketing communication.
- Send the data to the backend to create the patient profile.
| Integration Point | Description |
|---|---|
POST /profile | Create a patient profile. |
| SDK Method | AirDoctorSDK.createAccount() |
| Required Fields | email, firstName, lastName, password |
Authenticate Users
Authenticate users through email and password or through supported identity providers.
Supported methods include:
- Email and password
- Apple
- Single sign-on
The backend issues a session token for authorized operations.
Output: A valid session token for subsequent SDK and API requests.
Validate Coverage
- Collect required coverage fields.
- Submit the data to the backend.
- Confirm active coverage before initiating booking workflows.
Coverage validation confirms user eligibility for medical bookings.
Search and Book a Doctor
- Start the Find a Doctor flow.
- Apply filters for location, specialty, availability, and coverage.
- Select an appointment type: clinic, hotel, or video.
- Complete the booking and return confirmation details.
| Integration Point | Description |
|---|---|
GET /doctors/search | Return available doctors based on filters. |
POST /bookings | Create a booking and return the booking identifier. |
| SDK Methods | ExampleSDK.exampleDoctors(), ExampleAirDoctorSDK.examplebookDoctor() |