Filter

---

Use the Appointment Filter screen to refine the appointment list by patient or session attributes.
The filter panel appears as an overlay on the Appointments screen.

This screen includes:

• Text fields:
  • Reference number
  • Doctor or clinic
  • Patient name
  • Date of birth
• A multiselect list for appointment status
• Start date and End date fields
• Apply and Reset actions
• A quick filter bar for common statuses
• An optional sort panel for recommended order or appointment date
• Conditional logic that limits available values
• Field-level validation
• A Close action that dismisses the panel

---

Workflow

This sequence describes how the doctor uses the Appointment Filter screen.

1. Select the Filter icon in the Appointments toolbar.
2. Enter one or more filter criteria:
   • Reference number (digits only)
   • Start date and End date
   • Doctor or clinic name
   • Patient name
   • Date of birth (YYYY-MM-DD)
   • Status: New requests, Offered appointments, Scheduled, After visit, Cancelled / Refused
3. Select Apply to refine the appointment list.
4. Review the updated results.
5. Select Reset to clear all values and restore the default view.

---

Validations

These scenarios define how the app validates filter input.

Scenario	App Behavior	SDK Output	Example
No filter values exist.	The app disables Apply.	No update set.	—
The end date occurs before the start date.	The app blocks submission and highlights the date fields.	Field-level validation error.
A status value is not part of the defined list.	The app blocks selection.	Validation error.	—
The date of birth value occurs in the future.	The app blocks submission and highlights the field.	Validation error.
The reference number contains a non-digit character.	The app blocks submission.	Validation error.	—

Actions

These scenarios describe how the screen behaves and the output the SDK returns.

Scenario	App Behavior	SDK Output	Example
The doctor selects Apply.	The app filters the appointment list.	Returns an update set that reflects the filtered results.	—
The doctor selects Reset.	The app clears all fields and restores the default list.	Returns an update set that restores the unfiltered list.
The doctor selects Close.	The panel closes without modifying active filters.	No update set.	—
Multiple values are selected.	The app applies the selected criteria together.	Returns a combined update set.
A sort order is selected.	The app displays appointments in the selected order.	Returns an update set that reflects the new sort.	—

---

Endpoint Resources

Appointment Filter Screen

PUT 

/profile/appointments/filter

Produces the Appointment Filter screen.
A successful response returns a page object that follows the internal Put Response Format and defines the filter panel layout and available field values.

Platform Variants

Variant	Behavior	Example
Mobile	Opens as a full-screen overlay with vertically stacked fields. Tapping outside closes the panel.	(see below)
Desktop	Displays as a left-side panel with compact spacing. Filtering updates the list in real time.	(see below)

Mobile:

Desktop:

UI Element Types

Level	Reference	Type	Value	Placement
1	reference	Edit	Reference no.
1	start-date	Date	Start date
1	end-date	Date	End date
1	profile-id	Combo	Profile name
1	patient-name	Edit	Patient name
1	patient-birthday	Date	Date of birth
1	status-group	Multiselect	Status (values: New requests, Offered appointments, Scheduled appointments, After visit, Cancelled / Refused)
1	reset	Secondary	Reset
1	apply	Button	Apply Filter	~

---

Reset Filter

PATCH 

/profile/appointments/filter/reset

Resets all filter values to their default state.
A successful response returns an update set that restores the unfiltered appointment list.

Apply Appointment Filter​

POST 

/profile/appointments/filter

Applies the selected filter criteria and returns the filtered appointments.

Parameters

Name	Type	Required	Description
reference	String	No	Unique appointment reference number.
start-date	Date	No	Start of the search range. Uses the doctor's time zone.
end-date	Date	No	End of the search range. Uses the doctor's time zone.
profile	Integer	No	Unique identifier for the doctor's profile.
patient-name	String	No	Patient name.
patient-date-of-birth	Date	No	Patient's date of birth.
status-group	List<Enum>	No	Appointment status group. Valid values: new-requests, offered-appointments, scheduled-appointments, after_visit, cancelled
location-type	List<Enum>	No	Visit type. Valid values: home, clinic, video

Errors

Code	Description
FIELDS_VALIDATION_ERROR	One or more required fields are invalid.