Suggested Scheduling

---

Use Suggested Scheduling to manage alternative appointment schedules.

The Doctor App presents this component from these appointment workflows:

• Review and Approve
• Offer Appointment
• Alternative Offer

Each alternative identifies a doctor profile and location. An alternative can also include a date and time.

---

Component Behavior

• Supports up to three alternatives.
• Identifies each alternative by alternative-id.
• Supports doctor profile, location, date, and time values.
• Updates an alternative after a field change.
• Removes a selected alternative.
• Returns PATCH update sets for the active screen.

---

Workflow

1. Open Suggested Scheduling from a supported appointment workflow.
2. Review the available alternatives.
3. Change the doctor, location, date, or time for an alternative.
4. Apply the returned PATCH update set to the active screen.
5. Remove an alternative when required.
6. Apply the returned PATCH update set after removal.

---

Validations

Scenario	App behavior	SDK output
Appointment ID is missing or invalid	Reject the request	Error response
Alternative ID is missing	Reject the request	Error response
Required profile value is missing	Reject the change request	Error response
Required location value is missing	Reject the change request	Error response
Change request succeeds	Update the affected screen elements	PATCH update set
Delete request succeeds	Remove the selected alternative	PATCH update set
Request returns 405	Display an application error	Error response

Actions

Scenario	App behavior	SDK output
Doctor profile changes	Update the selected alternative	PATCH update set
Location changes	Update the selected alternative	PATCH update set
Date changes	Update the selected alternative	PATCH update set
Time changes	Update the selected alternative	PATCH update set
Alternative is deleted	Remove the selected alternative	PATCH update set

SDK Reference

The endpoints use indexed query parameters to associate values with a specific alternative.

The suffix after ~ identifies the applicable alternative.

For example:

alternative-id=2
profile-id~2=123
location-id~2=456
date~2=2026-08-07
time~2=14:30

---

Endpoint Resources

Change Scheduling​

PATCH 

v3/appointments/{appointment-id}/scheduling/change

Returns an update set that updates a scheduling alternative when a field value changes.

Delete Scheduling

PATCH 

v3/appointments/{appointment-id}/scheduling/delete/appointments/{'{'}appointment-id{'}'}/scheduling/delete

Returns an update set that removes the specified scheduling alternative.