library/reminders.php

   1 <?php
   2 /**
   3  * Patient reminders functions.
   4  *
   5  * These functions should not ever attempt to write to
   6  * session variables, because the session_write_close() function
   7  * is typically called before utilizing these functions.
   8  *
   9  * Functions for collection/displaying/sending patient reminders. This is
  10  * part of the CDR engine, which can be found at library/clinical_rules.php.
  11  *
  12  * Copyright (C) 2010-2012 Brady Miller <brady@sparmy.com>
  13  *
  14  * LICENSE: This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  21  * GNU General Public License for more details.
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program. If not, see <http://opensource.org/licenses/gpl-license.php>;.
  24  *
  25  * @package OpenEMR
  26  * @author  Brady Miller <brady@sparmy.com>
  27  * @link    http://www.open-emr.org
  28  */
  29
  30 /**
  31  * Include the main CDR engine library, email class and maviq class
  32  */
  33 require_once(dirname(__FILE__) . "/clinical_rules.php");
  34 require_once(dirname(__FILE__) . "/classes/postmaster.php");
  35 require_once(dirname(__FILE__) . "/maviq_phone_api.php");
  36
  37 // This is only pertinent for users of php versions less than 5.2
  38 //  (ie. this wrapper is only loaded when php version is less than
  39 //   5.2; otherwise the native php json functions are used)
  40 require_once(dirname(__FILE__) . "/jsonwrapper/jsonwrapper.php");
  41
  42 /**
  43  * Display the patient reminder widget.
  44  *
  45  * @param  integer  $patient_id  pid of selected patient
  46  * @param  string   $dateTarget  target date (format Y-m-d H:i:s). If blank then will test with current date as target.
  47  */
  48 function patient_reminder_widget($patient_id,$dateTarget='') {
  49
  50   // Set date to current if not set
  51   $dateTarget = ($dateTarget) ? $dateTarget : date('Y-m-d H:i:s');
  52
  53   // Update reminders for patient
  54   update_reminders($dateTarget, $patient_id);
  55
  56   // Fetch the active reminders
  57   $listReminders = fetch_reminders($patient_id);
  58
  59   if (empty($listReminders)) {
  60     // No reminders to show.
  61     echo htmlspecialchars( xl('No active patient reminders.'), ENT_NOQUOTES);
  62     return;
  63   }
  64
  65   echo "<table cellpadding='0' cellspacing='0'>";
  66   foreach ($listReminders as $reminder) {
  67     echo "<tr><td style='padding:0 1em 0 1em;'><span class='small'>";
  68       // show reminder label
  69       echo generate_display_field(array('data_type'=>'1','list_id'=>'rule_action_category'),$reminder['category']) .
  70         ": " . generate_display_field(array('data_type'=>'1','list_id'=>'rule_action'),$reminder['item']);
  71     echo "</span></td><td style='padding:0 1em 0 1em;'><span class='small'>";
  72       // show reminder due status
  73       echo generate_display_field(array('data_type'=>'1','list_id'=>'rule_reminder_due_opt'),$reminder['due_status']);
  74     echo "</span></td><td style='padding:0 1em 0 1em;'><span class='small'>";
  75       // show reminder sent date
  76       if (empty($reminder['date_sent'])) {
  77         echo htmlspecialchars( xl('Reminder Not Sent Yet'), ENT_NOQUOTES);
  78       }
  79       else {
  80         echo htmlspecialchars( xl('Reminder Sent On').": ".$reminder['date_sent'], ENT_NOQUOTES);
  81       }
  82     echo "</span></td></tr>";
  83   }
  84   echo "</table>";
  85 }
  86
  87 /**
  88  * Function to update reminders via a batching method to improve performance and decrease memory overhead.
  89  *
  90  * Function that updates reminders and returns an array with a specific data structure.
  91  * <pre>The data structure of the return array includes the following elements
  92  *  'total_active_actions'         - Number of active actions.
  93  *  'total_pre_active_reminders'   - Number of active reminders before processing.
  94  *  'total_pre_unsent_reminders'   - Number of unsent reminders before processing.
  95  *  'total_post_active_reminders'  - Number of active reminders after processing.
  96  *  'total_post_unsent_reminders'  - Number of unsent reminders after processing.
  97  *  'number_new_reminders'         - Number of new reminders
  98  *  'number_updated_reminders'     - Number of updated reminders (due_status change)
  99  *  'number_inactivated_reminders' - Number of inactivated reminders.
 100  *  'number_unchanged_reminders'   - Number of unchanged reminders.
 101  * </pre>
 102  *
 103  * @param  string   $dateTarget  target date (format Y-m-d H:i:s). If blank then will test with current date as target.
 104  * @param  integer  $batchSize   number of patients to batch (default is 25; plan to optimize this default setting in the future)
 105  * @param  integer  $report_id   id of report in database (if already bookmarked)
 106  * @param  boolean  $also_send   if TRUE, then will also call send_reminder when done
 107  * @return array                 see above for data structure of returned array
 108  */
 109 function update_reminders_batch_method($dateTarget='', $batchSize=25, $report_id=NULL, $also_send=FALSE) {
 110
 111   // Default to a batchsize, if empty
 112   if (empty($batchSize)) {
 113     $batchSize=25;
 114   }
 115
 116   // Collect total number of pertinent patients (to calculate batching parameters)
 117   $totalNumPatients = buildPatientArray('','','',NULL,NULL,TRUE);
 118
 119   // Cycle through the batches and collect/combine results
 120   if (($totalNumPatients%$batchSize) > 0) {
 121     $totalNumberBatches = floor($totalNumPatients/$batchSize) + 1;
 122   }
 123   else {
 124     $totalNumberBatches = floor($totalNumPatients/$batchSize);
 125   }
 126
 127   // Prepare the database to track/store results
 128   if ($also_send) {
 129     $report_id = beginReportDatabase("process_send_reminders",'',$report_id);
 130   }
 131   else {
 132     $report_id = beginReportDatabase("process_reminders",'',$report_id);
 133   }
 134   setTotalItemsReportDatabase($report_id,$totalNumPatients);
 135
 136   $patient_counter=0;
 137   for ($i=0;$i<$totalNumberBatches;$i++) {
 138     $patient_counter = $batchSize*($i+1);
 139     if ($patient_counter > $totalNumPatients) $patient_counter = $totalNumPatients;
 140     $update_rem_log_batch = update_reminders($dateTarget,'',(($batchSize*$i)+1),$batchSize);
 141     if ($i == 0) {
 142       // For first cycle, simply copy it to update_rem_log
 143       $update_rem_log = $update_rem_log_batch;
 144     }
 145     else {
 146       // Debug statements
 147       //error_log("CDR: ".print_r($update_rem_log,TRUE),0);
 148       //error_log("CDR: ".($batchSize*$i). " records",0);
 149
 150       // Integrate batch results into main update_rem_log
 151       $update_rem_log['total_active_actions'] = $update_rem_log['total_active_actions'] + $update_rem_log_batch['total_active_actions'];
 152       $update_rem_log['total_pre_active_reminders'] = $update_rem_log['total_pre_active_reminders'] + $update_rem_log_batch['total_pre_active_reminders'];
 153       $update_rem_log['total_pre_unsent_reminders'] = $update_rem_log['total_pre_unsent_reminders'] + $update_rem_log_batch['total_pre_unsent_reminders'];
 154       $update_rem_log['number_new_reminders'] = $update_rem_log['number_new_reminders'] + $update_rem_log_batch['number_new_reminders'];
 155       $update_rem_log['number_updated_reminders'] = $update_rem_log['number_updated_reminders'] + $update_rem_log_batch['number_updated_reminders'];
 156       $update_rem_log['number_unchanged_reminders'] = $update_rem_log['number_unchanged_reminders'] + $update_rem_log_batch['number_unchanged_reminders'];
 157       $update_rem_log['number_inactivated_reminders'] = $update_rem_log['number_inactivated_reminders'] + $update_rem_log_batch['number_inactivated_reminders'];
 158       $update_rem_log['total_post_active_reminders'] = $update_rem_log['total_post_active_reminders'] + $update_rem_log_batch['total_post_active_reminders'];
 159       $update_rem_log['total_post_unsent_reminders'] = $update_rem_log['total_post_unsent_reminders'] + $update_rem_log_batch['total_post_unsent_reminders'];
 160     }
 161     //Update database to track results
 162     updateReportDatabase($report_id,$patient_counter);
 163   }
 164
 165   // Create an array for saving to database (allows combining with the send log)
 166   $save_log = array();
 167   $save_log[] = $update_rem_log;
 168
 169   // Send reminders, if this was selected
 170   if ($also_send) {
 171     $log_send = send_reminders();
 172     $save_log[] = $log_send;
 173   }
 174
 175   // Record combo results in database
 176   finishReportDatabase($report_id,json_encode($save_log));
 177
 178   // Just return the process reminders array
 179   return $update_rem_log;
 180 }
 181
 182 /**
 183  * Function to update reminders.
 184  *
 185  * Function that updates reminders and returns an array with a specific data structure.
 186  * <pre>The data structure of the return array includes the following elements
 187  *  'total_active_actions'         - Number of active actions.
 188  *  'total_pre_active_reminders'   - Number of active reminders before processing.
 189  *  'total_pre_unsent_reminders'   - Number of unsent reminders before processing.
 190  *  'total_post_active_reminders'  - Number of active reminders after processing.
 191  *  'total_post_unsent_reminders'  - Number of unsent reminders after processing.
 192  *  'number_new_reminders'         - Number of new reminders
 193  *  'number_updated_reminders'     - Number of updated reminders (due_status change)
 194  *  'number_inactivated_reminders' - Number of inactivated reminders.
 195  *  'number_unchanged_reminders'   - Number of unchanged reminders.
 196  * </pre>
 197  *
 198  * @param  string   $dateTarget  target date (format Y-m-d H:i:s). If blank then will test with current date as target.
 199  * @param  integer  $patient_id  pid of patient. If blank then will check all patients.
 200  * @param  integer  $start       applicable patient to start at (when batching process)
 201  * @param  integer  $batchSize   number of patients to batch (when batching process)
 202  * @return array                 see above for data structure of returned array
 203  */
 204 function update_reminders($dateTarget='', $patient_id='', $start=NULL, $batchSize=NULL) {
 205
 206   $logging = array();
 207
 208   // Set date to current if not set
 209   $dateTarget = ($dateTarget) ? $dateTarget : date('Y-m-d H:i:s');
 210
 211   // Collect reminders (note that this function removes redundant and keeps the most distant
 212   //   reminder (ie. prefers 'past_due' over 'due' over 'soon_due')
 213   // Note that due to a limitation in the test_rules_clinic function, the patient_id is explicitly
 214   //  needed to work correctly. So rather than pass in a '' patient_id to do the entire clinic,
 215   //  we instead need to pass in each patient_id separately.
 216   $collectedReminders = array();
 217   $patient_id_complete = "";
 218   if (!(empty($patient_id))) {
 219     // only one patient id, so run the function
 220     $collectedReminders = test_rules_clinic('','patient_reminder',$dateTarget,'reminders-due',$patient_id);
 221     $patient_id_complete = $patient_id;
 222   }
 223   else {
 224     // as described above, need to pass in each patient_id
 225     // Collect all patient ids
 226     $patientData = buildPatientArray('','','',$start,$batchSize);
 227     for($iter=0; $row=sqlFetchArray($rez); $iter++) {
 228       $patientData[$iter]=$row;
 229     }
 230     $first_flag = TRUE;
 231     foreach ($patientData as $patient) {
 232       // collect reminders
 233       $tempCollectReminders = test_rules_clinic('','patient_reminder',$dateTarget,'reminders-due',$patient['pid']);
 234       $collectedReminders = array_merge($collectedReminders,$tempCollectReminders);
 235       // build the $patient_id_complete variable
 236       if ($first_flag) {
 237         $patient_id_complete .= $patient['pid'];
 238         $first_flag = FALSE;
 239       }
 240       else {
 241         $patient_id_complete .= ",".$patient['pid'];
 242       }
 243     }
 244   }
 245   $logging['total_active_actions'] = count($collectedReminders);
 246
 247   // For logging purposes only:
 248   //  Collect number active of active and unsent reminders
 249   $logging['total_pre_active_reminders'] = count(fetch_reminders($patient_id_complete));
 250   $logging['total_pre_unsent_reminders'] = count(fetch_reminders($patient_id_complete, 'unsent'));
 251
 252   // Migrate reminders into the patient_reminders table
 253   $logging['number_new_reminders'] = 0;
 254   $logging['number_updated_reminders'] = 0;
 255   $logging['number_unchanged_reminders'] = 0;
 256   foreach ($collectedReminders as $reminder) {
 257
 258     // See if a reminder already exist
 259     $sql = "SELECT `id`, `pid`, `due_status`, `category`, `item` FROM `patient_reminders` WHERE " .
 260       "`active`='1' AND `pid`=? AND `category`=? AND `item`=?";
 261     $result = sqlQueryCdrEngine($sql, array($reminder['pid'], $reminder['category'], $reminder['item']) );
 262
 263     if (empty($result)) {
 264       // It does not yet exist, so add a new reminder
 265       $sql = "INSERT INTO `patient_reminders` (`pid`, `due_status`, `category`, `item`, `date_created`) " .
 266         "VALUES (?, ?, ?, ?, NOW())";
 267       sqlStatementCdrEngine($sql, array($reminder['pid'], $reminder['due_status'], $reminder['category'], $reminder['item']) );
 268       $logging['number_new_reminders']++;
 269     }
 270     else {
 271       // It already exist (see if if needs to be updated via adding a new reminder)
 272       if ($reminder['due_status'] == $result['due_status']) {
 273         // No change in due status, so no need to update
 274         $logging['number_unchanged_reminders']++;
 275         continue;
 276       }
 277       else {
 278         // Change in due status, so inactivate current reminder and create a new one
 279         // First, inactivate the previous reminder
 280         $sql = "UPDATE `patient_reminders` SET `active` = '0', `reason_inactivated` = 'due_status_update', " .
 281           "`date_inactivated` = NOW() WHERE `id`=?";
 282         sqlStatementCdrEngine($sql, array($result['id']) );
 283         // Then, add the new reminder
 284         $sql = "INSERT INTO `patient_reminders` (`pid`, `due_status`, `category`, `item`, `date_created`) " .
 285           "VALUES (?, ?, ?, ?, NOW())";
 286         sqlStatementCdrEngine($sql, array($reminder['pid'], $reminder['due_status'], $reminder['category'], $reminder['item']) );
 287       }
 288     }
 289   }
 290
 291   // Inactivate reminders that no longer exist
 292   // Go through each active reminder and ensure it is in the current list
 293   $sqlReminders = fetch_reminders($patient_id_complete);
 294   $logging['number_inactivated_reminders'] = 0;
 295   foreach ( $sqlReminders as $row ) {
 296     $inactivateFlag = true;
 297     foreach ($collectedReminders as $reminder) {
 298       if ( ($row['pid'] == $reminder['pid']) &&
 299            ($row['category'] == $reminder['category']) &&
 300            ($row['item'] == $reminder['item']) &&
 301            ($row['due_status'] == $reminder['due_status']) ) {
 302         // The sql reminder has been confirmed, so do not inactivate it
 303         $inactivateFlag = false;
 304         break;
 305       }
 306     }
 307     if ($inactivateFlag) {
 308       // The sql reminder was not confirmed, so inactivate it
 309       $sql = "UPDATE `patient_reminders` SET `active` = '0', `reason_inactivated` = 'auto', " .
 310         "`date_inactivated` = NOW() WHERE `id`=?";
 311       sqlStatementCdrEngine($sql, array($row['id']) );
 312       $logging['number_inactivated_reminders']++;
 313     }
 314   }
 315
 316   // For logging purposes only:
 317   //  Collect number of active and unsent reminders
 318   $logging['total_post_active_reminders'] = count(fetch_reminders($patient_id_complete));
 319   $logging['total_post_unsent_reminders'] = count(fetch_reminders($patient_id_complete, 'unsent'));
 320
 321   return $logging;
 322 }
 323
 324
 325 /**
 326  * Function to send reminders.
 327  *
 328  * Function that sends reminders and returns an array with a specific data structure.
 329  * <pre>The data structure of the return array includes the following elements
 330  *   'total_pre_unsent_reminders'  - Number of reminders before processing.
 331  *   'total_post_unsent_reminders' - Number of reminders after processing.
 332  *   'number_success_emails'       - Number of successfully sent email reminders.
 333  *   'number_failed_emails'        - Number of failed sent email reminders.
 334  *   'number_success_calls'        - Number of successfully call reminders.
 335  *   'number_failed_calls'         - Number of failed call reminders.
 336  * </pre>
 337  *
 338  * @return array                 see above for data structure of returned array
 339  */
 340 function send_reminders() {
 341
 342   $logging = array();
 343
 344   // Collect active reminders that have not yet been sent.
 345   $active_unsent_reminders = fetch_reminders('', 'unsent');
 346   $logging['total_pre_unsent_reminders'] = count($active_unsent_reminders);
 347
 348   // Send the unsent reminders
 349   $logging['number_success_emails'] = 0;
 350   $logging['number_failed_emails'] = 0;
 351   $logging['number_success_calls'] = 0;
 352   $logging['number_failed_calls'] = 0;
 353   foreach ( $active_unsent_reminders as $reminder ) {
 354
 355     // Collect patient information that reminder is going to.
 356     $sql = "SELECT `fname`, `lname`, `email`, `phone_home`, `hipaa_voice`, `hipaa_allowemail` from `patient_data` where `pid`=?";
 357     $result = sqlQueryCdrEngine($sql, array($reminder['pid']) );
 358         $patientfname = $result['fname'];
 359     $patientlname = $result['lname'];
 360         $patientemail = $result['email'];
 361     $patientphone = $result['phone_home'];
 362     $hipaa_voice = $result['hipaa_voice'];
 363     $hipaa_allowemail = $result['hipaa_allowemail'];
 364
 365     // Email to patient if Allow Email and set reminder sent flag.
 366     if ($hipaa_allowemail == "YES") {
 367       $mail = new MyMailer();
 368           $sender_name = $GLOBALS['patient_reminder_sender_name'];
 369       $email_address = $GLOBALS['patient_reminder_sender_email'];
 370       $mail->FromName = $sender_name;  // required
 371       $mail->Sender = $email_address;    // required
 372       $mail->From = $email_address;    // required
 373       $mail->AddAddress($patientemail, $patientfname.", ".$patientlname);   // required
 374       $mail->AddReplyTo($email_address,$sender_name);  // required
 375       $category_title = generate_display_field(array('data_type'=>'1','list_id'=>'rule_action_category'),$reminder['category']);
 376       $item_title = generate_display_field(array('data_type'=>'1','list_id'=>'rule_action'),$reminder['item']);
 377           $mail->Body = "Dear ".$patientfname.", This is a message from your clinic to remind you of your ".$category_title.": ".$item_title;
 378       $mail->Subject = "Clinic Reminder";
 379       if ($mail->Send()) {
 380         // deal with and keep track of this successful email
 381         sqlStatementCdrEngine("UPDATE `patient_reminders` SET `email_status`='1', `date_sent`=NOW() WHERE id=?", array($reminder['id']) );
 382         $logging['number_success_emails']++;
 383       }
 384       else {
 385         // deal with and keep track of this unsuccesful email
 386         $logging['number_failed_emails']++;
 387       }
 388     }
 389
 390     // Call to patient if Allow Voice Message and set reminder sent flag.
 391     if ($hipaa_voice == "YES") {
 392
 393 /******************************************************************************
 394 *     // Maviq does not work, is not currently supported, and seems to break on windows servers, so this
 395 *     //  feature has been commented out for now.
 396 *     // Automated VOIP service provided by Maviq. Please visit http://signup.maviq.com for more information.
 397 *      $siteId = $GLOBALS['phone_gateway_username'];
 398 *      $token = $GLOBALS['phone_gateway_password'];
 399 *      $endpoint = $GLOBALS['phone_gateway_url'];
 400 *      $client = new MaviqClient($siteId, $token, $endpoint);
 401 *      //Set up params.
 402 *      $data = array(
 403 *        "firstName" => $patientfname,
 404 *        "lastName" => $patientlname,
 405 *        "phone" => $patientphone,
 406 *        //"apptDate" => "$scheduled_date[1]/$scheduled_date[2]/$scheduled_date[0]",
 407 *        "timeRange" => "10-18",
 408 *        "type" => "reminder",
 409 *        "timeZone" => date('P'),
 410 *        "greeting" => str_replace("[[sender]]", $sender_name, str_replace("[[patient_name]]", $patientfname, $myrow['reminder_content']))
 411 *      );
 412 *
 413 *      // Make the call.
 414 *      $response = $client->sendRequest("appointment", "POST", $data);
 415 *
 416 *      if ($response->IsError) {
 417 *        // deal with and keep track of this unsuccessful call
 418 *        $logging['number_failed_calls']++;
 419 *      }
 420 *      else {
 421 *        // deal with and keep track of this succesful call
 422 *        sqlStatementCdrEngine("UPDATE `patient_reminders` SET `voice_status`='1', `date_sent`=NOW() WHERE id=?", array($reminder['id']) );
 423 *        $logging['number_success_calls']++;
 424 *      }
 425 *******************************************************************************/
 426
 427     }
 428   }
 429
 430   // For logging purposes only:
 431   //  Collect active reminders that have not yet been sent.
 432   $logging['total_post_unsent_reminders'] = count(fetch_reminders('', 'unsent'));
 433
 434   return $logging;
 435 }
 436
 437 /**
 438  * Function to fetch reminders.
 439  *
 440  * @param  integer/array  $patient_id  pid(s) of patient(s).
 441  * @param  string         $type        Can choose unsent ('unsent') vs all active (BLANK) reminders
 442  * @param  string         $due_status  due status of reminders (soon_due,due,past_due). If blank, then will return all.
 443  * @param  string         $select      Select component of select statement. If blank, then will return all columns.
 444  * @return array                 Returns an array of reminders.
 445  */
 446 function fetch_reminders($patient_id='',$type='',$due_status='',$select='*') {
 447
 448   $arraySqlBind = array();
 449
 450   if (!empty($patient_id)) {
 451     // check the specified pid(s)
 452     $where = "`pid` IN (".add_escape_custom($patient_id).") AND ";
 453   }
 454
 455   if (!empty($due_status)) {
 456     $where .= "`due_status`=? AND ";
 457     array_push($arraySqlBind,$due_status);
 458   }
 459
 460   if (empty($type)) {
 461     $where .= "`active`='1'";
 462   }
 463   else { // $type == 'unsent'
 464     $where .= "`active`='1' AND `date_sent` IS NULL";
 465   }
 466
 467   $order = "`due_status`, `date_created`";
 468
 469   $sql = "SELECT " . $select . " FROM `patient_reminders` WHERE " .
 470     $where . " ORDER BY " . $order;
 471   $rez = sqlStatementCdrEngine($sql, $arraySqlBind);
 472
 473   $returnval=array();
 474   for($iter=0; $row=sqlFetchArray($rez); $iter++)
 475     $returnval[$iter]=$row;
 476
 477   return $returnval;
 478 }
 479
 480 ?>
 481