Skip to main content

Appointment History


Use the Appointments screen to access active and historical appointment records.
The History tab renders appointments in terminal states and presents them in read-only format.

This screen includes

  • Appointment status banner, for example The appointment took place.
  • Appointment date.
  • Doctor name.
  • Specialty and country.
  • Read-only presentation with no edit or action controls.
note

Appointments appear in reverse chronological order, with the most recent item first.


Workflow

  1. The user opens Appointments from the bottom navigation.
  2. The Current tab loads by default.
  3. The user selects History.
  4. The SDK retrieves appointments in terminal states.
  5. The screen renders appointment cards sorted by startTime descending.
  6. Selecting a card (if enabled) opens appointment details in read-only mode.

Validations

ScenarioApp behavior
Status equals completed.The card appears in History with banner “The appointment took place.”
When status is canceled.The banner displays “The request was canceled.”
For offer_canceled status.The banner displays “The offer was canceled.”
If the status is non-terminal.The appointment appears in the Current tab only.
In any terminal state.The card renders as read-only without modification controls.
When provider visibility restricts the doctor’s name.The backend pseudonym renders.
If the doctor’s name is available.The provider display name renders.
When no historical appointments exist.The History tab shows an empty state message.
If no active appointments exist.The Current tab shows an empty state message.
Upon session expiration before load.Rendering stops and navigation redirects to login.

Actions

ScenarioApp behavior
On selection of the History tab.The SDK filters appointments to completed, canceled, and offer_canceled.
Switching to the Current tab.The SDK filters appointments to non-terminal states.
When the history list exceeds the default page size.The system loads additional records incrementally.
During pagination.Sorting remains by startTime in descending order across pages.
As history cards render.Each card uses appointmentId, status, startTime, doctorDisplayName, specialty, and country.
When a history card is selected.Appointment details open in read-only mode.
If a user attempts modification from History.No edit, cancel, or reschedule controls appear.
At list render time.Dates format using device locale derived from startTime.

Endpoint Resources

PATCH 

Get Previous Appointments

v3/appointments/load-more

Loads more previous appointments with pagination.