Difference between revisions of "HOWTO Setup and Use OpenEMR Groups Module"

From OpenEMR Project Wiki
(adding new page content)
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
>> note, this doc is in the process of final editing; it is not in its final form. - HT
= Introduction =
= Introduction =


Line 11: Line 9:
However, unlike a patient appointment, group encounters are also associated with the records of the multiple patients who participate in that group's sessions so the session encounter is listed in each individual patient's own list of encounters. These group encounter summaries may contain individual free-text notes on that patient's participation in that group.
However, unlike a patient appointment, group encounters are also associated with the records of the multiple patients who participate in that group's sessions so the session encounter is listed in each individual patient's own list of encounters. These group encounter summaries may contain individual free-text notes on that patient's participation in that group.


This document is the result of my reverse engineering the use of the module and no code review was used. If I missed anything please let me know and I'll be happy to update the doc.
This document was composed by reverse engineering the operation of the module as found on a stock install of OpenEMR v5.0.2 (2) without resorting to viewing the code. If I missed anything please let me know and I'll be happy to update the doc.


* HTuck MI-Squared
* HTuck MI-Squared


= Procedure =
= Procedure =
Line 41: Line 37:


As an administrator- privileged user:
As an administrator- privileged user:
[[Image:gp01.png|border]]


1. From Main Menu: ''''Administration / Globals, Appearance'''' (default opening tab) - select: ''''Enable Group Therapy'''', 1/3 down the list.
1. From Main Menu: ''''Administration / Globals, Appearance'''' (default opening tab) - select: ''''Enable Group Therapy'''', 1/3 down the list.


[[Image:Gp01.png|border|center]]




Line 53: Line 46:




[[Image:gp02.png|border]]
2. On '/''' Globals, Calendar' '''tab, make sure the item, ''''Appointments - Group Summary - Number to Display'''' - is what you want.


2. On '/''' Globals, Calendar' '''tab, make sure the item, ''''Appointments - Group Summary - Number to Display'''' - is what you want.
[[Image:Gp02.png|border|center]]




Line 64: Line 57:




[[Image:grpacl.png|border]]
[[Image:Grpacl.png|border|center]]


The default active user permissions for Groups are not sufficient to fully use the group module. Move to 'Active' pane all the Groups ACLs for whichever user group will be assigned to work with this module, * Alternately, create a new user group named, perhaps, 'Group Therapist', containing all the 'Groups' ACLs. Then add that group to all users who will be using the module.
The default active user permissions for Groups are not sufficient to fully use the group module. Move to 'Active' pane all the Groups ACLs for whichever user group will be assigned to work with this module.
<br>
Alternately, create a new user group named, perhaps, 'Group Therapist', containing all the 'Groups' ACLs. Then add that group to all users who will be using the module.




Line 72: Line 67:




4. Survey of the Groups menu


 
[[Image:Gp04menu.png|border|center]]
[[Image:gp04menu.png|border]]
 
4. Survey Groups menu
 
 
 
Main menu: Groups * shows list of existing groups
* can search for groups if list is longer than display
* can filter closed groups out of display by 'Group type'




Main menu: Groups/ <br>
'Groups' -  shows list of existing groups
::* can search for groups if list is longer than display
::* can filter closed groups out of display by 'Group type'


'New' - create new group
'New' - create new group
Line 107: Line 98:




[[Image:gp06.png|border]]
[[Image:Gp06.png|border|center]]


1. 'Add group' tab opens (top of pic above)
1. 'Add group': tab opens (top of pic above)


2. Fill in its name: Vietnam Vets PTSD Group
2. Fill in its name: Vietnam Vets PTSD Group
Line 117: Line 108:
3. Type of Group: ''''Closed' is default-- Be sure to change this!'''
3. Type of Group: ''''Closed' is default-- Be sure to change this!'''


::''If left closed, the group may be fully created but it will be inoperative and you'll need to delete it and start again!''
::''If left closed, the group may be created and fully populated but it will be inoperative.  You'll need to delete it and start again!''


4. Obligatory Participation: set as desired
4. Obligatory Participation: set as desired
Line 125: Line 116:
6. Main Counselors: Ctrl+left click to select counselors of group
6. Main Counselors: Ctrl+left click to select counselors of group


''Main counselors must be EMR users''
::''Main counselors must be EMR users''


7. Notes: re: the nature of the group, or its mission, or whatever.
7. Notes: re: the nature of the group, or its mission, or whatever.
Line 131: Line 122:
8. Guest Counselors: this is freetext so can be anybody including non- EMR users
8. Guest Counselors: this is freetext so can be anybody including non- EMR users


9. Click 'Add Group' (oval lower left)
9. Click 'Add Group' (oval at lower left in pic above)
 
 
 
[[Image:gp07.png|border]]


Group panel displays with 'General Data' tab active (above)
::Group panel displays with 'General Data' tab active (above)


[[Image:Gp07.png|border|center]]






[[Image:gp03.png|border]]


=== Removing a group ===
=== Removing a group ===


Note that similar to a patient record, a Group cannot be deleted if it has been used at all, because it will contain patient information which is not allowed to be destroyed; per error message at top above (round rectangle). You may delete a group immediately after it has been created, for e.g., if an error was made in its configuration. Otherwise, its Type may only be set to 'Closed'.
Note that similar to a patient record, a Group cannot be deleted if it has been used at all, because it will contain patient information which is not allowed to be destroyed; per error message at top of the visible panel (round rectangle below). You may delete a group immediately after it has been created, for e.g., if an error was made in its configuration. Otherwise, its Type may only be set to 'Closed'.
 
- Closed groups remain on the group list


- Once group is closed it can not be reopened!
:*Closed groups remain on the group list


:*Once a group is closed it can not be reopened!
[[Image:Gp03.png|border|center]]


= Use =
= Use =
Line 168: Line 155:




1. Open the Group's General Data tab


[[Image:gp07.png|top]]
2. Click 'Adding' button at top right (oval top right below)


1. Open the Group's General Data tab
2. Click 'Adding' button at top right (oval top right above)


[[Image:Gp07.png|center]]


3. Fill out the event dialog in the same manner as scheduling a regular appointment


[[Image:gp08.png|top]]


3. Fill out the event dialog in the same manner as scheduling a regular appointment
[[Image:Gp08.png|center]]


::''See that documentation for instructions''
::''See that documentation for instructions''
Line 186: Line 172:






[[Image:Gp8a.png|center]]


[[Image:GP8a.png|top]]


4. Click in the 'Group' text area to activate a search tool to locate the group (round rectangle above)
4. Click in the 'Group' text area to activate a search tool to locate the group (round rectangle above)
Line 197: Line 182:




[[Image:gp08save.png|right]]
[[Image:Gp08save.png|center]]


5. Click 'Save' button at lower left of dialog (arrow)
5. Click 'Save' button at lower left of dialog (arrow below)




Line 214: Line 199:




[[Image:gp09.png|border]]
[[Image:Gp09.png|border|center]]


   
   
Line 220: Line 205:


6. The scheduled sessions are displayed in 'Group Appointments' at right of panel.
6. The scheduled sessions are displayed in 'Group Appointments' at right of panel.




Line 238: Line 216:
   
   


[[Image:gp10.png|border]]
[[Image:Gp10.png|border|center]]


2. Click 'Add' button (cursor arrow at right above)
2. Click 'Add' button (cursor arrow at right above)
Line 244: Line 222:
   
   


[[Image:gp10a.png|center|border]]
[[Image:Gp10a.png|border|center]]
''Participants panel expands down''
 
 
[[Image:gp12.png|border]]
3. Click in 'Participant's Name' text area (arrow above) which opens the name picker.
 
 
 


::''Participants panel expands down''






3. Click in 'Participant's Name' text area (arrow above) which opens the name picker.


[[Image:Gp12.png|border|center]]




Line 270: Line 243:




[[Image:gp12a.png|border]]
[[Image:Gp12a.png|border|center]]


Now: 'Participant's Name' is displayed<nowiki>;</nowiki>
Now:
:*'Participant's Name' is displayed


'Date of Registration' is current date by default; may be changed.
:*'Date of Registration' is current date by default; may be changed.


7. Add optional comment about participant in text area below name
7. Add optional comment about participant in text area below name
Line 282: Line 256:
   
   


[[Image:gp13.png|border]]
[[Image:Gp13.png|border|center]]


Participant's name with the comment is added to list
::Participant's name with the comment is added to list


Repeat from step 2 above to add all Participants
Repeat from step 2 above to add all Participants
Line 293: Line 267:
=== Indicate Group Status for Reports ===
=== Indicate Group Status for Reports ===


Some reports monitor visit and encounter data so you may want to indicate in the calendar that the session did occur. This is accomplished in the same basic manner as for a patient encounter.
Some OpenEMR reports monitor visit and encounter data so you may want to indicate in the calendar's event dialog that the session did occur. This is accomplished in the same basic manner as for a patient encounter.


   
   


[[Image:gp8b.png|right|top]]
[[Image:Gp8b.png|center|center]]
 


1. On the calendar, click the group session's time (oval at bottom, right)
1. On the calendar, click the group session's time (oval at bottom, right)


::''visually confirm you're looking at the 'Group' tab (arrow at top)''
::''visually confirm you're looking at the 'Group' tab (arrow at top)''




Line 308: Line 282:
2. Open the Status dropdown and select 'Took Place'  
2. Open the Status dropdown and select 'Took Place'  


(cursor arrow at right)
(cursor arrow at right below)




[[Image:Gp09tookplace.png|border|center]]


[[Image:gp09tookplace.png|border]]


3. Click on 'Current' to indicate that only this day's session took place, not all the rest of the scheduled sessions.
3. Click on 'Current' to indicate that only this day's session took place, not all the rest of the scheduled sessions.




Here's an example of this group session appearing in a report.<br>
This is 'Reports / Visits / Encounters' showing the group sessions that have been marked 'Took Place', and their participants, and any comments.




[[Image:Gp-encrpt.png]]




For example, this is 'Reports / Visits / Encounters' showing the group sessions that have been marked 'Took Place', and their participants, and any comments.
[[Image:gp-encrpt.png]]


=== Create Group Encounter Form ===
=== Create Group Encounter Form ===
Line 366: Line 305:
1. Either on the calendar click the group name...
1. Either on the calendar click the group name...


[[Image:gp14a.png|border]]  
[[Image:Gp14a.png|border|center]]  
 
 
 
 




Line 391: Line 326:
   
   


[[Image:gp14b.png|top]]... and arrive at the Group Details screen
[[Image:Gp14b.png|center]]
 
... and arrive at the Group Details screen




Line 398: Line 335:
   
   


[[Image:gp14c.png|border]]
[[Image:Gp14c.png|border|center]]
 


3. Set the date of service (round rectangle above)
3. Set the date of service (round rectangle above)
Line 410: Line 348:
   
   


[[Image:gp15a.png|border]]
[[Image:Gp15a.png|border|center]]


... and the encounter summary appears.
... and the encounter summary appears.
Line 422: Line 360:
   
   


[[Image:gp16.png|border]]
[[Image:Gp16.png|border|center]]


9. Add a comment on that patient's participation if desired (oval above)
9. Add a comment on that patient's participation if desired (oval above)
Line 432: Line 370:
   
   


[[Image:gp17.png|top]]
[[Image:Gp17.png|center]]




Line 441: Line 379:
   
   


[[Image:gp18.png|border]]
[[Image:Gp18.png|border|center]]


=== View a patient's participation note ===
=== View a patient's participation note ===
Line 449: Line 387:




[[Image:gp19.png|top]]
[[Image:Gp19.png|center]]


2. Click the 'Edit' button...
2. Click the 'Edit' button...
Line 457: Line 395:
   
   


[[Image:gp20.png|top]]
[[Image:Gp20.png|center]]


3. ... and read the participant's group encounter summary for that session (cursor arrow above) in 'Reason for Visit' text area.
3. ... and read the participant's group encounter summary for that session (cursor arrow above) in 'Reason for Visit' text area.

Latest revision as of 03:23, 29 February 2020

Introduction

OpenEMR's Groups module makes it possible to document patients' participation in group sessions.

NOTE: these 'groups' are not related to the user role groups seen in ACL contexts. These groups can be used for any kind of group gathering, for any number of patients. They may have assigned to them any number of 'Main Counselors' and any arbitrary list of 'Guest counselors'.

Individual groups are managed by the EMR in a similar fashion as a patient is, in that when you're working with a particular group, its name and group ID is displayed where a patient's name and PID is in the patient record interface. Like a patient, it has its own dropdown list of past encounters, and a group session appointment is added to the Main Counselors(s) calendar similarly to a patient's appointment. Also group activities are 'contained' in a summary 'group encounter' form for the date the group session occurred, similar to the events are that occur during a patient's appointment.

However, unlike a patient appointment, group encounters are also associated with the records of the multiple patients who participate in that group's sessions so the session encounter is listed in each individual patient's own list of encounters. These group encounter summaries may contain individual free-text notes on that patient's participation in that group.

This document was composed by reverse engineering the operation of the module as found on a stock install of OpenEMR v5.0.2 (2) without resorting to viewing the code. If I missed anything please let me know and I'll be happy to update the doc.

  • HTuck MI-Squared

Procedure

This document is divided into the following sections:

Setup

A. Configure EMR/ User
B. Create group

Use

C. Schedule group sessions
D. Add group participants
E. Document group activity


Setup

A. Configure EMR/ ACLs

As an administrator- privileged user:

1. From Main Menu: 'Administration / Globals, Appearance' (default opening tab) - select: 'Enable Group Therapy', 1/3 down the list.

Gp01.png



2. On '/ Globals, Calendar' tab, make sure the item, 'Appointments - Group Summary - Number to Display' - is what you want.

Gp02.png



3. Update user group ACL


Grpacl.png

The default active user permissions for Groups are not sufficient to fully use the group module. Move to 'Active' pane all the Groups ACLs for whichever user group will be assigned to work with this module.
Alternately, create a new user group named, perhaps, 'Group Therapist', containing all the 'Groups' ACLs. Then add that group to all users who will be using the module.



4. Survey of the Groups menu

Gp04menu.png


Main menu: Groups/
'Groups' - shows list of existing groups

  • can search for groups if list is longer than display
  • can filter closed groups out of display by 'Group type'

'New' - create new group

'Group Details' - edit parameters of groups.

(Shows same display as if a group is selected from Groups list)

Visits - operations related to visit (encounter) summaries of the currently selected group. Most functions also available from group summary display

/ create visit - create an encounter summary for the current group
/ current - displays the group summary of the currently selected group
/ visit history - displays the selected group's list of visit (encounter) summaries


B. Create A Group

From Main Menu, click 'Groups / New'


Gp06.png

1. 'Add group': tab opens (top of pic above)

2. Fill in its name: Vietnam Vets PTSD Group

Date of group creation is 'Starting Date' by default

3. Type of Group: 'Closed' is default-- Be sure to change this!

If left closed, the group may be created and fully populated but it will be inoperative. You'll need to delete it and start again!

4. Obligatory Participation: set as desired

5. Status: Active, Finished, Canceled. Set as appropriate

6. Main Counselors: Ctrl+left click to select counselors of group

Main counselors must be EMR users

7. Notes: re: the nature of the group, or its mission, or whatever.

8. Guest Counselors: this is freetext so can be anybody including non- EMR users

9. Click 'Add Group' (oval at lower left in pic above)

Group panel displays with 'General Data' tab active (above)
Gp07.png



Removing a group

Note that similar to a patient record, a Group cannot be deleted if it has been used at all, because it will contain patient information which is not allowed to be destroyed; per error message at top of the visible panel (round rectangle below). You may delete a group immediately after it has been created, for e.g., if an error was made in its configuration. Otherwise, its Type may only be set to 'Closed'.

  • Closed groups remain on the group list
  • Once a group is closed it can not be reopened!
Gp03.png

Use

C. Schedule group sessions

At this point you may schedule its sessions.

Note, this step may be performed from the Calendar display,
just be sure to select the 'Group' tab

It appears that the group appointment may be added to all of the official counselors' calendars, not only the lead counselor. But each counselor's scheduled appointment must be handled individually, for example if that counselor will be listed in reports that they led a group.

From Main Menu select 'Groups/ Groups/ ' and click on the desired group (not pictured)


1. Open the Group's General Data tab

2. Click 'Adding' button at top right (oval top right below)


Gp07.png

3. Fill out the event dialog in the same manner as scheduling a regular appointment


Gp08.png
See that documentation for instructions

Presumably this will be a repeating appointment, as pictured.



Gp8a.png


4. Click in the 'Group' text area to activate a search tool to locate the group (round rectangle above)



Gp08save.png

5. Click 'Save' button at lower left of dialog (arrow below)








Gp09.png



6. The scheduled sessions are displayed in 'Group Appointments' at right of panel.



D. Add participants to group

1. In the group details panel click 'Participants' tab (black oval below)


Gp10.png

2. Click 'Add' button (cursor arrow at right above)


Gp10a.png
Participants panel expands down


3. Click in 'Participant's Name' text area (arrow above) which opens the name picker.

Gp12.png



4. Enter part of name (arrow top right above)

5. Click 'Search' (oval)

6. Select name from list (rectangle)


Gp12a.png

Now:

  • 'Participant's Name' is displayed
  • 'Date of Registration' is current date by default; may be changed.

7. Add optional comment about participant in text area below name

8. Click button 'Adding a Participant' (arrow above)


Gp13.png
Participant's name with the comment is added to list

Repeat from step 2 above to add all Participants


E. Document group activity

Indicate Group Status for Reports

Some OpenEMR reports monitor visit and encounter data so you may want to indicate in the calendar's event dialog that the session did occur. This is accomplished in the same basic manner as for a patient encounter.


Gp8b.png


1. On the calendar, click the group session's time (oval at bottom, right)

visually confirm you're looking at the 'Group' tab (arrow at top)


2. Open the Status dropdown and select 'Took Place'

(cursor arrow at right below)


Gp09tookplace.png


3. Click on 'Current' to indicate that only this day's session took place, not all the rest of the scheduled sessions.


Here's an example of this group session appearing in a report.
This is 'Reports / Visits / Encounters' showing the group sessions that have been marked 'Took Place', and their participants, and any comments.


Gp-encrpt.png


Create Group Encounter Form

Unlike the option that exists for a regular patient appointment the Groups module will not create a group encounter form when a group session is marked as 'Taken Place'. A suitably privileged staff will need to manually create one for a session for it to appear in reports and in the participants' records.

1. Either on the calendar click the group name...

Gp14a.png









... or from the main menu select 'Groups / Groups' then select the group name (not pictured)...


Gp14b.png

... and arrive at the Group Details screen


2. Click button 'Add Encounter' (round rectangle at top) to show the group encounter form.


Gp14c.png


3. Set the date of service (round rectangle above)

(it will default to the date you are making the encounter form)

4. Enter a comment on the group proceedings if desired (cursor arrow)

5. Click 'Save' (oval lower left)...


Gp15a.png

... and the encounter summary appears.

6. Click the 'Clinical' encounter menu item (oval above)

7. Select 'Group Attendance Form' in 'Clinical' menu list (cursor arrow above)

8. Select each participant's 'Status in the meeting' dropdown (cursor arrow below)


Gp16.png

9. Add a comment on that patient's participation if desired (oval above)

10. Click 'Save' at lower left (round rectangle)

The session summary appears on the group encounter summary. The summary's date reflects when the encounter summary was created, and shows the session date in the 'Group Attendance Form' section (round rectangle below).


Gp17.png


Each patient's group sessions appear in their encounter list

and 'Past Encounters and Documents' list (rectangles below).


Gp18.png

View a patient's participation note

1. Click the session's listing in 'Past Encounters and Documents' (blue rectangle above) to display the patient's encounter summary.


Gp19.png

2. Click the 'Edit' button...

Note that similar to a regular encounter summary, group session encounters may be e-signed, which will register them in the relevant reports.


Gp20.png

3. ... and read the participant's group encounter summary for that session (cursor arrow above) in 'Reason for Visit' text area.


Conclusion

The Groups module adds to OpenEMR the capability to log and track patients' participation in any sort of group session. Sessions are documented in a way that includes the data in reports and other EMR functions in the same manner as a regular patient appointment.