Home

General Usage

General conventions, including authentication are documented at REST Web Services API For Clients.

All resources are relative to /ws/rest/v1/reportingrest/ on your OpenMRS server. For example, the cohort resource on the OpenMRS demo server is at https://demo.openmrs.org/openmrs/ws/rest/v1/reportingrest/cohort.

The Reporting REST resources are case-sensitive, as documented here. (They do not follow the same casing convention as the core OpenMRS ones, which are all lowercase.)

Background

See the Reporting Module documentation on the OpenMRS wiki.

As a first step you should read the Background and Terminology page.

Resources

The API includes the following resources:

• Definition Libraries
  • definitionlibrary - built-in definitions
• Cohorts
  • cohortDefinition - user-defined saved cohort definitions
  • cohort - evaluates a cohort definition
• Data Sets
  • dataSetDefinition - user-defined saved dataset definitions
  • dataSet - evaluates a dataset definition
• Reports
  • reportDefinition - user-defined saved report definitions
  • reportdata - evaluates a report
  • reportRequest - schedules a report to be evaluated (asynchronously)
• Ad Hoc Analysis
  • adhocquery - evaluates an ad-hoc row-per-object dataset
  • adhocdataset - saves an ad-hoc row-per-object dataset for use elsewhere in the reporting module