Reporting module in openmrs
Java JavaScript Other
Latest commit 83e57b0 Jan 18, 2017 @mseaton mseaton REPORT-784 - Age Cohort Definition does not properly handle boundary …
…conditions for birthdates

README.md

Build Status

Reporting Module

Overview

The Reporting Module was designed to provide a feature-rich, user-friendly web interface for managing reports within OpenMRS. In addition, the Reporting Module provides a flexible and extensible API that module developers can develop against to build their own reports and tools. The core idea behind the Reporting Module is to provide a solid foundation for other developers to use the framework and implement new features.

Download

We encourage all OpenMRS users and developers to download the reporting module, use it frequently, create new tickets for bug fixes and feature requests, and provide feedback on OpenMRS Talk.

Requirements

OpenMRS 1.5.2 or higher

Required Modules:

  1. HTML Widgets 1.5.5
  2. Serialization XStream 0.1.8.1

Recommended modules:

  1. Reporting Compatibility 1.5.0.3

View, download or fork source code: on GitHub

Installation

To install the Reporting Module download the Reporting Module .omod (above), along with its dependencies (see box above) and upload them into your system.

Upgrade

To upgrade from Reporting Module 0.3.x:

  1. Check to make sure that you have all of the Required Modules installed on your system.
  2. Log into OpenMRS
  3. Navigate to Admin > Manage Modules.
  4. Click the trash icon next to Reporting 0.3.x to remove the module from your system.
  5. Navigate to the newer omod on your system using the browse button and click Upload.

Privileges

In order for users to be able to run most reports you need to put them in a group with the following privileges: (this is accurate as of 0.4.1.2)

  1. View Reports
  2. Run Reports
  3. View Patient Cohorts (technically this is only required if you want to be able to run reports including cohorts of patients, which is basically all reports, up until 0.4.1.1)
  4. Manage Scheduler

To be able to edit and configure reports, you need groups: (this is accurate as of 0.4.1.3)

  1. Manage Reports (this just enables you to see the menu items)
  2. Manage Report Definitions
  3. Manage Data Set Definitions
  4. Manage Indicator Definitions
  5. Manage Dimension Definitions
  6. Manage Cohort Definitions
  7. Manage Report Designs

You also need to grant view privileges related to the base objects your reporting definitions use. For example you need "View Programs" to create and use an "In Program" Cohort Query

Report Types

There are many different types of reports, but these can be categorized into two main types.

Row-Per-Domain Object Reports: These reports export data in a multi-column format where each row represents the object and each column represents an attribute associated with the object. Currently, only Row-Per-Patient reports are natively supported but more objects (for example Row-Per-Encounter and Row-Per-Program) are planned to be included.

Indicator Reports: Indicator reports aggregate groups of people for each question. Below is a Period Indicator Report. Each row contains a question and the corresponding column contains the answer. The answer to each question is a link to the members of the group that can respond to the said question.

Limitations

Currently, reporting compatibility is being used to bridge the gap between the old and new (e.g., combining cohort builder and data exports). This reporting module has many core features for evaluating parts of a report but does not have a good UI for designing a full report.

Cohort builder is best for adhoc querying, though for unsupported data entry, you must use the cohort query editor in the reporting module. Data exports can only be designed/exported using reporting compatibility. This module contains a feature that allows you to define simple dataset definitions, such as a SQL-based dataset, but other definitions are not available.

Project Resources

Wiki page

View/download source code for Reporting Module