Alternative Appointment Offer
Use Approve Alternative Offer to select one alternative appointment offer or refuse all offers.
Available offers, selected state, and actions derive from the appointment approval response.
This screen includes:
| # | Element | Description |
|---|---|---|
| 1 | Header | Displays screen title and back navigation |
| 2 | Offer list | Displays available appointment offers |
| 3 | Offer card | Displays doctor, visit type, date, time, location, and cost |
| 4 | Selection control | Marks the selected offer |
| 5 | Approve action | Approves the selected offer |
| 6 | Refuse All action | Refuses all appointment offers |
Workflow
- Open the appointment approval screen.
- Render available appointment offers.
- Select one offer.
- Approve the selected offer or refuse all offers.
- Refresh the appointment state.
Only one offer can be selected at a time. Selecting another offer clears the previous selection. When only one offer exists, the platform can return it as the selected offer.
Validations
| Scenario | App Behavior | SDK Output |
|---|---|---|
| No offer selected | Disable Approve action | selection = required |
| One offer available | Apply implicit selection | selectedOfferId = <id> |
| Multiple offers available | Require offer selection | selection = required |
| Offer selected | Enable Approve action | selectedOfferId = <id> |
| Offer unavailable | Disable offer card | offer = unavailable |
| Approval rejected | Display error state | state = error |
| Refusal rejected | Display error state | state = error |
Actions
| Scenario | App Behavior | SDK Output |
|---|---|---|
| Approval screen opened | Load appointment offers | PUT /api/v3/appointments/{appointment-id}/approve |
| Offer selected | Update selected offer | PATCH /api/v3/appointments/{appointment-id}/approve/select |
| Different offer selected | Replace selected offer | selectedOfferId = updated |
| Approve selected | Approve selected offer | POST /api/v3/appointments/{appointment-id}/approve |
| Refuse All selected | Refuse all offers | refusal = submitted |
| Back selected | Return without changes | state = unchanged |
If you refuse all offers, the appointment remains unscheduled.
The clinic may send new alternatives or contact you for further coordination.
Endpoint Resources
Approve Alternative Offer
PUT
v3/appointments/{appointment-id}/approve
Displays the alternative offers screen for the appointment.
Select Alternative Appointment Offer Card
PATCH
v3/appointments/{appointment-id}/approve/select
Selects the offer card for approval.
Approve Alternative Appointment Offer
POST
v3/appointments/{appointment-id}/approve
Approves the appointment offer with the selected alternative.