Definition Library - openmrs/openmrs-module-reportingrest GitHub Wiki

There are built-in queries available in "Definition Libraries". Some are included in the Reporting module, and others may be defined in other modules.

definitionlibrary

Lets you browse the built-in queries available in Definition Libraries.

GET .../definitionlibrary/:key

Gets details of the definition with a given :key. (This does not provide any additional information versus the queries that list all.)

GET .../definitionlibrary?q=cohort

Lists Cohort Definitions in all definition libraries.

Sample response:

{
  "results": [
    {
      "type": "org.openmrs.module.reporting.cohort.definition.AgeCohortDefinition",
      "key": "reporting.library.cohortDefinition.builtIn.atLeastAgeOnDate",
      "name": "reporting.library.cohortDefinition.builtIn.atLeastAgeOnDate.name",
      "description": "reporting.library.cohortDefinition.builtIn.atLeastAgeOnDate.description",
      "parameters": [
        {
          "name": "effectiveDate",
          "label": "reporting.parameter.effectiveDate",
          "type": "java.util.Date",
          "collectionType": null,
          "defaultValue": null,
          "required": true,
          "widgetConfiguration": null,
          "expression": "${effectiveDate}",
          "labelOrName": "reporting.parameter.effectiveDate",
          "widgetConfigurationAsString": ""
        },
        {
          "name": "minAge",
          "label": "reporting.parameter.minAgeInYears",
          "type": "java.lang.Integer",
          "collectionType": null,
          "defaultValue": null,
          "required": true,
          "widgetConfiguration": null,
          "expression": "${minAge}",
          "labelOrName": "reporting.parameter.minAgeInYears",
          "widgetConfigurationAsString": ""
        }
      ]
    },
    {
      "type": "org.openmrs.module.reporting.cohort.definition.GenderCohortDefinition",
      "key": "reporting.library.cohortDefinition.builtIn.females",
      "name": "reporting.library.cohortDefinition.builtIn.females.name",
      "description": "reporting.library.cohortDefinition.builtIn.females.description",
      "parameters": []
    }
  ]
}

GET .../definitionlibrary?q=dataSet

Lists Data Set Definitions in all definition libraries. (Since 1.8.0)

GET .../definitionlibrary?q=patientData

Lists Patient Data Definitions in all definition libraries.

GET .../definitionlibrary?q=encounterQuery

Lists Encounter Query Definitions in all definition libraries.

GET .../definitionlibrary?q=encounterData

Lists Encounter Data Definitions in all definition libraries.