1. Overview

In Personal Community, members can manage their appointments both on the Home page and on the Appointments  page. On the Home page, members can view details about their upcoming appointment (if they have one). This includes the date, time, address, and the option to download a calendar event to add the appointment to another calendar application. On the Appointments page, they can view both upcoming and past (or cancelled) appointments, which are in separate tabular views. Patients have the option to use telehealth for their appointment needs.

2. Filtering the Appointment List

The appointments presented within the appointment lists can be filtered as needed. The filter can adjust the appointments that are present in the list as well as the actions that are available.  This section describes the default appointment filter in Personal Community and the steps required to implement a custom appointment filter. 

2.1. Default Appointment List Behavior

The default, HSPortal.EHR.BaseFilters   class is the configured Appointments Filter Class . This class does not filter out any appointments. See Creating a Custom Class for Appointment Filtering for information on extending this class to filter the appointment lists. 

By default, there is a 15 minute grace period before appointments transition from the Upcoming Appointments list to the Past Appointments list. During this grace period patients can select Join if a meeting link is available for the appointment, or select Pay if a payment link is available for the appointment. The actions available for appointments can be modified through logic updates in a custom appointment filter class. See Creating a Custom Class for Appointment Filtering for creating the custom class. 

2.2. Creating a Custom Class for Appointment Filtering

To create a custom class for filtering appointments, complete the following steps:

1. In the appropriate namespace for your portal, create a class that extends the   HSPortal.EHR.BaseFilters   class. If an extension already exists, open it for editing.

2.  In that subclass, override the %FilterAppointments method. This method is called once for each appointment in the appointment list. For each appointment, the method should return:
   1. 1 to exclude that appointment from the list.
   2. 0 to include that appointment in the list.
3. If desired, you can additionally modify the following fields within  %FilterAppointments to further customize an appointment:
   1. pAppointment.PaymentLink –  Controls the button to Pay, if payment link is present. If empty, no payment link will appear. 
   2. pAppointment.MeetingLink – Controls the button to Join a meeting link, if a link is present. If empty, no telehealth link will appear. 
   3. pAppointment.GracePeriodEnd – Modify  this value to override the   Grace Period   setting in the Workbench for the associated appointment. 
   4. pAppointment.PaymentLink  and pAppointment.MeetingLink  can all be modified specifically within the grace period. To modify this action only during the grace period, first verify that the current date and time are earlier than pAppointment.GracePeriodEnd . See the following example:

   5. // convert all times to seconds for comparison
      Set tSecsInDay = 24 * 60 * 60
      Set tNowSec = ($piece($horolog,",",1) * tSecsInDay) + $piece($horolog,",",2)
      Set tApptSec = (pAppointment.Date * tSecsInDay) + pAppointment.Time
      Set tGraceH = $zdatetimeh(pAppointment.GracePeriodEnd, 3)
      Set tGraceSec = ($piece(tGraceH,",",1) * tSecsInDay) + $piece(tGraceH,",",2)
            
      // check if the current time is in the grace period
      If (tNowSec >= tApptSec) && (tNowSec <= tGraceSec) {
      	Set pAppointment.MeetingLink = ""
      	Set pAppointment.PaymentLink = ""
      }
      

4. Save your custom class.
5. Set your custom class as the Appointments Filter Class in the Appointments section of the Workbench, as described in Enabling Appointments in the Workbench.

3. Enabling Appointments in the Workbench

4. Enabling Pre-Payment of Services