Second merge from Julia Longtin repository
[openemr.git] / Documentation / Direct_Messaging_README.txt
blob6d22dfb821050a05a6008eefd84c3d3cd8b9e20c
1 Direct Messaging with OpenEMR and EMR Direct phiMail(TM)
2 Version 1.0, 1 Feb 2013
4 Purpose:
5 To provide a secure method from within OpenEMR for sending protected health 
6 information to another Direct address using the Direct Project messaging 
7 standard, as a first step toward the goal of satisfying the three MU2 criteria 
8 requiring the use of Direct messaging.  (For general information about Direct messaging, 
9 see http://www.emrdirect.com/about-directed-exchange-and-secure-direct-messaging.html)
11 IMPORTANT:
12 EMR Direct currently considers the OpenEMR Direct Messaging features to be in test-mode 
13 and not ready for use with real PHI. Some known limitations include: 
14 a. the current code does not have the ability to query for delayed failure or final delivery 
15 notifications from the phiMail server, and 
16 b. the current code only supports a single shared "group" Direct Address for each OpenEMR 
17 installation.
19 Problems Solved:
20 1. Patient initiated transmission of CCDA data from the Report section of the Patient Portal 
21 interface.
22 2. Provider initiated transmission of CCDA data from the Report section of the Patient pane
23 in the main OpenEMR interface.
24 3. Log all CCDA data transmissions including date/time, patient, and whether transmission 
25 was initiated by the patient through the Patient Portal or by an OpenEMR user through the 
26 main interface.
28 How it Works:
29 Once configured, OpenEMR will interface with a phiMail Direct messaging server to complete the
30 required message transactions. The phiMail platform is described on the EMR Direct website, 
31 http://www.emrdirect.com and http://www.emrdirect.com/phimail-faq.html.
33 What you need before enabling Direct Messaging in OpenEMR:
34 1. Test-Mode: Developers may contact EMR Direct to request complimentary test address and 
35 digital certificate provisioning, as well as API documentation, at support@emrdirect.com. 
36 2. Production-Mode: Healthcare provider users should begin by signing up for a Direct message 
37 account with EMR Direct. 
38 Subscribers will receive the username, password, and server address information with which to 
39 configure OpenEMR. Applicants may visit http://www.emrdirect.com/subscribe.html to begin the
40 process. 
42 How to enable the Direct Messaging Features in OpenEMR:
43 Setup of phimail Direct messaging Service is done in the Administration::Globals::Connectors tab
44 1. Check the "Enable phiMail Direct Messaging Service" checkbox.
45 2. Enter the Server Address, Username, and Password provided to you by EMR Direct.
46 3. Click the "Save" button.
48 How to use the Direct Messaging Features in OpenEMR:
49 When the phiMail Direct Messaging service is enabled, an additional "Transmit" button will
50 appear in the Continuity of Care Document (CCD) section of the Reports section in both the
51 Patient Portal and the Patient pane of the main provider interface. 
53 To transmit a CCD, first click the "Transmit" button. This will open a small dialog immediately 
54 below the button with a form field to enter the intended recipient's Direct Address. Clicking
55 "Transmit" again will hide the dialog.
57 A Direct Address should have the same form as a regular email address, e.g. 
58 jonesclinic@direct.example.com. Enter the address in the field and click the "Send" button 
59 immediately to the right of the field. Only a single recipient may be specified in the field.
60 The Send button will be temporarily disabled while OpenEMR is communicating with the phiMail server.
61 This will only work for properly-configured Direct addresses.   Attempts to send to a regular 
62 email address or Direct address outside of our test mode "trust sandbox" will fail.
64 OpenEMR will then display a status message immediately below the Address field, the 
65 success or failure of the message transmission, or an error message. If the message is
66 successfully submitted to the server, the Address field will be cleared to prevent accidental
67 re-transmission. If multiple recipients are required, the next recipient can now be entered.
70 Trademark Notice: phiMail is a trademark of EMR Direct.
72 Copyright (c) 2013 EMR Direct.