psr2 fixes to prior commit
[openemr.git] / library / pnotes.inc
blob3886da49358404919a9ca94afedb98d87149162b
1 <?php
2 /**
3  * This file contains functions for handling notes attached to patient files.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * 2013-02-08 EMR Direct: changes to allow notes added by background-services with pid=0
11  */
14 /**
15  * Retrieve a note, given its ID
16  *
17  * @param string $id the ID of the note to retrieve.
18  * @param string $cols A list of columns to retrieve. defaults to '*' for all.
19  */
20 function getPnoteById($id, $cols = "*")
22     return sqlQuery("SELECT $cols FROM pnotes WHERE id=? " .
23     ' AND deleted != 1 '. // exclude ALL deleted notes
24     'order by date DESC limit 0,1', array($id));
27 /**
28  * Get the patient notes for the given user.
29  *
30  * This function is used to retrieve notes assigned to the given user, or
31  * optionally notes assigned to any user.
32  *
33  * @param string $activity 0 for deleted notes, 1 (the default) for active
34  *                         notes, or 'All' for all.
35  * @param string $show_all whether to display only the selected user's
36  *                         messages, or all users' messages.
37  * @param string $user The user whom's notes you want to retrieve.
38  * @param bool $count Whether to return a count, or just return 0.
39  * @param string $sortby A field to sort results by. (options are users.lname,patient_data.lname,pnotes.title,pnotes.date,pnotes.message_status) (will default to users.lname)
40  * @param string $sortorder whether to sort ascending or descending.
41  * @param string $begin what row to start retrieving results from.
42  * @param string $listnumber number of rows to return.
43  * @return int The number of rows retrieved, or 0 if $count was true.
44  */
45 function getPnotesByUser($activity = "1", $show_all = "no", $user = '', $count = false, $sortby = '', $sortorder = '', $begin = '', $listnumber = '')
48   // Set the activity part of query
49     if ($activity=='1') {
50         $activity_query = " pnotes.message_status != 'Done' AND pnotes.activity = 1 AND ";
51     } else if ($activity=='0') {
52         $activity_query = " (pnotes.message_status = 'Done' OR pnotes.activity = 0) AND ";
53     } else { //$activity=='all'
54         $activity_query = " ";
55     }
57   // Set whether to show chosen user or all users
58     if ($show_all == 'yes') {
59         $usrvar='_%';
60     } else {
61         $usrvar=$user;
62     }
64   // run the query
65   // 2013-02-08 EMR Direct: minor changes to query so notes with pid=0 don't disappear
66     $sql = "SELECT pnotes.id, pnotes.user, pnotes.pid, pnotes.title, pnotes.date, pnotes.message_status,
67           IF(pnotes.pid = 0 OR pnotes.user != pnotes.pid,users.fname,patient_data.fname) as users_fname,
68           IF(pnotes.pid = 0 OR pnotes.user != pnotes.pid,users.lname,patient_data.lname) as users_lname,
69           patient_data.fname as patient_data_fname, patient_data.lname as patient_data_lname
70           FROM ((pnotes LEFT JOIN users ON pnotes.user = users.username)
71           LEFT JOIN patient_data ON pnotes.pid = patient_data.pid) WHERE $activity_query
72           pnotes.deleted != '1' AND pnotes.assigned_to LIKE ?";
73     if (!empty($sortby) || !empty($sortorder)  || !empty($begin) || !empty($listnumber)) {
74         $sql .= " order by ".escape_sql_column_name($sortby, array('users','patient_data','pnotes'), true).
75             " ".escape_sort_order($sortorder).
76             " limit ".escape_limit($begin).", ".escape_limit($listnumber);
77     }
79     $result = sqlStatement($sql, array($usrvar));
81   // return the results
82     if ($count) {
83         if (sqlNumRows($result) != 0) {
84             $total = sqlNumRows($result);
85         } else {
86             $total = 0;
87         }
89         return $total;
90     } else {
91         return $result;
92     }
95 function getPnotesByDate(
96     $date,
97     $activity = "1",
98     $cols = "*",
99     $pid = "%",
100     $limit = "all",
101     $start = 0,
102     $username = '',
103     $docid = 0,
104     $status = "",
105     $orderid = 0
106 ) {
108     $sqlParameterArray = array();
109     if ($docid) {
110         $sql = "SELECT $cols FROM pnotes AS p, gprelations AS r " .
111         "WHERE p.date LIKE ? AND r.type1 = 1 AND " .
112         "r.id1 = ? AND r.type2 = 6 AND p.id = r.id2 AND p.pid != p.user";
113         array_push($sqlParameterArray, '%'.$date.'%', $docid);
114     } else if ($orderid) {
115         $sql = "SELECT $cols FROM pnotes AS p, gprelations AS r " .
116         "WHERE p.date LIKE ? AND r.type1 = 2 AND " .
117         "r.id1 = ? AND r.type2 = 6 AND p.id = r.id2 AND p.pid != p.user";
118         array_push($sqlParameterArray, '%'.$date.'%', $orderid);
119     } else {
120         $sql = "SELECT $cols FROM pnotes AS p " .
121         "WHERE date LIKE ? AND pid LIKE ? AND p.pid != p.user";
122         array_push($sqlParameterArray, '%'.$date.'%', $pid);
123     }
125     $sql .= " AND deleted != 1"; // exclude ALL deleted notes
126     if ($activity != "all") {
127         if ($activity == '0') {
128             // only return inactive
129             $sql .= " AND (activity = '0' OR message_status = 'Done') ";
130         } else { // $activity == '1'
131             // only return active
132             $sql .= " AND activity = '1' AND message_status != 'Done' ";
133         }
134     }
136     if ($username) {
137         $sql .= " AND assigned_to LIKE ?";
138         array_push($sqlParameterArray, $username);
139     }
141     if ($status) {
142         $sql .= " AND message_status IN ('".str_replace(",", "','", add_escape_custom($status))."')";
143     }
145     $sql .= " ORDER BY date DESC";
146     if ($limit != "all") {
147         $sql .= " LIMIT ".escape_limit($start).", ".escape_limit($limit);
148     }
150     $res = sqlStatement($sql, $sqlParameterArray);
152     $all=array();
153     for ($iter = 0; $row = sqlFetchArray($res); $iter++) {
154         $all[$iter] = $row;
155     }
157     return $all;
160 // activity can only be 0, 1, or 'all'
161 function getSentPnotesByDate(
162     $date,
163     $activity = "1",
164     $cols = "*",
165     $pid = "%",
166     $limit = "all",
167     $start = 0,
168     $username = '',
169     $docid = 0,
170     $status = "",
171     $orderid = 0
172 ) {
174     $sqlParameterArray = array();
175     if ($docid) {
176         $sql = "SELECT $cols FROM pnotes AS p, gprelations AS r " .
177         "WHERE p.date LIKE ? AND r.type1 = 1 AND " .
178         "r.id1 = ? AND r.type2 = 6 AND p.id = r.id2 AND p.pid = p.user";
179         array_push($sqlParameterArray, '%'.$date.'%', $docid);
180     } else if ($orderid) {
181         $sql = "SELECT $cols FROM pnotes AS p, gprelations AS r " .
182         "WHERE p.date LIKE ? AND r.type1 = 2 AND " .
183         "r.id1 = ? AND r.type2 = 6 AND p.id = r.id2 AND p.pid = p.user";
184         array_push($sqlParameterArray, '%'.$date.'%', $orderid);
185     } else {
186         $sql = "SELECT $cols FROM pnotes AS p " .
187         "WHERE date LIKE ? AND pid LIKE ? AND p.pid = p.user";
188         array_push($sqlParameterArray, '%'.$date.'%', $pid);
189     }
191     $sql .= " AND deleted != 1"; // exclude ALL deleted notes
192     if ($activity != "all") {
193         if ($activity == '0') {
194             // only return inactive
195             $sql .= " AND (activity = '0' OR message_status = 'Done') ";
196         } else { // $activity == '1'
197             // only return active
198             $sql .= " AND activity = '1' AND message_status != 'Done' ";
199         }
200     }
202     if ($username) {
203         $sql .= " AND assigned_to LIKE ?";
204         array_push($sqlParameterArray, $username);
205     }
207     if ($status) {
208         $sql .= " AND message_status IN ('".str_replace(",", "','", add_escape_custom($status))."')";
209     }
211     $sql .= " ORDER BY date DESC";
212     if ($limit != "all") {
213         $sql .= " LIMIT ".escape_limit($start).", ".escape_limit($limit);
214     }
216     $res = sqlStatement($sql, $sqlParameterArray);
218     $all=array();
219     for ($iter = 0; $row = sqlFetchArray($res); $iter++) {
220         $all[$iter] = $row;
221     }
223     return $all;
226 function getPatientNotes($pid = '', $limit = '', $offset = 0, $search = '')
228     if ($limit) {
229         $limit = "LIMIT ".escape_limit($offset).", ".escape_limit($limit);
230     }
232     $sql = "
233     SELECT
234       p.id,
235       p.date,
236       p.user,
237       p.title,
238       REPLACE(
239         p.body,
240         '-patient-',
241         CONCAT(pd.fname, ' ', pd.lname)
242       ) AS body,
243       p.message_status,
244       'Message' as `type`
245     FROM
246       pnotes AS p
247       LEFT JOIN patient_data AS pd
248         ON pd.id = p.pid
249     WHERE assigned_to = '-patient-'
250       AND p.deleted != 1
251       AND p.pid = ?
252       $search
253     ORDER BY `date` desc
254     $limit
255   ";
256     $res = sqlStatement($sql, array($pid));
257     for ($iter = 0; $row = sqlFetchArray($res); $iter++) {
258         $all[$iter] = $row;
259     }
261     return $all;
264 function getPatientNotifications($pid = '', $limit = '', $offset = 0, $search = '')
266     if ($limit) {
267         $limit = "LIMIT ".escape_limit($offset).", ".escape_limit($limit);
268     }
270     $sql = "
271     SELECT
272       pr.id,
273       date_created AS `date`,
274       'Patient Reminders' AS `user`,
275       due_status AS title,
276       CONCAT(lo.title, ':', lo2.title) AS body,
277       '' as message_status,
278       'Notification' as `type`
279     FROM
280       patient_reminders AS pr
281       LEFT JOIN list_options AS lo
282         ON lo.option_id = pr.category
283         AND lo.list_id = 'rule_action_category' AND lo.activity = 1
284       LEFT JOIN list_options AS lo2
285         ON lo2.option_id = pr.item
286         AND lo2.list_id = 'rule_action' AND lo2.activity = 1
287     WHERE pid = ?
288       AND active = 1
289       AND date_created > DATE_SUB(NOW(), INTERVAL 1 MONTH)
290       $search
291     ORDER BY `date` desc
292     $limit
293   ";
294     $res = sqlStatement($sql, array($pid));
295     for ($iter = 0; $row = sqlFetchArray($res); $iter++) {
296         $all[$iter] = $row;
297     }
299     return $all;
302 function getPatientSentNotes($pid = '', $limit = '', $offset = 0, $search = '')
304     if ($limit) {
305         $limit = "LIMIT ".escape_limit($offset).", ".escape_limit($limit);
306     }
308     $sql = "
309     SELECT
310       p.id,
311       p.date,
312       p.assigned_to,
313       p.title,
314       REPLACE(
315         p.body,
316         '-patient-',
317         CONCAT(pd.lname, ' ', pd.fname)
318       ) AS body,
319       p.activity,
320       p.message_status,
321       'Message' as `type`
322     FROM
323       pnotes AS p
324       LEFT JOIN patient_data AS pd
325         ON pd.id = p.pid
326     WHERE `user` = ?
327       AND p.deleted != 1
328       AND p.pid = ?
329       AND p.message_status != 'Done'
330       $search
331     ORDER BY `date` desc
332     $limit
333   ";
334     $res = sqlStatement($sql, array($pid,$pid));
335     for ($iter = 0; $row = sqlFetchArray($res); $iter++) {
336         $all[$iter] = $row;
337     }
339     return $all;
342 // activity can be 0, 1, or 'all'
343 function getPnotesByPid($pid, $activity = "1", $cols = "*", $limit = 10, $start = 0)
345     if ($activity == '1') {
346         // return only active
347         $res = sqlStatement("SELECT $cols FROM pnotes WHERE pid LIKE ? " .
348           "AND activity = '1' ".
349           " AND message_status != 'Done' ".
350           " AND deleted != 1 ".
351           " ORDER BY date DESC LIMIT ".escape_limit($start).",".escape_limit($limit), array($pid));
352     } else if ($activity == '0') {
353         // return only inactive
354         $res = sqlStatement("SELECT $cols FROM pnotes WHERE pid LIKE ? " .
355           "AND (activity = '0' ".
356           " OR message_status = 'Done') ".
357           " AND deleted != 1 ".
358           " ORDER BY date DESC LIMIT ".escape_limit($start).",".escape_limit($limit), array($pid));
359     } else { // $activity == "all"
360         // return both active and inactive
361         $res = sqlStatement("SELECT $cols FROM pnotes WHERE pid LIKE ? " .
362           " AND deleted != 1 ".
363           " ORDER BY date DESC LIMIT ".escape_limit($start).",".escape_limit($limit), array($pid));
364     }
366     for ($iter = 0; $row = sqlFetchArray($res); $iter++) {
367         $all[$iter] = $row;
368     }
370     return $all;
373 /** Add a note to a patient's medical record.
375  * @param int $pid the ID of the patient whos medical record this note is going to be attached to.
376  * @param string $newtext the note contents.
377  * @param int $authorized
378  * @param int $activity
379  * @param string $title
380  * @param string $assigned_to
381  * @param string $datetime
382  * @param string $message_status
383  * @param string $background_user if set then the pnote is created by a background-service rather than a user
384  * @return int the ID of the added note.
385  */
386 function addPnote(
387     $pid,
388     $newtext,
389     $authorized = '0',
390     $activity = '1',
391     $title = 'Unassigned',
392     $assigned_to = '',
393     $datetime = '',
394     $message_status = 'New',
395     $background_user = ""
396 ) {
398     if (empty($datetime)) {
399         $datetime = date('Y-m-d H:i:s');
400     }
402   // make inactive if set as Done
403     if ($message_status == 'Done') {
404         $activity = 0;
405     }
407     $user = ($background_user!="" ? $background_user : $_SESSION['authUser']);
408     $body = date('Y-m-d H:i') . ' (' . $user;
409     if ($assigned_to) {
410         $body .= " to $assigned_to";
411     }
413     $body = $body . ') ' . $newtext;
415     return sqlInsert(
416         'INSERT INTO pnotes (date, body, pid, user, groupname, ' .
417         'authorized, activity, title, assigned_to, message_status) VALUES ' .
418         '(?, ?, ?, ?, ?, ?, ?, ?, ?, ?)',
419         array($datetime, $body, $pid, $user, $_SESSION['authProvider'], $authorized, $activity, $title, $assigned_to, $message_status)
420     );
423 function addMailboxPnote(
424     $pid,
425     $newtext,
426     $authorized = '0',
427     $activity = '1',
428     $title = 'Unassigned',
429     $assigned_to = '',
430     $datetime = '',
431     $message_status = "New"
432 ) {
434     if (empty($datetime)) {
435         $datetime = date('Y-m-d H:i:s');
436     }
438   // make inactive if set as Done
439     if ($message_status == "Done") {
440         $activity = 0;
441     }
443     $body = date('Y-m-d H:i') . ' (' . $pid;
444     if ($assigned_to) {
445         $body .= " to $assigned_to";
446     }
448     $body = $body . ') ' . $newtext;
450     return sqlInsert(
451         "INSERT INTO pnotes (date, body, pid, user, groupname, " .
452         "authorized, activity, title, assigned_to, message_status) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)",
453         array($datetime, $body, $pid, $pid, 'Default', $authorized, $activity, $title, $assigned_to, $message_status)
454     );
457 function updatePnote($id, $newtext, $title, $assigned_to, $message_status = "")
459     $row = getPnoteById($id);
460     if (! $row) {
461         die("updatePnote() did not find id '".text($id)."'");
462     }
464     $activity = $assigned_to ? '1' : '0';
466   // make inactive if set as Done
467     if ($message_status == "Done") {
468         $activity = 0;
469     }
471     $body = $row['body'] . "\n" . date('Y-m-d H:i') .
472     ' (' . $_SESSION['authUser'];
473     if ($assigned_to) {
474         $body .= " to $assigned_to";
475     }
477     $body = $body . ') ' . $newtext;
479     if ($message_status) {
480         sqlStatement(
481             "UPDATE pnotes SET " .
482             "body = ?, activity = ?, title= ?, " .
483             "assigned_to = ?, message_status = ? WHERE id = ?",
484             array($body, $activity, $title, $assigned_to, $message_status, $id)
485         );
486     } else {
487         sqlStatement(
488             "UPDATE pnotes SET " .
489             "body = ?, activity = ?, title= ?, " .
490             "assigned_to = ? WHERE id = ?",
491             array($body, $activity, $title, $assigned_to, $id)
492         );
493     }
496 function updatePnoteMessageStatus($id, $message_status)
498     if ($message_status == "Done") {
499         sqlStatement("update pnotes set message_status = ?, activity = '0' where id = ?", array($message_status, $id));
500     } else {
501         sqlStatement("update pnotes set message_status = ?, activity = '1' where id = ?", array($message_status, $id));
502     }
506  * Set the patient id in an existing message where pid=0
507  * @param $id the id of the existing note
508  * @param $patient_id the patient id to associate with the note
509  * @author EMR Direct <http://www.emrdirect.com/>
510  */
511 function updatePnotePatient($id, $patient_id)
513     $row = getPnoteById($id);
514     if (! $row) {
515         die("updatePnotePatient() did not find id '".text($id)."'");
516     }
518     $activity = $assigned_to ? '1' : '0';
520     $pid = $row['pid'];
521     if ($pid != 0 || (int)$patient_id < 1) {
522         die("updatePnotePatient invalid operation");
523     }
525     $pid = (int) $patient_id;
526     $newtext = "\n" . date('Y-m-d H:i') . " (patient set by " . $_SESSION['authUser'] .")";
527     $body = $row['body'] . $newtext;
529     sqlStatement("UPDATE pnotes SET pid = ?, body = ? WHERE id = ?", array($pid, $body, $id));
532 function authorizePnote($id, $authorized = "1")
534     sqlQuery("UPDATE pnotes SET authorized = ? WHERE id = ?", array ($authorized,$id));
537 function disappearPnote($id)
539     sqlStatement("UPDATE pnotes SET activity = '0', message_status = 'Done' WHERE id=?", array($id));
540     return true;
543 function reappearPnote($id)
545     sqlStatement("UPDATE pnotes SET activity = '1', message_status = IF(message_status='Done','New',message_status) WHERE id=?", array($id));
546     return true;
549 function deletePnote($id)
551     sqlStatement("UPDATE pnotes SET deleted = '1' WHERE id=?", array($id));
552     return true;