Personal tools

The Reminders API

From OpenEMR Project Wiki

Jump to: navigation, search

Contents

Using the Reminders API

The Reminders API is a series of functions for handling simple messages attached to a 'due date'. These may be sent to onesself, or to other users in OpenEMR.

Including Reminders Functionality

The Reminders API is available in OpenEMR by including the following line in your code:

require_once($GLOBALS['srcdir'].'/dated_reminder_functions.php');

This loads up all of the functions for dealing with reminders.

Access Controls

The Reminders API requires no priviledge levels in OpenEMR. Anyone who can login can use the interface to message anyone else.

Functions Available

GetDueReminderCount

This function is used to get a count of the number of reminders due for a specified user.

Arguments

  • $days_to_show: the number of days after today to search for a result.
    $today: today's date, EG: the output of strtotime(date('Y/m/d')).
    $userID: an optional user. defaults to the current logged in user.

Returns

returns a count of the reminders due.