Overview

The Reporting Module was designed to provide a feature-rich and 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 so that other developers can use the framework to implement new features.

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 in planning. For information on how to build Row-Per-Patient reports, see Building Row-Per-Patient Reports in OpenMRS or Building Reports for Developers.

Indicator Reports

Indicator reports aggregate groups of people for each question. Below is a Period Indicator Report, a type of indicator report. The answer to each question is itself a link to the underlying members of the group that fulfills the question.

For information on how to build indicator reports, see Building Indicator Reports in OpenMRS
or Building Reports for Developers.

Limitations

Right now reporting compatibility is used to bridge the gap between the old and new e.g. cohort builder, data exports. This reporting module has a lot of the core features for evaluating parts of a report but doesn't have a good UI yet for designing a full report. Cohort builder is probably best for adhoc querying unless there's something in there that isn't supported then you'd have to use the cohort query editor in the reporting module. Data exports can only be designed/exported using reporting compatibility. There's a feature in this module that let's you define some simple dataset definitions like a SQL-based dataset but we ripped out a lot of the other ones we were working on. So this module and the reporting compatibility are complementary at the moment.