Skip to main content

Alternative Appointment Offer


Use Approve Alternative Offer to review and approve an alternative appointment offer.



This screen includes:

#ElementDescription
1HeaderDisplays title, refresh, and filter actions
2Offer noticePrompts the user to review the offer
3Offer detailsDisplays doctor, specialty, date, time, clinic, and patient
4Change statusMarks the offer as changed
5View alternativeOpens other options
6More infoOpens offer details

Workflow

  1. Open the appointment approval screen.
  2. Render available appointment offers.
  3. Select one offer.
  4. Approve the selected offer or refuse all offers.
  5. Refresh the appointment state.
Offer selection

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

ScenarioApp BehaviorSDK Output
No offer selectedDisable Approve actionselection = required
One offer availableApply implicit selectionselectedOfferId = <id>
Multiple offers availableRequire offer selectionselection = required
Offer selectedEnable Approve actionselectedOfferId = <id>
Offer unavailableDisable offer cardoffer = unavailable
Approval rejectedDisplay error statestate = error
Refusal rejectedDisplay error statestate = error

Actions

ScenarioApp BehaviorSDK Output
Approval screen openedLoad appointment offersPUT /api/v3/appointments/{appointment-id}/approve
Offer selectedUpdate selected offerPATCH /api/v3/appointments/{appointment-id}/approve/select
Different offer selectedReplace selected offerselectedOfferId = updated
Approve selectedApprove selected offerPOST /api/v3/appointments/{appointment-id}/approve
Refuse All selectedRefuse all offersrefusal = submitted
Back selectedReturn without changesstate = unchanged
Refusal behavior

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 alternative offers for the specified appointment.

Select Card

PATCH 

v3/appointments/{appointment-id}/approve/select

Selects the offer card for approval.

Approve Offer

POST 

v3/appointments/{appointment-id}/approve

Approves the appointment offer with the selected alternative.