Skip to main content

Appointment List

Use the Appointment List screen to view appointments for the current patient. Each card displays doctor details, visit information, status, and available actions.


This screen includes:

  • A section titled Upcoming Appointments with a calendar icon.
  • A See all link that opens the full appointment list.
  • Appointment cards with: * Doctor image.
  • Doctor name.
  • Appointment date and time.
  • Visit type label such as Video.

Workflow​

  1. Open the Home screen.
  2. Select Appointments.
  3. Select Current or History.

Review Appointments​

  1. Review the appointment cards.
  2. Select a card to open the appointment details screen.

Refresh the Appointment List​

  1. Select Refresh.
  2. Review the updated cards.

Validations​

These scenarios describe how the app validates appointment list data and what the SDK returns.

ScenarioApp BehaviorSDK Output
A card contains no doctor name.The app reserves the name line and renders no value.Page renders an empty name field.
A specialty value exists.The app renders the specialty line.Page renders the specialty field.
No specialty value exists.The app hides the specialty line.Field omitted.
A patient name exists.The app prefixes Patient:.Prefixed value renders.
A confirmed time exists.The app renders the confirmed time.Time value renders.
A time window exists without a confirmed time.The app renders the time window.Time window renders.
No time value exists.The app hides the time group.Time group omitted.
An early on-demand visit exists.The app renders Within 1 hour.Label renders.
The time is tentative.The app renders no Change label.No indicator renders.
The visit type is video or home.The app renders the visit-type label.Location value renders.
The visit type is clinic with name and address.The app renders clinic name and address.Location values render.
A video visit fee exists.The app renders the configured fee without extra-fee notes.Fee value renders.
An on-demand video visit exists.The app renders the on-demand fee note.Note renders.
A valid status color exists.The app renders the status badge using the configured color.Badge value renders.

Actions​

These scenarios describe how the app responds to user actions and what the SDK emits.

ScenarioApp BehaviorSDK Output
The user selects Refresh.The app reloads the appointment list.Page object or update set.
The user scrolls to the end of the list.The app loads additional appointment cards.Update set that appends cards.
The user selects an appointment card.The app opens appointment details.Navigation instruction or event.
The user views available actions.The app enables applicable actions.Action definitions render.

Endpoint resources​

Appointment List​

PUT 

/patient/appointments

This endpoint returns the appointment list screen configuration for the current patient.

Load More Previous Appointments​

PATCH 

/patient/appointments/load-more

Use this endpoint to load additional previous appointments through pagination. The response returns an update set that appends appointments to the currently open page.

Update Appointment List​

PATCH 

/patient/appointments/update

Use this endpoint to update appointment cards that already appear in the appointment list. The response returns an update set that refreshes the referenced cards on the currently open page.