Patient Reminder Queue
The Patient Reminder Queue is a scheduled job used to:
- queue patient reminders for sending
- cancel reminders that are no longer applicable.
It should be scheduled to run daily, preferably outside of business hours.
On completion, reminders may be manually sent via Reporting - Reminders.
Email and SMS reminders may be automatically sent by the Patient Reminder Sender.
Queueing
Reminders are selected for queueing if they have:
- a Next Due Date less than or equal to the current date; and
- an In Progress status; and
- no associated Items with Pending or Error status
It will cancel reminders if:
- the patient is deceased or inactive; or
- the Next Due Date + the Reminder Type's Cancel Time is less than the current date
For each reminder that matches the criteria, one or more Patient Reminder Items will be created according to its Reminder Type's rules, and the associated customer's contacts.
Note that the queue is not rebuilt each time the job runs. Reminders that have been previously added to the queue are left unaltered. This does mean that if you change say the Lead Times, reminders already in the queue will not affected.
The fields are as follows:
Name | The job name |
Description | The job description |
Active | This schedules the job to run if checked, or prevents it from being run if unchecked. |
Minutes | See Cron Expression |
Hours | See Cron Expression |
Day Of Month | See Cron Expression |
Month | See Cron Expression |
Day Of Week | See Cron Expression |
Run As |
Specifies the user to run the job as. This user is required to have permissions to:
|
Notify | Specifies the user or user group to notify when queuing has completed. Notification only occurs when at least one reminder has been queued or cancelled, or an error has occurred. You may want to use a 'real' user or group of real users, or you may want to create a user such as 'Reminder Jobs Message Receiver' used only for these notifications. |
Cron Expression
The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run, using a simplified version of a Cron expression:
Field | Allowed Values | Allowed Special Characters |
---|---|---|
Minutes | 0-59 | , - * / |
Hours | 0-23 | , - * / |
Day Of Month | 1-31 | , - * ? / |
Month | 1-12 or JAN-DEC | , - * / |
Day Of Week | 1-7 or SUN-SAT | , - * ? / |
Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.
If you change the schedule, the new schedule will take effect immediately.
Examples
Description | Minutes | Hours | Day Of Month | Month | Day Of Week |
---|---|---|---|---|---|
Run at 5am every day | 0 | 5 | ? | * | * |
Run at 7:30 on weekdays | 30 | 7 | ? | * | mon-fri |