OpenEMR 7 The Dashboard Context Manager

From OpenEMR Project Wiki

Introduction

OpenEMR's patient dashboard is packed with informational panels known as 'widgets', which display summaries of all the clinical information gathered for each patient. In many cases, a particular clinical role (called here a 'context') may not use some of the widgets, and the visual clutter can be distracting. The Dashboard Context Manager (called in this document the 'DCM') is a tool to control which widgets are visible to a user, based on 1) administrator-configured defaults of the user's context and 2) user preferences.


The DCM is packaged with OpenEMR v7.0.4+ as an optional module which is not enabled by default. As soon as it is enabled it may be used with its default contexts and user roles, etc. However, the practice Administrator may want to configure it to the practice's needs before users get accustomed to the default settings.


To begin this document, let's assume the system is configured and jump right into a users' 'Quick Start Guide' on the basics of operating the Context Manager. The Administrators’ Module setup and configuration will follow.


Quick Start Guide

On the patient's dashboard the logged- in user's default context will be displayed.



Select Context

This may reflect the user’s job in the practice, or perhaps a speciality the patient is assigned to in a multidisciplinary setting.

  • It may be changed depending on the context of the current patient
  • The dashboard widgets displayed for this user will be as specified in the context.
  • Select it in the 'Context' drop-down.
  • Click the gear button (arrow in image above)
  • Context settings panel opens (see below)

You may choose the widgets that this user will see when working in this context.

1. In the left of the panel select the checkboxes of the widgets to be displayed
2. Click orange button at lower left to change all context contents back to their defaults.
3. When done click 'Save Settings' at lower right (oval)


Create A Custom Context

Alternatively, a user may create a custom context for their own future use

  • Note, custom contexts created by users are not seen by other staff unless specified by an admin.


To create a custom context:

1. Click the 'Create Context' (arrow below)

2. Enter the name and freetext description in the text areas in right half of panel

3. Select the desired widgets in left side

4. Click 'Save Changes' at lower right



see new one at bottom of context drop-down on dashboard.

Dashboard Context Manager – Admin Setup

A couple things to know ahead of time:

  • A user with OpenEMR Administrator privileges is required for any DCM module setup or configuration
  • The OpenEMR global setting found from the system menu at, 'Admin/ Config/ Appearance', named 'Hide selected cards on patient dashboard' will determine which widgets (also called 'cards') you have to work with in the DCM. Set those first.
  • You should plan which user roles your users will have , though the feature can be used with the defaults until you determine this. See 'User Roles' section below for more discussion.
  • Plan which widgets you want each user role to see and be able to work with.


Install the Dashboard Context Manager module

In the OpenEMR main menu open the module manager and see the uninstalled Dashboard Context Manager module:


Install the Dashboard Context Manager module in the standard manner.

1. Click 'Install' (oval above, ignore SQL button)

2. Button changes to 'Enable' (oval below)

  • Click it

  • When installed the module’s listing should look like this:



3. Log out of OpenEMR and log back in to see DCM on main Admin menu

4. Open DCM for configuration from the main menu

  • No patient record needs to be open for these Admin activities


Administrator Features

Note: These features only appear on OpenEMR's 'Admin' menu, therefore require administrative privileges to perform


Dashboard Context Manager

In each of the four tabs we have a DCM Administrator function, see numbered sections

Tab 1: Contexts

Lists all current contexts (see above)

  • Shows default 'System' contexts that are permanent, can't be edited.
  • The custom contexts have icons: pencil to edit, trash can to delete.
  • Remember, the widgets in each context are determined for that user from the context gear in the patient’s dashboard.



Button: Create New Context


1. Click the button, name the context

2. Leave the Context Key empty unless you know better

3. Freetext description of its function

4. Select which widgets will be displayed in this context.

  • New feature: (oval lower left) select the checkbox if this context will be ‘Available to all users’




Button: Export

Click to save (rectangle at right) in a .json file containing any new, non-default contexts that have been added to the system.

  • Will be placed in your browser's default download directory (arrow)




Button: Import

Click for a file load dialog loaded with a list of the json files in your browser’s download directory

  • Select one, import, see 'Alert [number of'] contexts imported.
  • They should then be present for use (as 'Custom Context1' is shown in earlier DCM image



Tab 2: User Assignments

Search options:

'Facility' - limit the selection to users in one practice facility

'User Type' – NOTE: at this point this list is a scheme of grouping users by arbitrary clinical roles. It is unrelated to and does not interact with the 'user type' lists found in OpenEMR's User Profile or the Address Book. The list may be editable in the future but for now should just be used as a static collection, or not used until the feature is developed further.

'Search' - enter name to look for one particular user; handy when you have a large staff roster.


1. If assigning one user’s context select the checkbox next to the user's name (oval above)
2. Click ‘Actions’ button in column at right
  • Assign Context panel appears
  • Note the ‘Lock Context’ checkbox if the user is to be prevented from removing themselves from this context
  • To assign multiple users select the checkboxes next to each name then click blue 'Bulk assign' button (arrow below)
  • Click ‘Assign to all’



Tab 3: Role Defaults

The context a user begins a session in for each user type

1. Select the user type’s context from drop-down (below)

2. Click ‘action’ button to right

3. Click ‘Assign’

  • may be changed freely
  • again, at this time these roles only apply to the user roles specific to the user context mgr, not to the user ACLs of the same names in the EMR.



Tab 4: Statistics

Shows how many of each context have been assigned




Conclusion

See the forum post for a direct link to the developer’s User Guide from which the content below was directly lifted (Thanks JerryP!)

Best Practices

For Clinical Staff:

  1. Choose the right context before reviewing a patient - it helps focus your attention
  2. Customize sparingly - the defaults are designed for typical workflows
  3. Create custom contexts for recurring specialized workflows
  4. Use Emergency context for urgent situations - it shows only critical information


For Administrators:

  1. Set role defaults to give users appropriate starting contexts
  2. Use locking judiciously - only when context consistency is required
  3. Create global custom contexts for organization-specific workflows
  4. Review audit logs periodically for unusual context changes
  5. Train users on context switching during onboarding


Keyboard Shortcuts

Currently, context switching is done via the drop-down selector. Future versions may include keyboard shortcuts for rapid context switching.


FAQ

Q: Will switching contexts affect other users? A: No. Your context selection and customizations are personal to your user account.

Q: Can I have different contexts for different patients? A: Currently, context is per-user, not per-patient. However, you can quickly switch contexts when moving between patients with different care needs.

Q: Do context changes affect the medical record? A: No. Context only affects what you see on the dashboard. It does not modify any patient data.

Q: Can I share my custom context with colleagues? A: Ask your administrator to make your custom context "global" so others can use it.

Q: What happens if a widget I've hidden contains important alerts? A: Critical alerts and clinical decision support reminders should be configured to display regardless of context. Consult your administrator about alert visibility settings.


Version Information

  • Module Version: 1.0.0
  • Minimum OpenEMR Version: 7.0.4
  • PHP Requirement: 8.1+



Support

For questions, issues, or feature requests:* OpenEMR Forums: community.open-emr.org



Credits

Developed by Jerry Padgett ([email protected]) for the OpenEMR community.

Licensed under GNU General Public License v3.

In this document, images and additional text by Harley Tuck/ MI-Squared

Retrieved from "https://www.open-emr.org/wiki/index.php?title=OpenEMR_7_The_Dashboard_Context_Manager&oldid=36872"