3 // Copyright (C) 2011 Ken Chapple
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.
10 // Holds library functions (and hashes) used by the appointment reporting module
14 require_once(dirname(__FILE__
)."/encounter_events.inc.php");
15 require_once(dirname(__FILE__
)."/../interface/main/calendar/modules/PostCalendar/pnincludes/Date/Calc.php");
18 $COMPARE_FUNCTION_HASH = array(
19 'doctor' => 'compareAppointmentsByDoctorName',
20 'patient' => 'compareAppointmentsByPatientName',
21 'pubpid' => 'compareAppointmentsByPatientId',
22 'date' => 'compareAppointmentsByDate',
23 'time' => 'compareAppointmentsByTime',
24 'type' => 'compareAppointmentsByType',
25 'comment' => 'compareAppointmentsByComment',
26 'status' => 'compareAppointmentsByStatus',
27 'completed' => 'compareAppointmentsByCompletedDrugScreen',
28 'trackerstatus' => 'compareAppointmentsByTrackerStatus'
32 'doctor' => array( 'doctor', 'date', 'time' ),
33 'patient' => array( 'patient', 'date', 'time' ),
34 'pubpid' => array( 'pubpid', 'date', 'time' ),
35 'date' => array( 'date', 'time', 'type', 'patient' ),
36 'time' => array( 'time', 'date', 'patient' ),
37 'type' => array( 'type', 'date', 'time', 'patient' ),
38 'comment' => array( 'comment', 'date', 'time', 'patient' ),
39 'status' => array( 'status', 'date', 'time', 'patient' ),
40 'completed' => array( 'completed', 'date', 'time', 'patient' ),
41 'trackerstatus' => array( 'trackerstatus', 'date', 'time', 'patient' ),
44 /*Arrays for the interpretation of recurrence patterns.*/
47 '2' => xl('Every 2nd'),
48 '3' => xl('Every 3rd'),
49 '4' => xl('Every 4th'),
50 '5' => xl('Every 5th'),
51 '6' => xl('Every 6th')
54 $REPEAT_FREQ_TYPE = array(
62 $REPEAT_ON_NUM = array(
70 $REPEAT_ON_DAY = array(
74 '3' => xl('Wednesday'),
75 '4' => xl('Thursday'),
80 function fetchEvents( $from_date, $to_date, $where_param = null, $orderby_param = null, $tracker_board = false, $nextX = 0, $bind_param = null, $query_param = null )
83 $sqlBindArray = array();
87 $query = $query_param;
89 if($bind_param) $sqlBindArray = $bind_param;
96 "((e.pc_endDate >= ? AND e.pc_recurrtype > '0') OR " .
97 "(e.pc_eventDate >= ?))";
99 array_push($sqlBindArray, $from_date, $from_date);
104 "((e.pc_endDate >= ? AND e.pc_eventDate <= ? AND e.pc_recurrtype > '0') OR " .
105 "(e.pc_eventDate >= ? AND e.pc_eventDate <= ?))";
107 array_push($sqlBindArray, $from_date, $to_date, $from_date, $to_date);
111 if ( $where_param ) $where .= $where_param;
113 $order_by = "e.pc_eventDate, e.pc_startTime";
114 if ( $orderby_param ) {
115 $order_by = $orderby_param;
118 // Tracker Board specific stuff
119 $tracker_fields = '';
121 if ($tracker_board) {
122 $tracker_fields = "e.pc_room, e.pc_pid, t.id, t.date, t.apptdate, t.appttime, t.eid, t.pid, t.original_user, t.encounter, t.lastseq, t.random_drug_test, t.drug_screen_completed, " .
123 "q.pt_tracker_id, q.start_datetime, q.room, q.status, q.seq, q.user, " .
124 "s.toggle_setting_1, s.toggle_setting_2, s.option_id, ";
125 $tracker_joins = "LEFT OUTER JOIN patient_tracker AS t ON t.pid = e.pc_pid AND t.apptdate = e.pc_eventDate AND t.appttime = e.pc_starttime AND t.eid = e.pc_eid " .
126 "LEFT OUTER JOIN patient_tracker_element AS q ON q.pt_tracker_id = t.id AND q.seq = t.lastseq " .
127 "LEFT OUTER JOIN list_options AS s ON s.list_id = 'apptstat' AND s.option_id = q.status AND s.activity = 1 " ;
131 "e.pc_eventDate, e.pc_endDate, e.pc_startTime, e.pc_endTime, e.pc_duration, e.pc_recurrtype, e.pc_recurrspec, e.pc_recurrfreq, e.pc_catid, e.pc_eid, e.pc_gid, " .
132 "e.pc_title, e.pc_hometext, e.pc_apptstatus, " .
133 "p.fname, p.mname, p.lname, p.pid, p.pubpid, p.phone_home, p.phone_cell, " .
134 "u.fname AS ufname, u.mname AS umname, u.lname AS ulname, u.id AS uprovider_id, " .
137 "c.pc_catname, c.pc_catid " .
138 "FROM openemr_postcalendar_events AS e " .
140 "LEFT OUTER JOIN facility AS f ON e.pc_facility = f.id " .
141 "LEFT OUTER JOIN patient_data AS p ON p.pid = e.pc_pid " .
142 "LEFT OUTER JOIN users AS u ON u.id = e.pc_aid " .
143 "LEFT OUTER JOIN openemr_postcalendar_categories AS c ON c.pc_catid = e.pc_catid " .
145 "ORDER BY $order_by";
147 if($bind_param) $sqlBindArray = array_merge($sqlBindArray, $bind_param);
152 ///////////////////////////////////////////////////////////////////////
153 // The following code is from the calculateEvents function in the //
154 // PostCalendar Module modified and inserted here by epsdky //
155 ///////////////////////////////////////////////////////////////////////
159 $res = sqlStatement($query, $sqlBindArray);
164 $resNotNull = (isset($res) && $res != null);
167 while ($event = sqlFetchArray($res)) {
169 if($nextX) $stopDate = $event['pc_endDate'];
170 else $stopDate = ($event['pc_endDate'] <= $to_date) ?
$event['pc_endDate'] : $to_date;
173 switch($event['pc_recurrtype']) {
183 $event_recurrspec = @unserialize
($event['pc_recurrspec']);
185 $rfreq = $event_recurrspec['event_repeat_freq'];
186 $rtype = $event_recurrspec['event_repeat_freq_type'];
187 $exdate = $event_recurrspec['exdate'];
189 list($ny,$nm,$nd) = explode('-',$event['pc_eventDate']);
190 // $occurance = Date_Calc::dateFormat($nd,$nm,$ny,'%Y-%m-%d');
191 $occurance = $event['pc_eventDate'];
193 while($occurance < $from_date) {
194 $occurance =& __increment($nd,$nm,$ny,$rfreq,$rtype);
195 list($ny,$nm,$nd) = explode('-',$occurance);
198 while($occurance <= $stopDate) {
201 if (isset($exdate)) {
202 foreach (explode(",", $exdate) as $exception) {
203 // occurrance format == yyyy-mm-dd
204 // exception format == yyyymmdd
205 if (preg_replace("/-/", "", $occurance) == $exception) {
211 if ($excluded == false) {
212 $event['pc_eventDate'] = $occurance;
213 $event['pc_endDate'] = '0000-00-00';
218 if($incX == $nextX) break;
223 $occurance =& __increment($nd,$nm,$ny,$rfreq,$rtype);
224 list($ny,$nm,$nd) = explode('-',$occurance);
233 $event_recurrspec = @unserialize
($event['pc_recurrspec']);
235 $rfreq = $event_recurrspec['event_repeat_on_freq'];
236 $rnum = $event_recurrspec['event_repeat_on_num'];
237 $rday = $event_recurrspec['event_repeat_on_day'];
238 $exdate = $event_recurrspec['exdate'];
240 list($ny,$nm,$nd) = explode('-',$event['pc_eventDate']);
242 if(isset($event_recurrspec['rt2_pf_flag']) && $event_recurrspec['rt2_pf_flag']) $nd = 1;
244 $occuranceYm = "$ny-$nm"; // YYYY-mm
245 $from_dateYm = substr($from_date,0,7); // YYYY-mm
246 $stopDateYm = substr($stopDate,0,7); // YYYY-mm
248 // $nd will sometimes be 29, 30 or 31 and if used in the mktime functions below
249 // a problem with overflow will occur so it is set to 1 to avoid this (for rt2
250 // appointments set prior to fix $nd remains unchanged). This can be done since
251 // $nd has no influence past the mktime functions.
252 while($occuranceYm < $from_dateYm) {
253 $occuranceYmX = date('Y-m-d',mktime(0,0,0,$nm+
$rfreq,$nd,$ny));
254 list($ny,$nm,$nd) = explode('-',$occuranceYmX);
255 $occuranceYm = "$ny-$nm";
258 while($occuranceYm <= $stopDateYm) {
263 $occurance = Date_Calc
::NWeekdayOfMonth($dnum--,$rday,$nm,$ny,$format="%Y-%m-%d");
264 } while($occurance === -1);
266 if($occurance >= $from_date && $occurance <= $stopDate) {
269 if (isset($exdate)) {
270 foreach (explode(",", $exdate) as $exception) {
271 // occurrance format == yyyy-mm-dd
272 // exception format == yyyymmdd
273 if (preg_replace("/-/", "", $occurance) == $exception) {
279 if ($excluded == false) {
281 $event['pc_eventDate'] = $occurance;
282 $event['pc_endDate'] = '0000-00-00';
287 if($incX == $nextX) break;
295 $occuranceYmX = date('Y-m-d',mktime(0,0,0,$nm+
$rfreq,$nd,$ny));
296 list($ny,$nm,$nd) = explode('-',$occuranceYmX);
297 $occuranceYm = "$ny-$nm";
309 ////////////////////// End of code inserted by epsdky
312 function fetchAllEvents( $from_date, $to_date, $provider_id = null, $facility_id = null )
314 $sqlBindArray = array();
318 if ( $provider_id ) {
319 $where .= " AND e.pc_aid = ?";
320 array_push($sqlBindArray, $provider_id);
323 if ( $facility_id ) {
324 $where .= " AND e.pc_facility = ? AND u.facility_id = ?";
325 array_push($sqlBindArray, $facility_id, $facility_id);
328 $appointments = fetchEvents( $from_date, $to_date, $where, null, false, 0, $sqlBindArray );
329 return $appointments;
332 //Support for therapy group appointments added by shachar z.
333 function fetchAppointments( $from_date, $to_date, $patient_id = null, $provider_id = null, $facility_id = null, $pc_appstatus = null, $with_out_provider = null, $with_out_facility = null, $pc_catid = null, $tracker_board = false, $nextX = 0, $group_id = null, $patient_name = null)
335 $sqlBindArray = array();
339 if ( $provider_id ) {
340 $where .= " AND e.pc_aid = ?";
341 array_push($sqlBindArray, $provider_id);
345 $where .= " AND e.pc_pid = ?";
346 array_push($sqlBindArray, $patient_id);
347 } elseif ( $group_id ) {
348 //if $group_id this means we want only the group events
349 $where .= " AND e.pc_gid = ? AND e.pc_pid = ''";
350 array_push($sqlBindArray, $group_id);
352 $where .= " AND e.pc_pid != ''";
355 if ( $facility_id ) {
356 $where .= " AND e.pc_facility = ?";
357 array_push($sqlBindArray, $facility_id);
360 //Appointment Status Checking
361 if ($pc_appstatus != '') {
362 $where .= " AND e.pc_apptstatus = ?";
363 array_push($sqlBindArray, $pc_appstatus);
366 if ($pc_catid != null) {
367 $where .= " AND e.pc_catid = ?";
368 array_push($sqlBindArray, $pc_catid);
371 if ($patient_name != null) {
372 $where .= " AND (p.fname LIKE CONCAT('%',?,'%') OR p.lname LIKE CONCAT('%',?,'%'))";
373 array_push($sqlBindArray, $patient_name, $patient_name);
376 //Without Provider checking
377 if ($with_out_provider != '') {
378 $where .= " AND e.pc_aid = ''";
381 //Without Facility checking
382 if ($with_out_facility != '') {
383 $where .= " AND e.pc_facility = 0";
386 $appointments = fetchEvents( $from_date, $to_date, $where, '', $tracker_board, $nextX, $sqlBindArray );
387 return $appointments;
390 //Support for therapy group appointments added by shachar z.
391 function fetchNextXAppts($from_date, $patient_id, $nextX = 1, $group_id = null) {
394 $nextXAppts = array();
395 $appts = fetchAppointments( $from_date, null, $patient_id, null, null, null, null, null, null, false, $nextX, $group_id);
397 $appts = sortAppointments($appts);
398 $nextXAppts = array_slice($appts, 0, $nextX);
404 // get the event slot size in seconds
405 function getSlotSize()
407 if ( isset( $GLOBALS['calendar_interval'] ) ) {
408 return $GLOBALS['calendar_interval'] * 60;
413 function getAvailableSlots( $from_date, $to_date, $provider_id = null, $facility_id = null )
415 $appointments = fetchAllEvents( $from_date, $to_date, $provider_id, $facility_id );
416 $appointments = sortAppointments( $appointments, "date" );
417 $from_datetime = strtotime( $from_date." 00:00:00" );
418 $to_datetime = strtotime( $to_date." 23:59:59" );
419 $availableSlots = array();
422 for ( $i = 0; $i < count( $appointments ); ++
$i )
424 if ( $appointments[$i]['pc_catid'] == 2 ) { // 2 == In Office
425 $start_time = $appointments[$i]['pc_startTime'];
426 $date = $appointments[$i]['pc_eventDate'];
427 $provider_id = $appointments[$i]['uprovider_id'];
428 } else if ( $appointments[$i]['pc_catid'] == 3 ) { // 3 == Out Of Office
431 $start_time = $appointments[$i]['pc_endTime'];
432 $date = $appointments[$i]['pc_eventDate'];
433 $provider_id = $appointments[$i]['uprovider_id'];
436 // find next appointment with the same provider
437 $next_appointment_date = 0;
438 $next_appointment_time = 0;
439 for ( $j = $i+
1; $j < count( $appointments ); ++
$j ) {
440 if ( $appointments[$j]['uprovider_id'] == $provider_id ) {
441 $next_appointment_date = $appointments[$j]['pc_eventDate'];
442 $next_appointment_time = $appointments[$j]['pc_startTime'];
447 $same_day = ( strtotime( $next_appointment_date ) == strtotime( $date ) ) ?
true : false;
449 if ( $next_appointment_time && $same_day ) {
450 // check the start time of the next appointment
452 $start_datetime = strtotime( $date." ".$start_time );
453 $next_appointment_datetime = strtotime( $next_appointment_date." ".$next_appointment_time );
454 $curr_time = $start_datetime;
455 while ( $curr_time < $next_appointment_datetime - (getSlotSize() / 2) ) {
456 //create a new appointment ever 15 minutes
457 $time = date( "H:i:s", $curr_time );
458 $available_slot = createAvailableSlot(
459 $appointments[$i]['pc_eventDate'],
461 $appointments[$i]['ufname'],
462 $appointments[$i]['ulname'],
463 $appointments[$i]['umname'] );
464 $availableSlots []= $available_slot;
465 $curr_time +
= getSlotSize(); // add a 15-minute slot
470 return $availableSlots;
473 function createAvailableSlot( $event_date, $start_time, $provider_fname, $provider_lname, $provider_mname = "", $cat_name = "Available" )
476 $newSlot['ulname'] = $provider_lname;
477 $newSlot['ufname'] = $provider_fname;
478 $newSlot['umname'] = $provider_mname;
479 $newSlot['pc_eventDate'] = $event_date;
480 $newSlot['pc_startTime'] = $start_time;
481 $newSlot['pc_endTime'] = $start_time;
482 $newSlot['pc_catname'] = $cat_name;
486 function getCompareFunction( $code ) {
487 global $COMPARE_FUNCTION_HASH;
488 return $COMPARE_FUNCTION_HASH[$code];
491 function getComparisonOrder( $code ) {
493 return $ORDERHASH[$code];
497 function sortAppointments( array $appointments, $orderBy = 'date' )
499 global $appointment_sort_order;
500 $appointment_sort_order = $orderBy;
501 usort( $appointments, "compareAppointments" );
502 return $appointments;
505 // cmp_function for usort
506 // The comparison function must return an integer less than, equal to,
507 // or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second.
508 function compareAppointments( $appointment1, $appointment2 )
510 global $appointment_sort_order;
511 $comparisonOrder = getComparisonOrder( $appointment_sort_order );
512 foreach ($comparisonOrder as $comparison) {
513 $cmp_function = getCompareFunction($comparison);
514 $result = $cmp_function($appointment1, $appointment2);
523 function compareBasic( $e1, $e2 )
527 } else if ( $e1 > $e2 ) {
534 function compareAppointmentsByDate( $appointment1, $appointment2 )
536 $date1 = strtotime( $appointment1['pc_eventDate'] );
537 $date2 = strtotime( $appointment2['pc_eventDate'] );
539 return compareBasic( $date1, $date2 );
542 function compareAppointmentsByTime( $appointment1, $appointment2 )
544 $time1 = strtotime( $appointment1['pc_startTime'] );
545 $time2 = strtotime( $appointment2['pc_startTime'] );
547 return compareBasic( $time1, $time2 );
550 function compareAppointmentsByDoctorName( $appointment1, $appointment2 )
552 $name1 = $appointment1['ulname'];
553 $name2 = $appointment2['ulname'];
554 $cmp = compareBasic( $name1, $name2 );
556 $name1 = $appointment1['ufname'];
557 $name2 = $appointment2['ufname'];
558 return compareBasic( $name1, $name2 );
564 function compareAppointmentsByPatientName( $appointment1, $appointment2 )
566 $name1 = $appointment1['lname'];
567 $name2 = $appointment2['lname'];
568 $cmp = compareBasic( $name1, $name2 );
570 $name1 = $appointment1['fname'];
571 $name2 = $appointment2['fname'];
572 return compareBasic( $name1, $name2 );
578 function compareAppointmentsByType( $appointment1, $appointment2 )
580 $type1 = $appointment1['pc_catid'];
581 $type2 = $appointment2['pc_catid'];
582 return compareBasic( $type1, $type2 );
585 function compareAppointmentsByPatientId( $appointment1, $appointment2 )
587 $id1 = $appointment1['pubpid'];
588 $id2 = $appointment2['pubpid'];
589 return compareBasic( $id1, $id2 );
592 function compareAppointmentsByComment( $appointment1, $appointment2 )
594 $comment1 = $appointment1['pc_hometext'];
595 $comment2 = $appointment2['pc_hometext'];
596 return compareBasic( $comment1, $comment2 );
599 function compareAppointmentsByStatus( $appointment1, $appointment2 )
601 $status1 = $appointment1['pc_apptstatus'];
602 $status2 = $appointment2['pc_apptstatus'];
603 return compareBasic( $status1, $status2 );
606 function compareAppointmentsByTrackerStatus( $appointment1, $appointment2 )
608 $trackerstatus1 = $appointment1['status'];
609 $trackerstatus2 = $appointment2['status'];
610 return compareBasic( $trackerstatus1, $trackerstatus2 );
613 function compareAppointmentsByCompletedDrugScreen( $appointment1, $appointment2 )
615 $completed1 = $appointment1['drug_screen_completed'];
616 $completed2 = $appointment2['drug_screen_completed'];
617 return compareBasic( $completed1, $completed2 );
620 function fetchAppointmentCategories()
622 $catSQL= " SELECT pc_catid as id, pc_catname as category "
623 . " FROM openemr_postcalendar_categories WHERE pc_recurrtype=0 and pc_cattype=0";
624 if($GLOBALS['enable_group_therapy']) $catSQL .= " OR pc_cattype=3";
625 $catSQL .= " ORDER BY category";
626 return sqlStatement($catSQL);
629 function interpretRecurrence($recurr_freq, $recurr_type){
630 global $REPEAT_FREQ, $REPEAT_FREQ_TYPE, $REPEAT_ON_NUM, $REPEAT_ON_DAY;
632 $recurr_freq = unserialize($recurr_freq);
633 if($recurr_type == 1){
634 $interpreted = $REPEAT_FREQ[$recurr_freq['event_repeat_freq']];
635 $interpreted .= " " . $REPEAT_FREQ_TYPE[$recurr_freq['event_repeat_freq_type']];
637 elseif($recurr_type == 2){
638 $interpreted = $REPEAT_FREQ[$recurr_freq['event_repeat_on_freq']];
639 $interpreted .= " " . $REPEAT_ON_NUM[$recurr_freq['event_repeat_on_num']];
640 $interpreted .= " " . $REPEAT_ON_DAY[$recurr_freq['event_repeat_on_day']];
642 elseif ($recurr_type == 3){
643 $interpreted = $REPEAT_FREQ[1];
645 $day_arr = explode(",", $recurr_freq['event_repeat_freq']);
646 foreach ($day_arr as $day){
647 $interpreted .= $comma . " " . $REPEAT_ON_DAY[$day - 1];
656 function fetchRecurrences($pid){
657 $query = "SELECT pe.pc_title, pe.pc_endDate, pe.pc_recurrtype, pe.pc_recurrspec, pc.pc_catname FROM openemr_postcalendar_events AS pe "
658 . "JOIN openemr_postcalendar_categories AS pc ON pe.pc_catid=pc.pc_catid "
659 . "WHERE pe.pc_pid = ? AND pe.pc_recurrtype > 0;";
660 $sqlBindArray = array();
661 array_push($sqlBindArray, $pid);
662 $res = sqlStatement($query, $sqlBindArray);
664 while($res_arr[$row] = sqlFetchArray($res)) {
665 $res_arr[$row]['pc_recurrspec'] = interpretRecurrence($res_arr[$row]['pc_recurrspec'], $res_arr[$row]['pc_recurrtype']);
671 function ends_in_a_week($end_date){
672 $timestamp_in_a_week = strtotime('+7 day');
673 $timestamp_end_date = strtotime($end_date);
674 if($timestamp_in_a_week > $timestamp_end_date){
675 return true; //ends in a week
677 return false; // ends in more than a week
680 //Checks if recurrence is current (didn't end yet).
681 function recurrence_is_current($end_date){
682 $end_date_timestamp = strtotime($end_date);
683 $current_timestamp = time();
684 if($current_timestamp <= $end_date_timestamp){
685 return true; //recurrence is current