Wiki Spaces

Documentation
Projects
Resources

Get Help from Others

Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack

Documentation

Page tree
Skip to end of metadata
Go to start of metadata

Overview

A patient list is a dynamically populated list of patients that meet some set of selection rules. These lists are viewable on the Patient Lists page and are generated on-demand, when a list is requested. The selection rules utilize patient information (that is; patient details, patient attributes, visit details, and visit attributes) along with a comparison value and a value to compare against. For example, a list can be created to show all patients with an active visit that have a last name starting with “br”. The patient list item display templates (header and body) can use patient information along with basic HTML tags to customize the appearance of the patient list items.

Administrators create and manage the patient lists via the Manage Patient Lists page. Each list must have a unique name one or more selection rules. The list can optionally have a description, item header template, item body template, and ordering fields. 


Feature Summary

Customizable Patient Lists   

A patient list is defined through a set results that satisfy a specified set of rules. Administrators create and manage the patient lists via the Manage Patient Lists page. These lists are viewable on the Patient Lists page and are generated on-demand, when a list is requested.  Each list must have a unique name one or more selection rules. The list can optionally have a description, item header template, item body template, and ordering fields.  

Selection Rules 

A list selection rule is used to select which patients will appear in the list and has three parts:

    1. The patient information field

    2. The comparison type (equals, not equals, starts with, contains, is defined, is not defined, etc)

    3. An optional comparison value or field

Screenshot showing the rule definition for a patient list

The Add/Edit Patient List page will provide a simple UI to create selection rules and have dropdowns populated with all the patient information fields. When calculating the patients to include in a list, the selection rules will be transformed into HQL that will return the appropriate patients.

 Display Templates

The appearance of each patient item on the patient list is customizable via display templates. Each list can define a header and body display templates. The header template is used to set the appearance of the single-line patient item header while the body template is used to set the appearance of the patient item body. If no display templates are defined the default templates will be used. The template can use basic HTML tags along with any of the patient information fields to create the format needed. Each patient list item has two parts:

    1. List Item Header

    2. Optional List Item Body

 Screenshot showing how to define a template to be used for a patient list

 

Ordering

The ordering of the patient list can optionally be defined as part of the list definition by adding one or more ordering fields using the patient information fields. If no patient list order is defined the default ordering will be used.

Screenshot showing results ordering form for a patient list

 

Patient Information

The patient information fields can reference any of the following fields:

    • Patient Details
    • Patient Attributes
    • Patient Visit Details
    • Patient Visit Attributes

Requirements

  • OpenHMIS Commons Module version 3.2+
  • OpenMRS Reference Application version 2.3.1+

https://modules.openmrs.org/#/show/276/openhmis-patient-list-module

 



 

 


  • No labels