Skip to main content

For Edit


Use the Edit Appointment Time screen to select a new date, time, or location for an existing appointment.


Edit Appointment Time screen with provider details and calendar options

This screen includes:

#ElementDescription
1HeaderDisplays the title and navigation controls
2Provider cardDisplays provider and visit details
3Date tabsDisplays available dates
4Calendar actionOpens the calendar
5CalendarDisplays available dates
6Selected dateIdentifies the current selection
7Month navigationChanges the displayed month
8Clear actionRemoves the selected date
9Today actionDisplays the current date
10Time optionsDisplays available times
11Location optionsDisplays available locations
12Continue actionConfirms the selection

Workflow

  1. Open the appointment edit flow.
  2. Request the time and location screen.
  3. Select an available date.
  4. Select a time and location.
  5. Choose Select time.

Validations

ScenarioApp behaviorSDK output
Appointment ID is invalidDisplay an errorerror = invalid_appointment_id
No dates are availableDisplay an empty stateavailability = empty
Selected date is unavailablePrevent selectionavailability = unavailable
No time slots are availableDisplay an empty statetimeSlots = empty
No locations are availableDisplay an empty statelocations = empty
Required selection is missingDisable Continuestate = incomplete
Request succeedsDisplay the screenstatus = 200
Request failsDisplay an errorstatus = 405

Actions

ScenarioApp behaviorSDK output
Screen openedRequest schedule optionsPUT /api/v3/appointments/{appointment-id}/time
Date selectedUpdate the selected dateselectedDate = updated
Time selectedUpdate the selected timeselectedTime = updated
Location selectedUpdate the selected locationselectedLocation = updated
Clear selectedRemove the selected dateselectedDate = null
Continue selectedContinue the edit flownavigation = continue
Back selectedReturn to the previous screennavigation = back

Endpoint Resources

For Edit

PUT 

v3/appointments/{appointment-id}/time

Returns the time and location selection screen for an existing appointment.