Skip to main content

Appointment List


Use the Appointment List screen to present all appointments linked to a doctor’s profile.
Each appointment appears as a card that displays session metadata, patient details, and a status indicator.
The doctor can review appointments, apply filters, refresh the list, and download report data.


This screen includes:

  • Sections labeled Current and History.
  • Filters for Status and Date Range.
  • A Refresh icon that updates the displayed list.
  • A Download icon that exports appointments as a .xlsx file.
  • Appointment cards that include:
    • Session date and time.
    • Patient name and date of birth.
    • Visit type.
    • A status badge (Green, Yellow, Red, or Blue).

Workflow

View Appointments

  1. From the Welcome screen, select Manage Appointments.
  2. Review appointments in the Current or History section.
  3. Select a card to view its details.
    → See Appointment Details.

Filter Appointments

  1. Select the Filter icon.
  2. Select one or more Statuses or specify a Date Range.
  3. Select Apply filters to update the displayed appointments. → See Filter.

Refresh Appointment List

  1. Select the Refresh icon.
  2. The app displays updated appointment states and newly available sessions.ons.

Download as Excel

  1. Select the Download icon.
  2. The app downloads an .xlsx file that contains appointment records.

Validations

These scenarios show how the app validates data for the Appointment List screen and what integrators can expect from the SDK.

ScenarioApp BehaviorSDK Output
The filter set contains no values.The app disables Apply filters.No update set.
The user reaches the scroll threshold.The app loads additional appointment cards.Returns a PATCH update set that adds more cards.
A required field is missing on an appointment card.The app blocks card rendering and displays an error page.Schema validation error.
The export request exceeds the allowed size.The app blocks the download and displays an error.Application-level error.
A status badge contains an invalid color.The card is blocked from rendering.Validation error for invalid values.

Actions

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

ScenarioApp BehaviorSDK OutputIntegration Notes
The doctor selects Refresh.The app retrieves the latest appointment data.Returns a page object or an update set.Partners can observe update events at higher integration levels.
The doctor applies a filter set.The app displays only matching appointments.Returns an update set.The backend enforces filter rules.
The doctor scrolls to the end of the list.The app loads more appointments.Returns additional card objects through a PATCH update.Mobile and desktop variants share the same data source.
The doctor selects a card.The app opens Appointment Details.Emits a navigation event.Embedded navigation applies on desktop.
The doctor selects Download.The app provides an .xlsx export.Endpoint returns a binary file.Partners can store or process the file as needed.

Endpoint Resources

Export appointments (Excel)

GET 

/profile/appointments/all/download.xlsx

Returns an .xlsx file that contains appointment data in a report format.


Appointment List Screen

PUT 

/profile/appointments

Produces the Appointment List page for the doctor.
A successful response returns a complete page object that follows the internal Put Response Format and defines the full layout of the appointment list.

VariantBehaviorExample
Mobile variantOpens as a full-screen view.
Desktop variantLoads in the right-hand embed panel (welcome-or-details) of the Appointments screen.

UI Element Types

LevelReferenceTypeValuePlacement
M-1walk-inToolbar[Walk-in]
M-1filterToolbar[Filter]
M-1downloadToolbar[Download]
M-1refreshToolbar[Refresh]
M-1account-detailsToolbar[Account]
D-1filterSecondaryFilter
D-1spacerSpacer~100%
D-1downloadLink[Download]~
D-1refreshLink[Refresh]~
D-1appointment-list-scrollerScroller
2appointment-card~[appointment-revision-id]Card
3patient-full-nameSectionPatient name
3spacerSpacer~
3countCount~
3birthdayExtraDate of birth
3visit-type-date-timeRegularType, date, time
3doctor-nameRegularDoctor name (if multiple doctors accessible)
3appointment-card-statusRed, Blue, Green, YellowAppointment status (or Yellow, Red, Blue)

Load additional appointments

PATCH 

/profile/appointments/load-more

Returns additional appointment cards as a Patch Response Format update set.
Supports infinite scrolling on mobile and desktop.


Update Appointment List

PATCH 

/profile/appointments/update

Updates the appointment list using filters and marker references to refresh the displayed appointment cards.

Returns updates that modify appointment cards, filter values, or internal markers.
The response follows the internal Patch Response Format.