Documentation/help_files/report_dashboard_help.php

   1 <?php
   2 /**
   3  * Report Dashboard Help.
   4  *
   5  * @package   OpenEMR
   6  * @link      http://www.open-emr.org
   7  * @author Ranganath Pathak <pathak@scrs1.org>
   8  * @copyright Copyright (c) 2018 Ranganath Pathak <pathak@scrs1.org>
   9  * @license   https://github.com/openemr/openemr/blob/master/LICENSE GNU General Public License 3
  10  */
  11
  12 use OpenEMR\Core\Header;
  13
  14 require_once("../../interface/globals.php");
  15 ?>
  16 <!DOCTYPE HTML>
  17 <html>
  18     <head>
  19     <?php Header::setupHeader();?>
  20     <title><?php echo xlt("Patient Reports Help");?></title>
  21     <style>
  22         .oe-help-add-info{
  23             padding:15px;
  24             border:6px solid;
  25             font-style: italic;
  26         }
  27     </style>
  28     </head>
  29     <body>
  30         <div class="container oe-help-container">
  31             <div>
  32                 <center><h2><a name='entire_doc'><?php echo xlt("Patient Reports Help");?></a></h2></center>
  33             </div>
  34             <div class= "row">
  35                 <div class="col-sm-12">
  36                     <p><?php echo xlt("Reports consisting of various portions of the patient's medical record can be created here");?>.
  37
  38                     <p><?php echo xlt("There are three main types of reports that can be created, two pertain to continuity of ongoing care - Continuity of Care Record (CCR) and Continuity of Care Document (CCD) and the third - Patient Report that creates a document containing various sections of the patient's medical record including demographics, medical issues, procedures and encounters. It also has the ability to include all or any of the scanned documents in the patient's chart");?>.
  39
  40                     <p><?php echo xlt("This help file is divided into four sections");?>:
  41
  42                     <ul>
  43                         <li><a href="#section1"><?php echo xlt("Continuity of Care Record (CCR)");?></a></li>
  44                         <li><a href="#section2"><?php echo xlt("Continuity of Care Document (CCD)");?></a></li>
  45                         <li><a href="#section3"><?php echo xlt("Patient Report");?></a></li>
  46                         <li><a href="#section4"><?php echo xlt("Enabling EMR Direct phiMail");?></a></li>
  47                     </ul>
  48
  49                     <p><i class="fa fa-lightbulb-o fa-lg  oe-text-green" aria-hidden="true"></i>&nbsp <?php echo xlt("To help explore the various components of the Report page especially if you want to use it as an instruction manual it is suggested that you reduce the size of the browser to cover half the viewport, resize the help pop-up by clicking and dragging the bottom right corner of the pop-up. Open another instance of the browser and resize it to cover the other half of the viewport, login to openEMR ");?>.
  50                 </div>
  51             </div>
  52             <div class= "row" id="section1">
  53                 <div class="col-sm-12">
  54                     <h4 class="oe-help-heading"><?php echo xlt("Continuity of Care Record (CCR)"); ?><a href="#"><i class="fa fa-arrow-circle-up oe-pull-away oe-help-redirect" aria-hidden="true"></i></a></h4>
  55                     <p><?php echo xlt("The Continuity of Care Record (CCR) is the clinical record of the patient’s current and historical health care status");?>.
  56
  57                     <p><?php echo xlt("Basic patient information is included, such as patient and provider information, insurance, patient health status, recent care provided, care plan information, and reason for referral or transfer");?>.
  58
  59                     <p><?php echo xlt("It is intended to include only the information that is critical to effectively continue care");?>.
  60
  61                     <p><?php echo xlt("For those interested in details of what constitutes a Continuity of Care Record (CCR) click on the eye icon");?> &nbsp;<i class="show_hide fa fa-eye fa-lg small" title="<?php echo xla('Click to Show'); ?>"></i>
  62
  63                     <div id="ccr_details" class='hideaway oe-help-heading oe-help-add-info' style='display: none;'>
  64                         <p><?php echo xlt("The Continuity of Care Record (CCR) has been developed jointly by ASTM International - an organization that is involved in the development and delivery of voluntary consensus, the Massachusetts Medical Society (MMS), the Health Information Management and Systems Society (HIMSS), the American Academy of Family Physicians (AAFP), and the American Academy of Pediatrics");?>.
  65
  66                         <p><?php echo xlt("The basis for CCR is a Patient Care Referral Form developed by the Massachusetts Department of Public Health");?>.
  67
  68                         <p><?php echo xlt("In total, there are seventeen sections that can be included within a Continuity of Care Record (CCR)");?>.
  69
  70                         <p id = "my_hide"><?php echo xlt("All sections are not required, rather, they are available based on the information a practitioner believes is critical data for the patient at any given moment in time");?> &nbsp <i class="show_hide fa fa-eye fa-lg small" title="<?php echo xla('Click to Show'); ?>"></i>
  71
  72                             <div class='hideaway' id='ccr_sections'style='display: none;'>
  73                                 <ul>
  74                                     <li><?php echo xlt("Patient Demographics"); ?></li>
  75                                     <li><?php echo xlt("Immunizations"); ?></li>
  76                                     <li><?php echo xlt("Vital Signs"); ?></li>
  77                                     <li><?php echo xlt("Problems & Diagnoses"); ?></li>
  78                                     <li><?php echo xlt("Insurance Information"); ?></li>
  79                                     <li><?php echo xlt("Health Care Providers"); ?></li>
  80                                     <li><?php echo xlt("Encounter Information"); ?></li>
  81                                     <li><?php echo xlt("Allergies/Alerting Data"); ?></li>
  82                                     <li><?php echo xlt("Appropriate Results"); ?></li>
  83                                     <li><?php echo xlt("Medication"); ?></li>
  84                                     <li><?php echo xlt("Procedures"); ?></li>
  85                                     <li><?php echo xlt("Results"); ?></li>
  86                                     <li><?php echo xlt("Necessary Medical Equipment"); ?></li>
  87                                     <li><?php echo xlt("Social History"); ?></li>
  88                                     <li><?php echo xlt("Statistics"); ?></li>
  89                                     <li><?php echo xlt("Family History"); ?></li>
  90                                     <li><?php echo xlt("Care Plan"); ?></li>
  91                                 </ul>
  92                             </div>
  93                         <div>
  94                         <p><?php echo xlt("The core dataset consists of");?>: &nbsp;<i class="show_hide fa fa-eye fa-lg small" title="<?php echo xla('Click to Show'); ?>"></i>
  95
  96                         <div class='hideaway' id='ccr_core'style='display: none;'>
  97
  98                             <ul>
  99                                 <li><?php echo xlt('Document identifying information');?>*</li>
 100                                 <li><?php echo xlt('Patient identifying information');?>*</li>
 101                                 <li><?php echo xlt('Patient insurance/financial information');?>*</li>
 102                                 <li><?php echo xlt('Advance Directives');?></li>
 103                                 <li><?php echo xlt('Patient’s health status');?>*</li>
 104                                 <li><?php echo xlt('Care documentation');?>*</li>
 105                                 <li><?php echo xlt('Care plan recommendations');?>*</li>
 106                                 <li><?php echo xlt('List of health care practitioners');?></li>
 107                             </ul>
 108                             <p><?php echo xlt("The items that have asterisks after them are mandated");?>.
 109                         </div>
 110                         </div>
 111                     </div>
 112
 113                     <p><?php echo xlt("In openEMR the Continuity of Care Record (CCR) reports to be generated can be limited to a specific date range by checking the Use Date Range check-box and entering the desired date range");?>.
 114
 115                     <p><?php echo xlt("There are three options available when you create a Continuity of Care Record (CCR)");?>:
 116                         <ul>
 117                             <li><?php echo xlt("Generate Report - that opens the CCR in a separate tab on the browser"); ?> <button type="button" class="btn btn-default btn-sm btn-save oe-no-float"><?php echo xlt("Generate Report"); ?></button></li>
 118                             <li><?php echo xlt("Download - the created CCR is downloaded as a pdf file to the downloads from the browser"); ?> <button type="button" class="btn btn-default btn-sm btn-download oe-no-float"><?php echo xlt("Download"); ?></button></li>
 119                             <li><?php echo xlt("Transmit - securely transmit the CCR using phiMail Direct Messaging"); ?> <button type="button" class="btn btn-default btn-sm btn-transmit oe-no-float"><?php echo xlt("Transmit"); ?></button></li>
 120                         </ul>
 121
 122                     <p><?php echo xlt("Clicking the Transmit button will open up a text box where the Direct address of the recipient needs to be entered");?>.
 123
 124                     <p><i class="fa fa-exclamation-circle oe-text-orange"  aria-hidden="true"></i> <strong><?php echo xlt("Note: this is not an email address");?>.</strong>
 125
 126                     <p><?php echo xlt("More information about what phiMail is and how to set it up is available here");?>. <a href="#section4"><?php echo xlt("Enabling EMR Direct phiMail");?></a>
 127                 </div>
 128             </div>
 129             <div class= "row" id="section2">
 130                 <div class="col-sm-12">
 131                     <h4 class="oe-help-heading"><?php echo xlt("Continuity of Care Document (CCD)"); ?><a href="#"><i class="fa fa-arrow-circle-up oe-pull-away oe-help-redirect" aria-hidden="true"></i></a></h4>
 132                     <p><?php echo xlt("Continuity of Care Document (CCD) is an electronic document containing patient specific information that aids in continuity of care");?>.
 133
 134                     <p><?php echo xlt("It contains structured data that is included in the Continuity of Care Record (CCR) set to the the Clinical Document Architecture standard");?>.
 135
 136                     <p><?php echo xlt("Click to learn more about the Clinical Document Architecture (CDA) and Consolidated CDA (C-CDA)");?>  &nbsp;<i class="show_hide fa fa-eye fa-lg small" title="<?php echo xla('Click to Show'); ?>"></i>
 137
 138                     <div id="ccd_details" class='hideaway oe-help-heading oe-help-add-info' style='display: none;'>
 139
 140                         <p><?php echo xlt("CDA or Clinical Document Architecture is a document standard developed by the HL7 organization");?>.
 141
 142                         <p><?php echo xlt("CDA defines building blocks which can be used to contain healthcare data elements that can be captured, stored, accessed, displayed and transmitted electronically for use and reuse in many formats");?>.
 143
 144                         <p><?php echo xlt("Clinical documents are produced by arranging or limiting CDA elements in defined ways using templates and Implementation Guides (IG)");?>.
 145
 146                         <p><?php echo xlt("The CDA is a plain text document that is coded using the Extensible Markup Language (XML) and contains a Header and Body");?>.
 147
 148                         <p><?php echo xlt("The Header defines the context for the clinical document as a whole");?>.
 149
 150                         <p><?php echo xlt("The Body contains the clinical data that may be structured and organized as one or more sections or may be an unstructured blob of data");?>.
 151
 152                         <p><?php echo xlt("Each Section has one Narrative Block and zero to many coded Entries");?>.
 153
 154                         <p><?php echo xlt("The Narrative Block contains information that is rendered as readable text");?>.
 155
 156                         <p><?php echo xlt("The Entries contain data used for further computer processing");?>.
 157
 158                         <p><?php echo xlt("Examples of Sections are - Medications, Allergies, Vital Signs");?>.
 159
 160                         <p><?php echo xlt("The initial efforts led to the creation of duplicative and conflicting Implementation Guides (IGs) published by different standards organizations");?>.
 161
 162                         <p><?php echo xlt("The end result was a confusing collection of documents containing ambiguous and/or conflicting information");?>.
 163
 164                         <p><?php echo xlt("To help simplify implementations, commonly used templates were harmonized from existing CDA implementation guides and consolidated into a single implementation guide – the C-CDA Implementation Guide (IG) (07/2012)");?>.
 165
 166                         <p><?php echo xlt("There are nine C-CDA templates that are currently defined");?>:  &nbsp;<i class="show_hide fa fa-eye fa-lg small" title="<?php echo xla('Click to Show'); ?>"></i>
 167
 168                             <div class='hideaway' id='c-cda_sections'style='display: none;'>
 169                                 <ul>
 170                                     <li><?php echo xlt("Continuity of Care Document"); ?></li>
 171                                     <li><?php echo xlt("Consultation Notes - 2008"); ?></li>
 172                                     <li><?php echo xlt("Discharge Summary - 2009"); ?></li>
 173                                     <li><?php echo xlt("Imaging Integration, and DICOM Diagnostic Imaging Reports - 2009"); ?></li>
 174                                     <li><?php echo xlt("History and Physical 2008"); ?></li>
 175                                     <li><?php echo xlt("Operative Note - 2009"); ?></li>
 176                                     <li><?php echo xlt("Progress Note - 2010"); ?></li>
 177                                     <li><?php echo xlt("Procedure Note - 2010"); ?></li>
 178                                     <li><?php echo xlt("Unstructured Documents - 2010"); ?></li>
 179                                 </ul>
 180                             </div>
 181                         <p><?php echo xlt("The Continuity of Care Document (CCD) and Continuity of Care Record (CCR) were both selected as acceptable formats to extract information for clinical care summaries as a part of Meaningful Use Stage 1");?>.
 182
 183                         <p><?php echo xlt("In the second stage of Meaningful Use, the CCD, but not the CCR, was included as part of the standard for clinical document exchange");?>.
 184                     </div>
 185
 186                     <p><?php echo xlt("Continuity of Care Document (CCD) is meant to be created at the conclusion of an encounter prior to transfer of care to enable the next provider to easily access such information");?>.
 187
 188                     <p><?php echo xlt("It serves as a necessary bridge to a different environment, often with new clinicians who know nothing about the patient, enabling next provider to easily");?>
 189
 190                         <ul>
 191                             <li><?php echo xlt("Access core data set of patient information at the beginning of an encounter"); ?></li>
 192                             <li><?php echo xlt("Update information when the patient goes to another provider, to support safety, quality, and continuity of patient care"); ?></li>
 193                         </ul>
 194
 195                     <p><?php echo xlt("There are three options available when you create a Continuity of Care Document (CCD)");?>:
 196                         <ul>
 197                             <li><?php echo xlt("Generate Report - that opens the CCD in a separate tab on the browser"); ?> <button type="button" class="btn btn-default btn-sm btn-save oe-no-float"><?php echo xlt("Generate Report"); ?></button></li>
 198                             <li><?php echo xlt("Download - the created CCD is downloaded as a pdf file to the downloads from the browser"); ?> <button type="button" class="btn btn-default btn-sm btn-download oe-no-float"><?php echo xlt("Download"); ?></button></li>
 199                             <li><?php echo xlt("Transmit - securely transmit the CCD using phiMail Direct Messaging"); ?> <button type="button" class="btn btn-default btn-sm btn-transmit oe-no-float"><?php echo xlt("Transmit"); ?></button></li>
 200                         </ul>
 201
 202                     <p><?php echo xlt("Clicking the Transmit button will open up a text box where the Direct address of the recipient needs to be entered");?>.
 203
 204                     <p><i class="fa fa-exclamation-circle oe-text-orange"  aria-hidden="true"></i> <strong><?php echo xlt("Note: this is not an email address");?>.</strong>
 205
 206                     <p><?php echo xlt("More information about what phiMail is and how to set it up is available here");?>. <a href="#section4"><?php echo xlt("Enabling EMR Direct phiMail");?></a>
 207                 </div>
 208             </div>
 209             <div class= "row" id="section3">
 210                 <div class="col-sm-12">
 211                     <h4 class="oe-help-heading"><?php echo xlt("Patient Report"); ?><a href="#"><i class="fa fa-arrow-circle-up oe-pull-away oe-help-redirect" aria-hidden="true"></i></a></h4>
 212                     <p><?php echo xlt("Creates a report that contains various sections of the patient's medical record");?>.
 213
 214                     <p><?php echo xlt("The created report can contain as much or as little information based on the need");?>.
 215
 216                     <p><?php echo xlt("By default only Demographics and Billing information is selected");?>.
 217
 218                     <p><?php echo xlt("There are two buttons that enable you to Check or Clear all available check-boxes");?>.
 219                     <button type="button" class="btn btn-default btn-sm btn-save oe-no-float"><?php echo xlt("Check All"); ?></button>
 220                     <button type="button" class="btn btn-default btn-sm btn-undo oe-no-float"><?php echo xlt("Clear All"); ?></button>
 221
 222                     <p><?php echo xlt("Alternatively you could clear all selections and select only the items that you want to be a part of the report");?>.
 223
 224                     <p><?php echo xlt("To include the scanned documents that are a part of the patient's record select the desired records by check the relevant check-boxes");?>.
 225
 226                     <p><?php echo xlt("There are two options for the records that will be created");?>:
 227                         <ul>
 228                             <li><?php echo xlt("Generate Report that creates a report and displays it in a separate tab on the browser "); ?> <button type="button" class="btn btn-default btn-sm btn-save oe-no-float"><?php echo xlt("Generate Report"); ?></button></li>
 229                             <li><?php echo xlt("Download report as a pdf file into the browser's download folder"); ?> <button type="button" class="btn btn-default btn-sm btn-download oe-no-float"><?php echo xlt("Download PDF"); ?></button></li>
 230                         </ul>
 231
 232                     <p><?php echo xlt("When the generated report is displayed in a separate tab there is an option that lets you view a Printable Version that can be printed");?>.
 233
 234                     <p><?php echo xlt("If the report is sent electronically all steps needed for safe and secure transmission of Protected Health Information (PHI) must be followed");?>.
 235
 236                 <div>
 237             </div>
 238             <div class= "row" id="section4">
 239                 <div class="col-sm-12">
 240                     <h4 class="oe-help-heading"><?php echo xlt("Enabling EMR Direct phiMail"); ?><a href="#"><i class="fa fa-arrow-circle-up oe-pull-away oe-help-redirect" aria-hidden="true"></i></a></h4>
 241                     <p><?php echo xlt("EMR Direct phiMail is a secure, scalable, standards-based way for participants to send authenticated, encrypted health information directly to known, trusted recipients over the Internet");?>.
 242
 243                     <p><i class="fa fa-exclamation-triangle oe-text-red"  aria-hidden="true"></i> <strong><?php echo xlt("You will need Administrator privileges to setup phiMail Direct Messaging");?>.</strong>
 244
 245                     <p><?php echo xlt("The first step is signing up for a production Direct messaging account with EMR Direct by registering on their website");?>.
 246                      <a href="https://www.emrdirect.com/subscribe"" target="_blank"><i class="fa fa-external-link text-primary" aria-hidden="true" data-original-title="" title=""></i></a>
 247
 248                     <p><?php echo xlt("Subscribers will receive the username, password, and server address information with which to configure OpenEMR");?>.
 249
 250                     <p><?php echo xlt("Go to Administration > Globals > Connectors");?>.
 251
 252                     <p><?php echo xlt("Check the Enable phiMail Direct Messaging Service check-box");?>.
 253
 254                     <p><?php echo xlt("Enter the Server Address, Username, and Password provided to you");?>.
 255
 256                     <p><?php echo xlt("The server address will be of the form ");?> <b>ssl://servername.example.com:32541</b>
 257
 258                     <p><?php echo xlt("Replace the hostname and port with the values provided to you by EMR Direct");?>.
 259
 260                     <p><?php echo xlt("The Username is your Direct Address");?>.
 261
 262                     <p><?php echo xlt("Do not enter the server URL into your browser address bar, as this will not work");?>.
 263
 264                     <p><?php echo xlt("Specify the OpenEMR user who will receive notification of new incoming Direct messages");?>.
 265
 266                     <p><?php echo xlt("Enter their OpenEMR username in the notification user field");?>.
 267
 268                     <p><?php echo xlt("Specify the interval for automatic message checking, 5 or 10 minutes as a starting point");?>.
 269
 270                     <p><?php echo xlt("Installations processing a large number of Direct messages may want a shorter interval");?>.
 271
 272                     <p><?php echo xlt("To disable automatic message checking go to Administration > Globals > Connectors  and set phiMail Message Check Interval to 0 (zero) ");?>.
 273
 274                     <p><?php echo xlt("Disabling automatic checking would be appropriate if message checking is managed through another mechanism, such as a system cron job");?>.
 275
 276                     <p><?php echo xlt("In order to send Continuity of Care Record (CCR) and /or Continuity of Care Document (CCD )Optionally check phiMail Allow CCD Send and/or phiMail Allow CCR Send to enable the Transmit feature for these data types");?>.
 277
 278                     <p><?php echo xlt("If you do not select at least one of these, OpenEMR will operate in a receive-only mode");?>.
 279
 280                     <p><?php echo xlt("Click the Save button");?>.
 281                     <button type="button" class="btn btn-default btn-save btn-sm oe-no-float"><?php echo xlt("Save"); ?></button>
 282
 283                     <p><?php echo xlt("To receive error notifications from the Direct Messaging service a valid Notification Email Address needs to be entered for the user named in  in Administration > Globals > Connectors > phiMail notification user");?>.
 284
 285                     <p><?php echo xlt("Install the EMR Direct trust anchor certificate");?>.
 286
 287                     <p><strong><?php echo xlt("SENDING A MESSAGE"); ?>:</strong>
 288
 289                     <p><?php echo xlt("At present only Continuity of Care Record (CCR) Continuity of Care Document (CCD) can be sent using phiMail");?>.
 290
 291                     <p><?php echo xlt("Click the Transmit button to reveal the Direct address box");?>.
 292                     <button type="button" class="btn btn-default btn-transmit btn-sm oe-no-float"><?php echo xlt("Transmit"); ?></button>
 293
 294                     <p><?php echo xlt("Enter the Direct address and click Send CCR/Send CCD as the case may be");?>.
 295                     <button type="button" class="btn btn-default btn-send-msg btn-sm oe-no-float"><?php echo xlt("Send CCR"); ?></button>
 296                     <button type="button" class="btn btn-default btn-send-msg btn-sm oe-no-float"><?php echo xlt("Send CCD"); ?></button>
 297
 298                     <p><strong><?php echo xlt("RECEIVING A MESSAGE"); ?> :</strong>
 299
 300                     <p><?php echo xlt("Received messages are processed and a new Patient Note is delivered to a specified user and appears in that user's Message Center");?>.
 301
 302                     <p><?php echo xlt("These Patient notes are sent without an assigned patient");?>.
 303
 304                     <p><?php echo xlt("Open and review the message content and any attachments");?>.
 305
 306                     <p><?php echo xlt("Assign the message to the correct patient by clicking Patient: Click to select, assign a Type and forward the message on to the correct clinician or staff member");?>.
 307
 308                     <p><?php echo xlt("More information on the use of phiMail messages is available  here");?>.
 309                     <a href="https://www.open-emr.org/wiki/index.php/Direct" target="_blank"><i class="fa fa-external-link text-primary" aria-hidden="true" data-original-title="" title=""></i></a>
 310
 311                     <p><?php echo xlt("Detailed information on how to setup and troubleshoot phiMail messages is available here");?>.
 312                     <a href="https://raw.githubusercontent.com/openemr/openemr/master/Documentation/Direct_Messaging_README.txt" target="_blank"><i class="fa fa-external-link text-primary" aria-hidden="true" data-original-title="" title=""></i></a>
 313                 </div>
 314             </div>
 315         </div><!--end of container div-->
 316         <script>
 317            $('.show_hide').click(function() {
 318                 var elementTitle = $(this).prop('title');
 319                 var hideTitle = '<?php echo xla('Click to Hide'); ?>';
 320                 var showTitle = '<?php echo xla('Click to Show'); ?>';
 321                 //$('.hideaway').toggle('1000');
 322                 $(this).parent().parent().closest('div').children('.hideaway').toggle('1000');
 323                 if (elementTitle == hideTitle) {
 324                     elementTitle = showTitle;
 325                     $(this).toggleClass('fa-eye-slash fa-eye');
 326                 } else if (elementTitle == showTitle) {
 327                     elementTitle = hideTitle;
 328                     $(this).toggleClass('fa-eye fa-eye-slash');
 329                 }
 330                 $(this).prop('title', elementTitle);
 331             });
 332         </script>
 333     </body>
 334 </html>