Fixing critical issues with Fees > Batch Payments (#2656)
[openemr.git] / Documentation / help_files / message_center_help.php
blob8f7436c0b46fd82dac8de2ada8c8a4e9445362b4
1 <?php
2 /**
3 * Message Center Help.
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
12 use OpenEMR\Core\Header;
14 require_once("../../interface/globals.php");
16 <!DOCTYPE HTML>
17 <html>
18 <head>
19 <?php Header::setupHeader();?>
20 <title><?php echo xlt("Message Center Help");?></title>
22 <style>
23 @media only screen and (max-width: 768px) {
24 [class*="col-"] {
25 width: 100%;
26 text-align:left!important;
29 </style>
30 </head>
31 <body>
32 <div class="container oe-help-container">
33 <div>
34 <center><h2><a name = 'entire_doc'><?php echo xlt("Messages, Reminders, Recalls");?></a></h2></center>
35 </div>
36 <div class= "row">
37 <p><?php echo xlt("The messaging center conveniently consolidates communications options in one place");?>.
39 <p><?php echo xlt("It lets you send messages and dated reminders to staff members, add patient to the recall list and send SMS text messages to patients");?>.
41 <p><?php echo xlt("The default messaging center is divided into three sections - Messages, Reminders and Recalls");?>.
43 <p><?php echo xlt("Additional functionality including the ability to send SMS text messages, automated phone dialing, emails etc. can be accessed by enabling the optional MedEx Communication Service");?>.
45 <ul>
46 <li><a href="#messages"><?php echo xlt("Messages");?></a></li>
47 <li><a href="#reminders"><?php echo xlt("Reminders");?></a></li>
48 <li><a href="#recalls"><?php echo xlt("Recalls");?></a></li>
49 <li><a href="#medex_communication_service"><?php echo xlt("MedEx Communication Service");?></a></li>
50 </ul>
51 </div>
52 <div class= "row" id="messages">
53 <h4 class="oe-help-heading"><?php echo xlt("Messages"); ?><a href="#"><i class="fa fa-arrow-circle-up oe-pull-away oe-help-redirect" aria-hidden="true"></i></a></h4>
54 <p><?php echo xlt("Lets you send messages to staff members about patient related matters");?>.
56 <p><i class="fa fa-exclamation-circle oe-text-orange" aria-hidden="true"></i> <strong><?php echo xlt("It is a part of the medical record"); ?>.</strong>
58 <p><?php echo xlt("Upon logging in to openEMR a small envelope icon is visible on the top right. It shows the number of pending messages and dated reminders"); ?>.
59 <button type="button" class="btn btn-default btn-sm oe-no-float"><i class="fa fa-envelope"></i></button>
61 <p><?php echo xlt("You can click on the envelope icon to access the messaging center"); ?>.
63 <p><?php echo xlt("Alternatively it can be accessed by clicking in the Messages menu item in the top navigation bar"); ?>.
65 <p><?php echo xlt("The messaging center will open with the Messages tab activated and will display the logged in user's messages as indicated by the caption My Messages"); ?>.
67 <p><i class="fa fa-exclamation-circle oe-text-orange" aria-hidden="true"></i> <strong><?php echo xlt("For those with administrative privileges an icon is displayed next to the My Messages caption") ?>.</strong>
69 <p><?php echo xlt("Clicking on the icon next to the caption will display everyone's messages and the caption will change to All Messages") ?>.
71 <p><?php echo xlt("By default Active Messages are displayed as indicated in the section below the Messages caption"); ?>.
73 <p><?php echo xlt("Clicking on the Show All or Show Inactive buttons will show the appropriate messages"); ?>.
75 <p><strong><?php echo xlt("CREATING A NEW MESSAGE"); ?> :</strong>
77 <p><?php echo xlt("To create a new message click on the Add New button at the bottom"); ?>.
78 <button type="button" class="btn btn-default btn-add btn-sm oe-no-float"><?php echo xlt("Add New"); ?></button>
80 <p><?php echo xlt("It will open the Create New Message section"); ?>.
82 <p><?php echo xlt("Select the message type to more accurately reflect the type of message you are sending. You may choose to leave it as unassigned"); ?>.
84 <p><?php echo xlt("The message status will be New as it a new message that is being created"); ?>.
86 <p><?php echo xlt("Select a patient by clicking on the patient input box"); ?>.
88 <p><?php echo xlt("It will bring up the Multi patient finder popup"); ?>.&nbsp;
89 <i class="fa fa-exclamation-circle oe-text-orange" aria-hidden="true"></i> <strong><?php echo xlt("New to openEMR 5.0.2"); ?></strong>
91 <p><?php echo xlt("Clicking on either the Enter Name or Enter ID tab will bring up the search box which you can use to select a patient"); ?>.
93 <p><?php echo xlt("Click on Add to List button to add to the bottom section"); ?>.
94 <button class="btn btn-default btn-sm oe-no-float"><?php echo xlt("Add to list"); ?></button>
96 <p><?php echo xlt("You can add multiple patients to the list"); ?>.
98 <p><?php echo xlt("Click OK to import these patients into the patient input box"); ?>.
100 <p><?php echo xlt("Click the Clear button to clear the imported patient names and start afresh"); ?>.
101 <button type="button" class="btn btn-default btn-undo btn-sm oe-no-float"><?php echo xlt("Clear"); ?></button>
103 <p><?php echo xlt("Use the Select User dropdown box to select the user(s) to whom the message will be sent"); ?>.
105 <p><?php echo xlt("You can add multiple users by selecting them one at a time"); ?>.
107 <p><?php echo xlt("Click the Clear button to start afresh"); ?>.
108 <button type="button" class="btn btn-default btn-undo btn-sm oe-no-float"><?php echo xlt("Clear"); ?></button>
110 <p><?php echo xlt("Type the message and click Send Message "); ?>.
111 <button type="button" class="btn btn-default btn-send-msg btn-sm oe-no-float"><?php echo xlt("Send Message"); ?></button>
113 <p><?php echo xlt("A new message can thus be sent to a single or multiple users and/or can be about a single or multiple patients"); ?>.
115 <p><strong><?php echo xlt("ADD TO EXISTING MESSAGE"); ?> :</strong>
117 <p><?php echo xlt("All pending messages are displayed on the MY MESSAGES pane"); ?>.
119 <p><?php echo xlt("You can sort the pending messages in ascending or descending order by clicking on the arrowhead in each cell of the table header"); ?>.
121 <p><?php echo xlt("Clicking on the patient's name will reveal the message"); ?>.
123 <p><?php echo xlt("You can only add to the existing message and cannot edit previously entered data"); ?>.
125 <p><?php echo xlt("You can change the type or leave it as it is"); ?>.
127 <p><?php echo xlt("There are four message statuses - New, Forwarded, Read and Done"); ?>.
129 <p><?php echo xlt("Changing the status to Done will remove the message from the active message list"); ?>.
131 <p><?php echo xlt("Changing the status to Read would leave it as a read message in the active messages list of the current user"); ?>.
133 <p><?php echo xlt("If the message is forwarded it will show up in the active messages list of the user to whom the message was forwarded and disappear from the current user's active messages list"); ?>.
135 <p><?php echo xlt("Changing the status to New will achieve the same result"); ?>.
137 <p><?php echo xlt("If desired the current message can be printed"); ?>.
139 <p><?php echo xlt("Clicking on the Delete button will delete the message"); ?>.
140 <button type="button" class="btn btn-default btn-delete btn-sm oe-no-float"><?php echo xlt("Delete"); ?></button>
141 </div>
142 <div class= "row" id="reminders">
143 <h4 class="oe-help-heading"><?php echo xlt("Reminders"); ?><a href="#"><i class="fa fa-arrow-circle-up oe-pull-away oe-help-redirect" aria-hidden="true"></i></a></h4>
144 <p><?php echo xlt("Otherwise known as Dated Reminders are short messages of up to 160 characters"); ?>.
146 <p><i class="fa fa-exclamation-circle oe-text-orange" aria-hidden="true"></i> <strong><?php echo xlt("Unlike a message sent in Messages the dated reminder is not a part of the medical record"); ?>.</strong>
148 <p><?php echo xlt("It can be either linked to a patient or just be a message addressed to another user(s)"); ?>.
150 <p><?php echo xlt("There are three actions that are possible - Create a New Dated Reminder, Forward and Set as Completed"); ?>.
152 <p><strong><?php echo xlt("CREATING A NEW DATED REMINDER"); ?> :</strong>
154 <p><?php echo xlt("Clicking on the Create A Dated Reminder button will bring up the Send a Reminder popup"); ?>.
155 <button type="button" class="btn btn-default btn-add btn-sm oe-no-float"><?php echo xlt("Create A Dated Reminder"); ?></button>
157 <p><?php echo xlt("The first section lets you either link this message to a patient if so desired."); ?>.
159 <p><?php echo xlt("The second section lets you choose to whom you wish to send the message"); ?>.
161 <p><?php echo xlt("You can click on the Select All button to choose all authorized users"); ?>.
162 <button type="button" class="btn btn-default btn-save btn-sm oe-no-float"><?php echo xlt("Select All"); ?></button>
164 <p><?php echo xlt("If the checkbox is checked and the message is sent to multiple users then each user has to sign off on the message by clicking the Set As Completed Button for that message"); ?>.
166 <p><?php echo xlt("A due date can be specified or a specific time period can be chosen for the dated reminder to to show up"); ?>.
168 <p><?php echo xlt("Set the priority level"); ?>.
170 <p><?php echo xlt("Type a brief message and hit Send Message "); ?>.
171 <button type="button" class="btn btn-default btn-send-msg btn-sm oe-no-float"><?php echo xlt("Send Message"); ?></button>
173 <p><?php echo xlt("The messages that were sent by the user on that day will be displayed in the table below"); ?>.
175 <p><?php echo xlt("The dated reminder will start to appear 5 days before the reminder date under Dated Reminders "); ?>.
177 <p><?php echo xlt("The upcoming reminders have a green exclamation icon"); ?>.&nbsp;
178 <i class="fa fa-exclamation-circle oe-text-green" aria-hidden="true"></i>
180 <p><?php echo xlt("The reminder for the current day will have an orange exclamation icon"); ?>.
181 <i class="fa fa-exclamation-circle oe-text-orange" aria-hidden="true"></i>
183 <p><?php echo xlt("The reminders that are past the due date will have a red exclamation triangle icon"); ?>.
184 <i class="fa fa-exclamation-triangle oe-text-red" aria-hidden="true"></i>
186 <p><?php echo xlt("By default only five dated reminders are shown at a time"); ?>.
188 <p><?php echo xlt("Increase the limit to a larger number say 100 so that you can decide on which ones to act upon"); ?>.
190 <p><i class="fa fa-exclamation-triangle oe-text-red" aria-hidden="true"></i> <strong><?php echo xlt("You need administrator privileges to increase the number of reminders to show"); ?>.</strong>
192 <p><?php echo xlt("Go to Administration > Globals > CDR > Dated reminders maximum alerts to show and change the value to a higher number"); ?>.
194 <p><?php echo xlt("A dated reminder message can be either forwarded by clicking the Forward button or removed from the dated reminders list by clicking on the Set As Completed button"); ?>.
195 <button type="button" class="btn btn-default btn-send-msg btn-sm oe-no-float"><?php echo xlt("Forward"); ?></button>
196 <button type="button" class="btn btn-default btn-save btn-sm oe-no-float"><?php echo xlt("Set As Completed"); ?></button>
198 <p><strong><?php echo xlt("FORWARD A DATED REMINDER"); ?> :</strong>
200 <p><?php echo xlt("The process for forwarding the message is quite similar to that of creating a new message"); ?>.
202 <p><?php echo xlt("While forwarding a dated reminder the old message is displayed, it can be overwritten"); ?>.
204 <p><?php echo xlt("The previous message can however be viewed by clicking on the View Log button"); ?>.
205 <button type="button" class="btn btn-default btn-save btn-show btn-sm oe-no-float"><?php echo xlt("View Log"); ?></button>
207 <p><?php echo xlt("Clicking on the View Log button will bring up the Dated Message Log popup"); ?>.
209 <p><?php echo xlt("Lets you filter the results as per the chosen criteria"); ?>.
211 <p><?php echo xlt("If you hit the refresh button without setting any filters then all dated reminders for the user will appear below"); ?>.
212 <button type="button" class="btn btn-default btn-sm btn-refresh oe-no-float"><?php echo xlt("Refresh"); ?></button>
214 <p><?php echo xlt("The log table will show a list of both messages and dated reminders if any"); ?>.
216 <p><?php echo xlt("The display window can be resized by clicking and dragging the bottom right corner of the window"); ?>.
218 <p><?php echo xlt("Clicking on the slashed eye icon will hide the filters"); ?>.
219 <i class="fa fa-eye-slash text-warning" aria-hidden="true"></i>
221 <p><?php echo xlt("To reveal the filters click on the eye icon"); ?>.
222 <i class="fa fa-eye text-warning" aria-hidden="true"></i>
224 <p><strong><?php echo xlt("SET AS COMPLETED"); ?> :</strong>
226 <p><?php echo xlt("Clicking on Set As Completed will remove the reminder from the active display"); ?>.
227 <button type="button" class="btn btn-default btn-save btn-sm oe-no-float"><?php echo xlt("Set As Completed"); ?></button>
228 </div>
229 <div class= "row" id="recalls">
230 <h4 class="oe-help-heading"><?php echo xlt("Recalls"); ?><a href="#"><i class="fa fa-arrow-circle-up oe-pull-away oe-help-redirect" aria-hidden="true"></i></a></h4>
231 <p><?php echo xlt("This feature is used to add patients to a recall list, i.e those that need an appointment at a future date but the appointment has not yet been scheduled"); ?>.
233 <p><?php echo xlt("Once an appointment is scheduled the name automatically drops off the recall board"); ?>.
235 <p><?php echo xlt("The Recalls tab has two buttons New Recall and Recall Board"); ?>.
236 <button type="button" class="btn btn-default btn-sm btn-add oe-no-float"><?php echo xlt("New Recall"); ?></button>
237 <button type="button" class="btn btn-default btn-sm btn-transmit oe-no-float"><?php echo xlt("Recall Board"); ?></button>
239 <p><strong><?php echo xlt("ADD A NEW RECALL"); ?> :</strong>
241 <p><?php echo xlt("Click on the New Recall button to open a new recall scheduling page"); ?>.
243 <p><?php echo xlt("It contains a left and right section"); ?>.
245 <p><?php echo xlt("Click on the Name text box on the left section to bring up the patient finder pop-up"); ?>.
247 <p><?php echo xlt("Search and select a patient and click OK"); ?>.
249 <p><?php echo xlt("If the patient has any demographic data entered in openEMR it will automatically populate the relevant fields on the right sections"); ?>.
251 <p><?php echo xlt("Fill in any missing details or edit existing information. This will be saved in the patient's demographics page in openEMR"); ?>.
253 <p><?php echo xlt("The last visit date will automatically be filled"); ?>.
255 <p><?php echo xlt("If the patient is being added to the recall list on the day of the visit it would reflect the current date"); ?>.
257 <p><?php echo xlt("If the patient is calling back to be added to the list the last visit may be in the remote past. Be aware that the 1,2,3 plus years are calculated and displayed on the Date box at the bottom of this section"); ?>.
259 <p><?php echo xlt("You could manually edit this date should you choose to or an entirely different date"); ?>.
261 <p><?php echo xlt("Fill in the reason and select a provider and clinic and click the Add Recall button to complete the process"); ?>.
262 <button type="button" class="btn btn-default btn-sm btn-add oe-no-float"><?php echo xlt("Add Recall"); ?></button>
264 <p><strong><?php echo xlt("RECALL BOARD - Default - without MedEx Communication Service"); ?> :</strong>
266 <p><?php echo xlt("This fully functional Recall Board included in the default install can be used to add patients to the recall list"); ?>.
268 <p><?php echo xlt("To access it click on the Recall Board menu item in the top navigation bar or click on the Recall Board button in the Message Center"); ?>.
269 <button type="button" class="btn btn-default btn-sm btn-transmit oe-no-float"><?php echo xlt("Recall Board"); ?></button>
271 <p><?php echo xlt("The top portion of the Recall Board allows the setting of filters to display specified data"); ?>.
273 <p><?php echo xlt("Enter or select the options in the various boxes to filter the results according to need and press Filter"); ?>.
274 <button type="button" class="btn btn-default btn-sm btn-filter oe-no-float"><?php echo xlt("Filter"); ?></button>
276 <p><?php echo xlt("The filtered results will show up in the section below it"); ?>.
278 <p><?php echo xlt("The filter section can be hidden or revealed by clicking the arrowhead on the bottom right "); ?>.
279 <span class="text-right fa-stack fa-lg pull_right small oe-text-black"style="position:relative;right:0;top:0;">
280 <i class="fa fa-square-o fa-stack-2x"></i>
281 <i id="print_caret" class="fa fa-caret-up fa-stack-1x"></i>
282 </span>
284 <p><?php echo xlt("The Name cell contains the name, date of birth, patient ID and date of last visit"); ?>.
286 <p><?php echo xlt("You can click on the patient name to quickly access the patient's chart"); ?>.
288 <p><?php echo xlt("The Recall cell has the date of recall and the reason for recall"); ?>.
290 <p><?php echo xlt("The Contacts cell has various bits of contact information like phone numbers, email etc"); ?>.
292 <p><?php echo xlt("The next three cells are the action cells that let you perform some recall activity"); ?>.
294 <p><?php echo xlt("If you check the check box in any of these cells it will generate an entry in the last cell called Progress"); ?>.
296 <p><?php echo xlt("Checking the Postcards check box will let you print a postcard that can be mailed to a patient"); ?>.
298 <p><?php echo xlt("Labels can be printed either for one patient or for all the selected patients"); ?>.
300 <p><?php echo xlt("The Office: Phone cell lets you indicate a phone call was made"); ?>.
302 <p><i class="fa fa-exclamation-circle oe-text-orange" aria-hidden="true"></i> <strong>
303 <?php echo xlt("The default installation will not make the phone call automatically"); ?>.</strong>
305 <p><?php echo xlt("An appointment can be scheduled by clicking on the calendar icon in that cell"); ?>.
306 <i class="fa fa-calendar-check-o fa-fw oe-text-black" aria-hidden="true"></i>
308 <p><?php echo xlt("Once an appointment is scheduled the recall will drop off the Recall Board"); ?>.
310 <p><?php echo xlt("The Notes cell lets you add a note to an action that you take in the 3 action cells or just a note without any association to the action"); ?>.
312 <p><?php echo xlt("The Progress cell lists all the actions along with any associated notes if any"); ?>.
314 <p><?php echo xlt("You can delete the recall by clicking on the X button on the top right corner of the cell"); ?>.
316 <p><?php echo xlt("If so desired the default board can be disabled by going to Administration > Calendar > Recall Board: Disable and checking the checkbox and click Save"); ?>.
318 <p><i class="fa fa-exclamation-triangle oe-text-red" aria-hidden="true"></i> <strong><?php echo xlt("You need administrator privileges to disable the default Recall Board"); ?>.</strong>
319 </div>
320 <div class= "row" id="medex_communication_service">
321 <h4 class="oe-help-heading"><?php echo xlt("MedEx Communication Service"); ?><a href="#"><i class="fa fa-arrow-circle-up oe-pull-away oe-help-redirect" aria-hidden="true"></i></a></h4>
322 <p><i class="fa fa-exclamation-circle oe-text-orange" aria-hidden="true"></i> <strong><?php echo xlt("It is a commercial messaging module available to openEMR practices utilizing version 5.0.1 and higher"); ?>.</strong>
324 <p><?php echo xlt("MedEx automates Appointment Reminders and Recalls using phone calls, text messages and e-mails"); ?>.
326 <p><?php echo xlt("Replies from patients are displayed directly in your EHR"); ?>.
328 <p><i class="fa fa-exclamation-triangle oe-text-red" aria-hidden="true"></i> <strong><?php echo xlt("You need administrator privileges to enable the MedEx Communication Service"); ?>.</strong>
330 <p><?php echo xlt("Go to Administration > Globals > Connectors and check the Enable MedEx Communication Service check box and click Save"); ?>.
331 <button type="button" class="btn btn-default btn-sm btn-save oe-no-float"><?php echo xlt("Save"); ?></button>
333 <p><?php echo xlt("Refresh the Message Center or just reopen it"); ?>.
335 <p><?php echo xlt("A new tab sub menu will be visible at the top of the Message center page"); ?>.
337 <p><?php echo xlt("Click on the File menu item on the top left of the Message center page ansd select Setup MedEx"); ?>.
339 <p><?php echo xlt("It will take you to the MedEx sign-up page"); ?>.
341 <p><?php echo xlt("More information available at the openEMR MedEx wiki page"); ?>.
342 <a href="https://www.open-emr.org/wiki/index.php/MedEx" rel="noopener" target="_blank"><i class="fa fa-external-link text-primary" aria-hidden="true" data-original-title="" title=""></i></a>
344 <p><?php echo xlt("The features of a MedEx enabled installation are explained in this video"); ?>.
345 <a href="https://www.youtube.com/watch?v=4lbJCpfotAo" rel="noopener" target="_blank"><i class="fa fa-video-camera text-primary" aria-hidden="true" data-original-title="" title=""></i></a>
347 <p><?php echo xlt("SMS zone - This section lets use send and receive SMS texts"); ?>.
349 <p><?php echo xlt("It is also a subscription based service"); ?>.
350 </div>
351 </div><!--end of container div-->
352 </body>
353 </html>