library/reminders.php

   1 <?php
   2 // Copyright (C) 2010 Brady Miller <brady@sparmy.com>
   3 //
   4 // This program is free software; you can redistribute it and/or
   5 // modify it under the terms of the GNU General Public License
   6 // as published by the Free Software Foundation; either version 2
   7 // of the License, or (at your option) any later version.
   8
   9 // Functions are kept here that will support reminders.
  10
  11 require_once(dirname(__FILE__) . "/clinical_rules.php");
  12
  13
  14 // Display the patient reminder widget.
  15 // Parameters:
  16 //   $patient_id - pid of selected patient
  17 //   $dateTarget - target date. If blank then will test with current date as target.
  18 function patient_reminder_widget($patient_id,$dateTarget='') {
  19
  20   // Set date to current if not set
  21   $dateTarget = ($dateTarget) ? $dateTarget : date('Y-m-d H:i:s');
  22
  23   // Update reminders for patient
  24   update_reminders($dateTarget, $patient_id);
  25
  26   // Fetch the active reminders
  27   $listReminders = fetch_reminders($patient_id);
  28
  29   if (empty($listReminders)) {
  30     // No reminders to show.
  31     echo htmlspecialchars( xl('No active patient reminders.'), ENT_NOQUOTES);
  32     return;
  33   }
  34
  35   echo "<table cellpadding='0' cellspacing='0'>";
  36   foreach ($listReminders as $reminder) {
  37     echo "<tr><td style='padding:0 1em 0 1em;'><span class='small'>";
  38       // show reminder label
  39       echo generate_display_field(array('data_type'=>'1','list_id'=>'rule_action_category'),$reminder['category']) .
  40         ": " . generate_display_field(array('data_type'=>'1','list_id'=>'rule_action'),$reminder['item']);
  41     echo "</span></td><td style='padding:0 1em 0 1em;'><span class='small'>";
  42       // show reminder due status
  43       echo generate_display_field(array('data_type'=>'1','list_id'=>'rule_reminder_due_opt'),$reminder['due_status']);
  44     echo "</span></td><td style='padding:0 1em 0 1em;'><span class='small'>";
  45       // show reminder sent date
  46       if (empty($reminder['date_sent'])) {
  47         echo htmlspecialchars( xl('Reminder Not Sent Yet'), ENT_NOQUOTES);
  48       }
  49       else {
  50         echo htmlspecialchars( xl('Reminder Sent On').": ".$reminder['date_sent'], ENT_NOQUOTES);
  51       }
  52     echo "</span></td></tr>";
  53   }
  54   echo "</table>";
  55 }
  56
  57 // Function to update reminders.
  58 // Parameters:
  59 //   $dateTarget - target date. If blank then will test with current date as target.
  60 //   $patient_id - pid of patient. If blank then will check all patients.
  61 // Return:
  62 //   Returns a array with following element:
  63 //     'total_active_actions'         - Number of active actions.
  64 //     'total_pre_active_reminders'   - Number of active reminders before processing.
  65 //     'total_pre_unsent_reminders'   - Number of unsent reminders before processing.
  66 //     'total_post_active_reminders'  - Number of active reminders after processing.
  67 //     'total_post_unsent_reminders'   - Number of unsent reminders after processing.
  68 //     'number_new_reminders'         - Number of new reminders
  69 //     'number_updated_reminders'     - Number of updated reminders (due_status change)
  70 //     'number_inactivated_reminders' - Number of inactivated reminders.
  71 //     'number_unchanged_reminders'   - Number of unchanged reminders.
  72 function update_reminders($dateTarget='', $patient_id='') {
  73
  74   $logging = array();
  75
  76   // Set date to current if not set
  77   $dateTarget = ($dateTarget) ? $dateTarget : date('Y-m-d H:i:s');
  78
  79   // Collect reminders (note that this function removes redundant and keeps the most distant
  80   //   reminder (ie. prefers 'past_due' over 'due' over 'soon_due')
  81   $collectedReminders = test_rules_clinic('','patient_reminder',$dateTarget,'reminders',$patient_id);
  82   $logging['total_active_actions'] = count($collectedReminders);
  83
  84   // For logging purposes only:
  85   //  Collect number active of active and unsent reminders
  86   $logging['total_pre_active_reminders'] = count(fetch_reminders($patient_id));
  87   $logging['total_pre_unsent_reminders'] = count(fetch_reminders($patient_id, 'unsent'));
  88
  89   // Migrate reminders into the patient_reminders table
  90   $logging['number_new_reminders'] = 0;
  91   $logging['number_updated_reminders'] = 0;
  92   $logging['number_unchanged_reminders'] = 0;
  93   foreach ($collectedReminders as $reminder) {
  94
  95     // See if a reminder already exist
  96     $sql = "SELECT `id`, `pid`, `due_status`, `category`, `item` FROM `patient_reminders` WHERE " .
  97       "`active`='1' AND `pid`=? AND `category`=? AND `item`=?";
  98     $result = sqlQuery($sql, array($reminder['pid'], $reminder['category'], $reminder['item']) );
  99
 100     if (empty($result)) {
 101       // It does not yet exist, so add a new reminder
 102       $sql = "INSERT INTO `patient_reminders` (`pid`, `due_status`, `category`, `item`, `date_created`) " .
 103         "VALUES (?, ?, ?, ?, NOW())";
 104       sqlStatement($sql, array($reminder['pid'], $reminder['due_status'], $reminder['category'], $reminder['item']) );
 105       $logging['number_new_reminders']++;
 106     }
 107     else {
 108       // It already exist (see if if needs to be updated via adding a new reminder)
 109       if ($reminder['due_status'] == $result['due_status']) {
 110         // No change in due status, so no need to update
 111         $logging['number_unchanged_reminders']++;
 112         continue;
 113       }
 114       else {
 115         // Change in due status, so inactivate current reminder and create a new one
 116         // First, inactivate the previous reminder
 117         $sql = "UPDATE `patient_reminders` SET `active` = '0', `reason_inactivated` = 'due_status_update', " .
 118           "`date_inactivated` = NOW() WHERE `id`=?";
 119         sqlStatement($sql, array($result['id']) );
 120         // Then, add the new reminder
 121         $sql = "INSERT INTO `patient_reminders` (`pid`, `due_status`, `category`, `item`, `date_created`) " .
 122           "VALUES (?, ?, ?, ?, NOW())";
 123         sqlStatement($sql, array($reminder['pid'], $reminder['due_status'], $reminder['category'], $reminder['item']) );
 124       }
 125     }
 126   }
 127
 128   // Inactivate reminders that no longer exist
 129   // Go through each active reminder and ensure it is in the current list
 130   $sqlReminders = fetch_reminders($patient_id);
 131   $logging['number_inactivated_reminders'] = 0;
 132   foreach ( $sqlReminders as $row ) {
 133     $inactivateFlag = true;
 134     foreach ($collectedReminders as $reminder) {
 135       if ( ($row['pid'] == $reminder['pid']) &&
 136            ($row['category'] == $reminder['category']) &&
 137            ($row['item'] == $reminder['item']) &&
 138            ($row['due_status'] == $reminder['due_status']) ) {
 139         // The sql reminder has been confirmed, so do not inactivate it
 140         $inactivateFlag = false;
 141         break;
 142       }
 143     }
 144     if ($inactivateFlag) {
 145       // The sql reminder was not confirmed, so inactivate it
 146       $sql = "UPDATE `patient_reminders` SET `active` = '0', `reason_inactivated` = 'auto', " .
 147         "`date_inactivated` = NOW() WHERE `id`=?";
 148       sqlStatement($sql, array($row['id']) );
 149       $logging['number_inactivated_reminders'] = 0;
 150     }
 151   }
 152
 153   // For logging purposes only:
 154   //  Collect number of active and unsent reminders
 155   $logging['total_post_active_reminders'] = count(fetch_reminders($patient_id));
 156   $logging['total_post_unsent_reminders'] = count(fetch_reminders($patient_id, 'unsent'));
 157
 158   return $logging;
 159
 160 }
 161
 162 // Function to send reminders
 163 // Return:
 164 //   Returns a array with following element:
 165 //     'total_pre_unsent_reminders'  - Number of reminders before processing.
 166 //     'total_post_unsent_reminders' - Number of reminders after processing.
 167 //     'number_success_emails'       - Number of successfully sent email reminders.
 168 //     'number_failed_emails'        - Number of failed sent email reminders.
 169 //     'number_success_calls'        - Number of successfully call reminders.
 170 //     'number_failed_calls'         - Number of failed call reminders.
 171 function send_reminders() {
 172
 173   $logging = array();
 174
 175   // Collect active reminders that have not yet been sent.
 176   $active_unsent_reminders = fetch_reminders($patient_id, 'unsent');
 177   $logging['total_pre_unsent_reminders'] = count($active_unsent_reminders);
 178
 179   // Send the unsent reminders
 180   $logging['number_success_emails'] = 0;
 181   $logging['number_failed_emails'] = 0;
 182   $logging['number_success_calls'] = 0;
 183   $logging['number_failed_calls'] = 0;
 184   foreach ( $active_unsent_reminders as $reminder ) {
 185
 186     // Collect patient information that reminder is going to.
 187     $sql = "SELECT `fname`, `lname`, `email`, `phone_home`, `hipaa_voice`, `hipaa_allowemail` from `patient_data` where `pid`=?";
 188     $result = sqlQuery($sql, array($reminder['pid']) );
 189         $patientfname = $result['fname'];
 190     $patientlname = $result['lname'];
 191         $patientemail = $result['email'];
 192     $patientphone = $result['phone_home'];
 193     $hipaa_voice = $result['hipaa_voice'];
 194     $hipaa_allowemail = $result['hipaa_allowemail'];
 195
 196     // Email to patient if Allow Email and set reminder sent flag.
 197     if ($hipaa_allowemail == "YES") {
 198       $mail = new MyMailer();
 199           $sender_name = $GLOBALS['patient_reminder_sender_name'];
 200       $email_address = $GLOBALS['patient_reminder_sender_email'];
 201       $mail->FromName = $sender_name;  // required
 202       $mail->Sender = $email_address;    // required
 203       $mail->From = $email_address;    // required
 204       $mail->AddAddress($patientemail, $patientfname.", ".$patientlname);   // required
 205       $mail->AddReplyTo($email_address,$sender_name);  // required
 206       $category_title = generate_display_field(array('data_type'=>'1','list_id'=>'rule_action_category'),$reminder['category']);
 207       $item_title = generate_display_field(array('data_type'=>'1','list_id'=>'rule_action'),$reminder['item']);
 208           $mail->Body = "Dear ".$patientfname.", This is a message from your clinic to remind you of your ".$category_title.": ".$item_title;
 209       $mail->Subject = "Clinic Reminder";
 210       if ($mail->Send()) {
 211         // deal with and keep track of this successful email
 212         sqlStatement("UPDATE `patient_reminders` SET `email_status`='1', `date_sent`=NOW() WHERE id=?", array($reminder['id']) );
 213         $logging['number_success_emails']++;
 214       }
 215       else {
 216         // deal with and keep track of this unsuccesful email
 217         $logging['number_failed_emails']++;
 218       }
 219     }
 220
 221     // Call to patient if Allow Voice Message and set reminder sent flag.
 222     if ($hipaa_voice == "YES") {
 223       // Automated VOIP service provided by Maviq. Please visit http://signup.maviq.com for more information.
 224       $siteId = $GLOBALS['phone_gateway_username'];
 225       $token = $GLOBALS['phone_gateway_password'];
 226       $endpoint = $GLOBALS['phone_gateway_url'];
 227       $client = new MaviqClient($siteId, $token, $endpoint);
 228       //Set up params.
 229       $data = array(
 230         "firstName" => $patientfname,
 231         "lastName" => $patientlname,
 232         "phone" => $patientphone,
 233         //"apptDate" => "$scheduled_date[1]/$scheduled_date[2]/$scheduled_date[0]",
 234         "timeRange" => "10-18",
 235         "type" => "reminder",
 236         "timeZone" => date('P'),
 237         "greeting" => str_replace("[[sender]]", $sender_name, str_replace("[[patient_name]]", $patientfname, $myrow['reminder_content']))
 238       );
 239
 240       // Make the call.
 241       $response = $client->sendRequest("appointment", "POST", $data);
 242
 243       if ($response->IsError) {
 244         // deal with and keep track of this unsuccessful call
 245         $logging['number_failed_calls']++;
 246       }
 247       else {
 248         // deal with and keep track of this succesful call
 249         sqlStatement("UPDATE `patient_reminders` SET `voice_status`='1', `date_sent`=NOW() WHERE id=?", array($reminder['id']) );
 250         $logging['number_success_calls']++;
 251       }
 252     }
 253   }
 254
 255   // For logging purposes only:
 256   //  Collect active reminders that have not yet been sent.
 257   $logging['total_post_unsent_reminders'] = count(fetch_reminders($patient_id, 'unsent'));
 258
 259   return $logging;
 260 }
 261
 262 // Function to fetch reminders
 263 // Parameters:
 264 //   $patient_id - pid of patient. If blank then will check all patients.
 265 //   $type       - unsent (unsent) vs all active (BLANK) reminders
 266 //   $due_status - due status of reminders (soon_due,due,past_due). If blank,
 267 //                   then will return all.
 268 //   $select     - Select component of select statement. If blank, then
 269 //                   will return all columns.
 270 // Return:
 271 //   Returns a array of reminders
 272 function fetch_reminders($patient_id='',$type='',$due_status='',$select='*') {
 273
 274   $arraySqlBind = array();
 275
 276   if (!empty($patient_id)) {
 277     $where = "`pid`=? AND ";
 278     array_push($arraySqlBind,$patient_id);
 279   }
 280
 281   if (!empty($due_status)) {
 282     $where .= "`due_status`=? AND ";
 283     array_push($arraySqlBind,$due_status);
 284   }
 285
 286   if (empty($type)) {
 287     $where .= "`active`='1'";
 288   }
 289   else { // $type == 'unsent'
 290     $where .= "`active`='1' AND `date_sent` IS NULL";
 291   }
 292
 293   $order = "`due_status`, `date_created`";
 294
 295   $sql = "SELECT " . $select . " FROM `patient_reminders` WHERE " .
 296     $where . " ORDER BY " . $order;
 297   $rez = sqlStatement($sql, $arraySqlBind);
 298
 299   for($iter=0; $row=sqlFetchArray($rez); $iter++)
 300     $returnval[$iter]=$row;
 301
 302   return $returnval;
 303 }
 304
 305 ?>
 306