OpenMRS Reporting Documentation Refresh

Development
1

I documented how to create reports in OpenMRS here:
Creating Reports in OpenMRS

and I consolidated and cleaned up other reporting-related docs based on older pages here:
Reporting overview

There are basically 3 ways to create reports:

1. Configuration-based reports

Defined using YAML config files + SQL via the initializer.

Docs:
Configuration-Based Reporting with OpenMRS Initializer

Reference implementation used:
PIH report descriptors

2. Programmatic reports

Defined in Java code inside OpenMRS modules.

Docs:
Programmatic Reporting in OpenMRS

Reference implementation used:
PATH DRC reports module

3. UI-defined reports

Created via the OpenMRS web UI.

:warning: This approach is deprecated. Some parts still work, some don’t, so I’ve added a clear use-at-your-own-risk warning in the docs.

I also consolidated and cleaned up other reporting-related docs based on older pages here:
Reporting overview

Feedback request

I’d especially love feedback on programmatic and config-based reports:

Any nitpicks, corrections, or “this part is confusing” feedback is very welcome! :heart:

cc: @dkayiwa @burke

2 Likes
2

Thanks @jayasanka . Do you have any clue about report Data Visualizer. Some implementations are finding report data visualizer so relevant and i think we need to adopt it which we havent adopted that much.

3

@sharif I’m not sure what you mean by the “report Data Visualizer”, but this is documentation on how to create reports and run them. Data visualizations and that sort of thing are not part of that scope, though you could build data visualizations on top of the reporting framework, but it’s probably better to use something like Superset or Metabase with a separate reporting database.

1 Like
4

Hey @ibacher . In OpenMRS 2.X We had something like Report Chart Visualization and i guess this is same thing METS tried out here , i believe its still relevant in some of the implementations.

5

So there’s already a view (in the System Administration part of O3) for showing reports and running them that has similar functionality to the O2 app that was part of the community. That’s kind of separate from the thing METS built which is doing something different.

1 Like
6

Thanks @ibacher