Configuring Reports
Overview
DRC Reports bundles reports defined and evaluated by the OpenMRS Reporting module.
It bundles two groups of reports:
All-use reports that are activated by default or
Use-case specific reports that need to be explicitly activated through Initializer's 'jsonkeyvalues'.
DRC General use reports (always activated)
List of Embedded Reports:
Below is a list of reports that are always activated;
Patient History - an easy-to-read report of the entire patient file, or sections of the patient file, rendered as a PDF and that is printer friendly.
Data Extracts reports - those are flattened tables provided as CSV extracts and available for various domains of OpenMRS data model
Appointments
Concepts
Conditions
Diagnoses
Encounters
Observations
Orders
Patients
Programs
Visits
Use-case specific reports Overview
As mentioned above, these reports need to be explicitly activated through Initializer's 'jsonkeyvalues'. The module exposes runtime key-values configuration parameters through JSON files in configuration/jsonkeyvalues. The illustration below is a perfect example of the explicit activation of a use case specific report under the initializer jsonkeyvalues. This example is drawn from here it illustartes the use case specific reports for the AntenatalReport. The key is set to true for all the corresponding JSON values for the various use cases of the Antenatal report such.
{
"report.MSPP.antenatal.active": "true",
"report.MSPP.antenatal.gestationDuration" : "0-13,14-27,28-40,Total",
"report.MSPP.antenatal.numberOfWeeks" : "73099ba8-73c7-4427-a973-76fc1e4d4120",
"report.MSPP.antenatal.estimatedGestationalAge" : "9e071d37-ee01-4785-a756-7e4059ffe736",
"report.MSPP.antenatal.ferrousFolate":"d1274833-6c0e-480c-9c0a-b656156e6e7f",
"report.MSPP.antenatal.chloroquine":"b48e38a8-b121-4cdf-91b9-469acd99273b",
"report.MSPP.antenatal.drugOrder":"16bb6bcf-2e81-4ba5-8583-ff4913201a72",
"report.MSPP.antenatal.prenatalVisitType":"35ba9aff-901c-49dc-8630-a59385480d18",
"report.MSPP.antenatal.otherVisitTypes":"c4643116-8a61-499f-b62b-ff9375db0b7d,91c6bdce-3b92-42a2-9fa8-6ef6b169c4b2,a631dbbc-daa4-48aa-8fe4-3b5784360ab1,b9ba7b27-e64b-44d1-b4c5-2ced77f477d0,ad29e858-68a1-44eb-ae62-94157a8a52b0,929fb1a1-d801-4b56-9d15-503685a6c49d",
"report.MSPP.antenatal.riskyPregnancy" : "d291cf12-a568-4eec-9f86-9ef55333c3b2",
"report.MSPP.antenatal.codedDiagnosis" : "a92807d9-bbe9-4874-aa6b-86c531fb6efd",
"report.MSPP.antenatal.anemiaIronDeficiency" : "3cd85716-26fe-102b-80cb-0017a47871b2",
"report.MSPP.antenatal.malaria" :"508c9da4-56f9-4129-9a0e-766fb8e74f3e",
"report.MSPP.antenatal.positive": "7acfafa4-f19b-485e-97a7-c9e002dbe37a",
"report.MSPP.antenatal.onePlus": "e7c0fefc-96e8-4ccb-b24b-92ec2024f579",
"report.MSPP.antenatal.twoPlus": "9f14f988-be10-419b-b947-0508664b7ef2",
"report.MSPP.antenatal.threePlus": "a979848e-4b09-4319-bdd5-ce7d38e0b686",
"report.MSPP.antenatal.fourPlus": "30c7d366-2192-45bf-a0df-112258bc0c1e",
"report.MSPP.antenatal.midUpperArmCircumference" : "f074942b-666b-4ca3-9f0e-1103128b3ae2",
"report.MSPP.antenatal.visitNumber" : "c4b48a7a-7c13-4e7d-89ad-1df68c5c6802",
"report.MSPP.antenatal.one" : "929e9a36-fdfa-42a3-a416-64be037c3155",
"report.MSPP.antenatal.two" : "a82e292b-7bd3-4bf1-b6d8-d89c8b8cabff",
"report.MSPP.antenatal.three" : "877b6c50-7960-4be6-862f-c9ffd2f65afb",
"report.MSPP.antenatal.four" : "d29d0005-5e23-48cd-86ac-1ff9cd36dd13",
"report.MSPP.antenatal.fivePlus" : "3098581b-4ce3-4064-8e87-facb1d7a5ff5",
"report.MSPP.antenatal.yes" :"bf885a9d-9f98-4990-8c20-ac4ace816bfe"
} DRC Use-case specific reports
The DRC implementation use-case specific reports are found in this repository under this folder.
DRC Reports holds a hard dependency on Initializer ⇒ both modules need to be installed for DRC Reports to work properly.
Use-case specific reports Configuration
To configure a report, an implementor is required to set to true the key-value for the specific under this folder. In the illustration below, the ConceptsReportManager is clicked.
The boolean key-value in the initializer service has been set to true. This will allow for the report to be generated successfully.
In the illustration below, the MSPPChronicIllnessesReportManager is clicked.
The boolean key-value in the initializer service has been set to false. Therefore, this will not allow the report to be generated successfully.