Appointment Reminder Module

We are currently looking for 2-3 beta testers to try out the new Appointment Reminder module for the FreePBX Distro. This is a professional module and is only availiable for the FreePBX Distro. Testers will recieve a free beta copy of the module.

What is it?
The Appointment Reminder module for the FreePBX Distro is a unique way to automate appointment confirmations, cancellations and reschedules. By simply specifing numbers and names to be called the PBX will automatically call at specified times and allow recipients to confirm / cancel / reschedule appointments. The module gives you the flexibility to control all details of the calls from rate limiting to retry attempts and days ahead to notify of an appointment. You have the ability to simply load a CSV list of numbers to call, or even add numbers and names manually. On the fly modifications can be made to any Appointment Reminder list to allow for total flexibility.

Let's take a look at an example
You work for a Doctors Office. Currently you have a full time staff member who spends half of every work day on the phone calling patients to remind them of there upcoming apppointments. You realize that this is inefficient and would like to automate the process. To achieve your automation goal we will utilize the Appointment Reminder module in FreePBX Distro. We will setup our Appointment Reminder to call patients two days in advance of there scheduled appointment and get a confirmation from them. If the reminder is unable to reach the patient it will call again to attempt to remind them. We will also allow the recipient to cancel the appointment or reschedule it directly from the Appointment Reminder call.

Here is the setup
First we will launch the Appointment Reminder module. This module can be found under the Modules / System Administration section. Once you have opened the Appointment Reminder module you will see a screen similar to the following image. Note: Each item is an Appointment Reminder that has already been setup. The first time you launch this module your's will be blank.
AR

The first item that we need to set is the Maximum Calls. This is the total number of concurrent calls that will go out at once. To avoid overloading your call capacity it is suggested to set this to a lower number. In our example we will be setting it to ONE concurrent call.
Next we want to create our new Appointment Reminder. From the right hand navigation menu select the Add A Reminder option.
AR
You will now be taken to the setup screen. This will allow you to specify the options for your Appointment Reminder. For our example here are the settings that we have used.
AR
  • Name - This is the unique name for our Appointment Reminder. We have entered Dr Office Demo.
  • Enabled - We have set this to YES. That means that the Appointment Reminder will run as scheduled. Note: You can easily disable an Appointment Reminder by simply toggling this option to NO.
  • Daily Start Time - Here we set the Time of day that we want the Appointment Reminder to start. We have set our's to 9am.
  • Daily End Time - This is the time of day we want our Appointment Reminder to stop. We have set this examples to 4pm.
  • Max Advance Notice - This is the field that we will use to select how many days ahead of the scheduled appointment we would like to place a reminder call. We have selected 2 days.
  • Retry Count - Here we can tell the Appointment Reminder how many times to retry a recipient if it is unable to reach them. In our example we have set this retry count to two.
  • Retry Delay - We can use this field to specify how long between a failed attempt to retry and reach that recipient. We have set our retry delay to 3 hours. Note that if the 3 hour retry land's after the appointment reminders daily endtime the reminder will be attempted again the following day.
  • TTS Engine - This is the text to speech engine used. Unless you are an advanced use this should be set to the default of flite.
  • Fixed Caller ID - This is the phone number that the call should appear to come from. For our example we are using the Doctor's Office main number for easy identification by the recipients.
  • Caller ID Name - This is the name that should be used for internal reminders.
  • Outbound CID Mode - We can set this to Fixed to use what we have specified or default to use the system default.

Now we need to setup our Call Flow Options. Here are the settings that we used for our example.
AR

  • Initial Greeting - This is the first message played to the recipient. You can record a custom greeting if you would like or use the default however be sure to include a message similar to the following: "This is an Appointment Reminder....". We have elected to use the default.
  • Say Name - Select whether you would like the recipients name to be said. If selected it will use Text To Speech to read the name of the person associated with the reminder. We have set this to yes.
  • Date Announcement - We have elected to use the default announcement which says: "You have an appointment scheduled on...".
  • Say Appointment Date - This is selected to enable or disable the Date announcement from the previous step. We have selected Yes.
  • Instructions - You can use default or custom instructions for the recipient. We have elected the default which say: "To confirm this appointment press ONE, to cancel press TWO, to request you appointment be rescheduled press THREE". You can record a custom message to be played here, however it must follow the outline listed above.
  • Customer Service Extension - This is the destination a recipient is sent to if they select ZERO for customer service. We have routed our demo to our operators extension.
  • Rechedule Behavior - This is what happens if the recipient selects THREE to have there appointment rescheduled. We can elect to either have the call transfered or simply log the action for a call back. We have selected Transfer.
  • Rechedule Extension - This is only used if the Reschedule Behavior in the previous step is set to Transfer. We have our example being re-routed to a queue that contains our scheduling staff.
Daily Report is an automated report sent everyday with the results of your Appointment Reminder. This will show you what appointments have been a success and which have been rescheduled etc.
  • Daily Report Completion Emails - These are the email addresses that will be sent the daily report. In our example we have specified the office manager.
  • Email From - This is the email address that the report will appear to come from.
  • Attach As - You can select either a CSV or Plain Text file.

We will now click Save to save our new Appointment Reminder.

Manage Recipients
We are now automatically taken to the recipients section. This is where we will specify the recipients of the Appointment Reminder. The first thing you will notice at the top is the bulk upload tool. This is a great way to upload multiple recipients quickly.

First we we need to create our CSV file. We use excel or some other editor to create our file in this format.
AR

Once saved as a CSV we will select Choose File and then select our newly created CSV. Once it is selected we can choose our action which will be the default of appending to an existing list, since our list is blank this new data will be all that is there.

AR

We can now select Upload. If we created our CSV properly we will now see the following data populate under the Recipient List section.
AR
We have properly formated our CSV and we see that all the names, numbers and appointment data is correct! However we now remember that we forgot to add one recipient to our list. We can easily add that recipient in the NEW field.

AR
Simply click save after inputting the additional recipient's information.

AR
We can see that the recipient has been added to our list!

The Appointment Reminder module is the latest new Professional module that will be availiable for the FreePBX Distro. I welcome your feedback in the comments section.
FreePBX: