Doctor List
Use the Doctor List screen to display available doctors by location, policy coverage, and active filters.
This screen includes:
- Search & location
- Location input
- Selection controls
- Visit type selectors
- Filter and sort controls
- Results display
- Doctor result cards
- Optional First Available Doctor entry
- View options
- Map view toggle
Workflow
This flow describes how the doctor list loads and how users proceed to booking.
- From the Home Screen, select a specialty or enter search criteria.
- The platform returns matching doctors.
- Render the doctor list.
- Select a doctor or availability to continue.
The Doctor List filters results using:
- Coverage scope
- Partner eligibility
- Location context
Doctor Card Behavior
This section describes how each doctor card renders and behaves.
Each doctor card represents a selectable result.
Card content depends on:
- Availability state
- Appointment state
- Visit type support
The client renders:
- Doctor information
- Name, specialty, rating
- Pricing
- Availability actions
Prescription Indicator
This section describes how prescription messaging resolves.
Prescription messaging resolves in this order:
- State/Province (if available)
- Country (fallback)
Possible outputs:
- Cannot prescribe in
<State/Province> - Cannot prescribe in
<Country> - Can prescribe in
<State/Province>
Prescription status does not render when only in-person visits are available.
For full behavior, see Prescriptions.
Interaction Behavior
This section describes how user input updates the result set.
The result set updates based on user input:
- Location change → Recompute results
- Visit type change → Apply visit constraints
- Filters applied → Update result set
- Sort applied → Reorder results
- Map view → Display results as markers
All updates depend on the platform response.
Validations
This section describes how the app and SDK handle constraints.
| Condition | App behavior | SDK output |
|---|---|---|
| No matching doctors | Display empty state | Empty result set |
| Location resolved | Limit results | Truncated response |
| Unsupported visit type | Exclude results | Filtered result set |
| Review count exceeds limit | Normalize display | Adjusted value (99+) |
| Filters applied | Update results | Filtered response |
Actions
This section describes user-triggered updates and system responses.
| Condition | App behavior | SDK output |
|---|---|---|
| Update location | Refresh results | Updated result set |
| Change visit type | Apply constraint | Updated result set |
| Apply filters | Update results | Filtered result set |
| Reset filters | Restore defaults | Default result set |
| Apply sort | Reorder results | Sorted result set |
| Switch view | Change display mode | No data change |
| Select doctor | Open details | Navigation |
| Select availability | Start booking | Appointment flow |
Endpoint Resources
Doctor List
PUT
v3/doctors
Provides the doctor list page with the provided context and criteria.
Highlight Profile Revision
PATCH
v3/doctors/highlight-card
Highlight a doctor card and corresponding map marker. Clear the previous highlight and set a new one.
Update Doctor List by Location Type
PATCH
v3/doctors/update
Update the doctor list after changing primary selection parameters.