Release Version 0.83

Bahmni has Reports app or module. The Report app is enabled based on privilege. You can access the Reports app from Home dashboard. Generally, Admin user will have the privilege for reports app. When the user enter into report app, the user will see a list of configured reports. The user can launch any of the report with Start & End date, output format.

Every Bahmni implementation has its own config module. So, an implementer has to configure the required reports properly so that reports app will show all the configured ones. The configuration file is located at openmrs/apps/reports directory of the config module.

1. Standard Reports useful to management level people
2. Extract data from backend database to analyse various facts for different stockholders

1. HTML
2. PDF
3. EXCEL
4. Custom EXCEL (Excel with pre-defined macro)
5. CSV
6. ODF (Openoffice format)

1. Canned Reports
2. Custom SQL
3. Jasper Reports
4. Generic reports (latest development in reports module)

These reports meant to give specific or predefined information from Bahmni. There are minimal configuration available for these reports. Whenever new requirement from Client, even though there is a similarity in the existing report, we cannot reuse it. Hence Bahmni system end up with new canned reports and its makes more maintenance. So, there is Generic Reports which will eventually hoping to solve the problem.

Reference tables

• Bahmni allows one to setup multiple type of age groups each with a name. Each report configuration can use their own age group by specifying their name in the configuration.

For example:

The report given below shows counts based on age-groups.

To display reports like this, you should insert age group configurations into the reference table "reporting_age_group" and then reference that from the report configuration.

Configuration

"nutritionProgram": {

"name": "Nutrition Program - <5 years children receiving (Vitamin A)", "type": "obsCount", "config": { "ageGroupName": "Nutrition Program Vitamin A", "conceptNames": ["Childhood Illness, Vitamin A Capsules Provided"] }

}

You can insert entries into reporting_age_group using SQL commands. Given below a set of example INSERT SQL commands.

INSERT INTO reporting_age_group (name,report_group_name, min_years, min_days, max_years, max_days) VALUES ('6 - 11 months', 'Nutrition Program Vitamin A',0,180,1,-1);

INSERT INTO reporting_age_group (name,report_group_name, min_years, min_days, max_years, max_days) VALUES ('12 - 59 months', 'Nutrition Program Vitamin A',1,0,5,-1);

• For certain reports one can also set some reference range for concepts.

There are three variants of this.

N.B:- If you are giving more than one concept name in the config, please make sure that all of them are of same data type, (Either coded concept or boolean concept). If a mix of datatypes are provided, it will always generate obs count report.

Use this, if you just want to count the number of observations created for a concept (other than Boolean or Coded).

Example

Configuration

"locationTagNames": ["Report Location"],

}

• Add the location Tag&nbsp;&ldquo;Report location&rdquo; in openmrs&nbsp;
• And specify the location tag in config &nbsp;&nbsp;ex.&nbsp;"locationTagNames":&nbsp; &nbsp;["Report Location&rdquo;&nbsp;],
  

To count the number of observations of a coded concept, classified by the user selection (coded answers).

Configuration

}

• Add the locationTag&nbsp;&ldquo;Report location&rdquo; in openmrs&nbsp;
• And specify the location tag in config &nbsp;&nbsp;ex.&nbsp;"locationTagNames":&nbsp; &nbsp;["Report Location&rdquo;&nbsp;]
  

(to be renamed toBoolean Observations Count) Use this when you want to count the observations of type boolean, classified by the user selection: Yes/No (True/False).

Example

Configuration

}

Use this to count the two coded observations, both counted and displayed as a pivot table against each other.

Example

Configuration

}

Lists count of all diagnosis entered via the Bahmni system.

Configuration

"icd10ConceptSource": "ICD10-BD", // Optional field. Default value = 'ICD 10 - WHO'. If any implementation is using a different concept source for diagnosis coding, it can be set here.

"locationTagNames":["Report Location"] // Optional field. If any location tag is provided, only the encounters associated with the locations with those tags are counted. If this parameter is not set, all the encounters would be counted.

Currently, if there is a concept field specified, we do not have ICD10 code in the report. It is currently not clear if ICD10 codes are required to be setup for the diagnosis report to work. Once a decision is reached, all reports will follow the convention.

The age group is supposed to be present in the reporting_age_group table in openmrs database.

Example

Diagnosis report without age group

"OralnDentalReport1": { "name": "Dental and Oral Report 1", "type": "diagnosisCount", "config": { "locationTagNames":["Report Location"], "icd10ConceptSource":"ICD10-BD", "rowsGroupBy": [ "header_concept_name", "leaf_concept_name" ], "visitTypes":["IPD","OPD"], "columnsGroupBy": [ "gender", "agegroup_name" ] } },

Diagnosis report with age group

"OralnDentalReport2": { "name": "Dental and Oral Report 2", "type": "diagnosisCount", "config": { "locationTagNames":["Report Location"], "icd10ConceptSource":"ICD10-BD", "ageGroupName": "Registration", "rowsGroupBy": [ "header_concept_name", "leaf_concept_name" ], "visitTypes":["IPD","OPD"], "columnsGroupBy": [ "gender", "agegroup_name" ] } },

To list all tests, results and the count.

Configuration

Example

Report for a template with all the fields and the values that were filled in a given timeframe.

Configuration

name: Name of the Report.

templateName: Observation template for which the report needs to be generated.

patientAttributes: Patient attributes like caste, education to be displayed against each patient in report (Refer to image).

applyDateRangeFor: This additional parameter takes the following value encounterCreateDate orencounterDate, to apply the date range filter accordingly. The default value is encounterDate.

Add the location Tag &ldquo;Report location&rdquo; in openmrs

And specify the location tag in config ex. "locationTagNames": ["Report Location&rdquo; ],

Example

Listing the count of new/old OPD/IPD patients counts in a given time period

Configuration

}

Example:

Listing the count of numeric concepts observations based on the result values range for the given age groups

Configuration

The default value of "countOncePerPatient" should be false. In this case, we count an observation as many times as it has been recorded.

The observation will be counted once within an encounter. All changes made to an observation within an encounter will be considered as one.

If the value of "countOncePerPatient" is set to true, then we only count the latest value of the observation for the given date range.

Example:

Listing the count of observations based on the concept class for the given date range

Configuration

Example:

Listing the count of observations for each value for given concept names

Configuration

}

Example:

Listing the patients with lab test results along with test outcome, for a given list of lab tests and based on given test outcome (abnormal and/or normal)

Configuration

In this report, we generate a list of IPD patients along with a number of fields including patient details, confirmed diagnosis (comma separated if there is more than one), observation values (comma separated if there is more than one) for configurable list of concepts, configurablelistof patient attributes and configurable list of address attributes.

Configuration

Note: addressAttributes must be always in snake case Example: "city_village" instead of "cityVillage".

The date range filtering criteria can either be applied on "Date of Admission" or "Date of Discharge". We use "filterBy" parameter to specify the user criteria and distinguish between the two scenarios. If not configured, the "filterBy" parameter will be defaulted to "Date of Admission".

• Add the location Tag&nbsp;&ldquo;Report location&rdquo; in openmrs&nbsp;
• And specify the location tag in config &nbsp;&nbsp;ex.&nbsp;"locationTagNames":&nbsp; &nbsp;["Report Location&rdquo;&nbsp;],
  

In this report, we will generate the count of admission and discharges happened during the given date range, for each visit type.

Configuration

• Add the location Tag&nbsp;&ldquo;Report location&rdquo; in openmrs&nbsp;
• And specify the location tag in config &nbsp;&nbsp;ex.&nbsp;"locationTagNames":&nbsp; &nbsp;["Report Location&rdquo;&nbsp;],
  

In this report, we will generate the count of patients who are admitted to different states of a program.

Note: If a program has no states it will open up a blank page. The parameter "programName" is a program which is already configured earlier in OpenMRS.

Configuration

Example: We have created a Patient Overall Status program and added three states 'Attending Clinic', 'Transferred OutOf' and 'Dead' to it. It shows the number of patients that have entered a state

within a given date range "From 2015-08-01 to 2015-08-13" .

If the patient is currently enrolled in a different state, still the count should be taken for the original state if it is in the date range and has not been deleted.

In this report, we will generate the count of patients who are under going a state transition of a program.

Note: If a program has no states it will open up a blank page. The parameter "programName" is a program which is already configured earlier in OpenMRS.

Configuration

Example: We have created a Malaria Program and added three states 'First State', 'Second State' and 'Third State' to it. It shows the number of patients that have done a state transition

from 'First State' to 'Second State' and from 'Second State' to 'Third State' within a given date range "From 2015-08-02 to 2015-08-06" .

In this report, patient details are generatedwiththe following fields

- Patient ID - Patient Name - Age - Gender - DOB - Address fields - Patient Attributes - Date of registration

Note: If no date range is specified then the data for all patients is returned.

Configuration

"patientInformation": { "name": "Patient Information", "type": "PatientReport" }

- Sr. No. - Patient Identifier - Patient Name - Patient Age - enrolment date in the program - states for the patient - state start date - state end date - end date of the program for the patient - outcome for the patient

Configuration

Configurations

Configurations

• Patient Attributes&nbsp;: all the possible values from personattributetype.name column like {"HEIGHT","WEIGHT","Pulse"}. (REQUIRED)
• Apply Date Rage For&nbsp;: "<tablename&gt.<columnname>" of type date(or datetime) where table should be one of [obs,encounter,patientidentifier,patientprogram,program,concept_view] PS patientidentifier & patientprogram are joined only is enrolledProgram is mentioned in config&nbsp;(REQUIRED) Values, ObsRecording,ProgramEnrollment
• Addrress Attributes&nbsp;: column names of person_addrress table&nbsp;(REQUIRED)
• concept names&nbsp;: only leaf level concept names, concept set are not supported&nbsp;(REQUIRED)
• visit independent concepts&nbsp;: latest obs will be picked for them irrespective of visit. PS visits other than visit having latest obs will have no value for this field.&nbsp;(REQUIRED)
• enrolled program&nbsp;: only one program name is supported&nbsp;(OPTIONAL &nbsp;: remove entire config if not required)
• show obs only for program duration&nbsp;: filter only those obs taken in given program&nbsp;(REQUIRED)

This report will show patients information for whom the drugs are being ordered within the given date range.This report consists of patient information as well as drug information.

Configuration:

Report for a template with all the fields and the values that were filled in a given timeframe.

Configuration

name: Name of the Report.

templateName: Observation template for which the report needs to be generated.

patientAttributes: Patient attributes like caste, education to be displayed against each patient in report (Refer to image).

programAttributes: Program attributes like doctor, treatment date to be displayed against each program in report (Refer to image).

programNames: List of program names for which the observations should be displayed. If not specified it will fetch observations for all programs.

Add the location Tag &ldquo;Report location&rdquo; in openmrs

And specify the location tag in config ex. "locationTagNames": ["Report Location&rdquo; ],

addressAttributes: List of address attributes to be displayed (NOTE: addressAttributes must be always in snake case Example: "city_village" instead of "cityVillage".)

Example

A a new Program Specific Drug Order Report is created which will only consider the active programs within a date range, for drug orders and export all data for the active programs. The programs to be displayed as well as the program attributes are configurable to be displayed.

Please refer to the code snippet below for the available configurations:

Example:

The client wants the data from the system so that they can analyse various metrics. But there is limitation in canned reports to achieve this. So, Bahmni offers Custom SQL reports where an implementer can specify a SQL to extract the data from the system. But an implementer has to understand the complete OpenMRS data model and it makes difficult for them. So, there is Generic Reports which will eventually hoping to solve the problem.

Configuration

}

Few of the earlier Bahmni implementations uses this feature. Bahmni gives way to connect to Jasper Report module and an implementer will have to setup Jasper and design the form and SQL using that. Since this is one of the very old way, it is not encouraged to introduce to any site implementations.

There are difficulties faced in reports module as an implementer or as a developer. If I am an implementer then I must know OpenMRS data model so that I can write Custom SQL to extract the data for analytical purpose. If I am a developer then I have to create a canned report and duplicate the SQL from the similar report and this increases the maintenance. This makes life difficult for the community.

So, Bahmni currently provides generic reports for different entities in OpenMRS. For eg: Observations, Visits and Programs etc. The generic reports allows an implementer to extract data from the system for each entity, hence Bahmni has report for each. Generic reports provides option to include related fields and also provides option to apply various filters.

There are at times, we would like to extract visit information in variety of ways so that the extracted information can be analysed for betterment. This feature allows the implementer to configure such a way that he/she canapplyfilter(s) on visit and also can configure specific set of fields to be in the output.

The following fields are always available in the report irrespective of options provided in the config.

• Patient Identifier
• Patient Name (First Name + Last Name)
• Age
• Birthdate
• Gender
• Patient Created Date
• Visit type
• Date started
• Date stopped
• Date Of Admission
• Date Of Discharge

Please refer to the code snippet below for the available configurations:

Example:

There are at times, we would like to extract observation information in variety of ways so that the extracted information can be analyzed for betterment. This feature allows the implementer to configure such a way that he/she can apply filter(s) on observations and also can configure specific set of fields to be in the output.

The following fields are always available in the report irrespective of the options provided in the config.

• Patient Identifier
• Patient Name (First Name + Last Name)
• Age
• Birthdate
• Gender
• Location Name
• Concept Name (If&nbsp;encounterPerRow&nbsp;is false)
• Observation Value&nbsp;(If&nbsp;encounterPerRow&nbsp;is false)
• Observation datetime&nbsp;(If&nbsp;encounterPerRow&nbsp;is false)
• Parent Concept&nbsp;(If&nbsp;encounterPerRow&nbsp;is false)
• Program Enrollment Date
• Program End Date
• Patient Created Date

Please refer to the code snippet below for the available configurations:

Example:

Example for report of one observation per row.

Example for report of one encounter per row.

Example for report with all the default fields.

There are at times, we would like to extract programinformation in variety of ways so that the extracted information can be analyzed for betterment. This feature allows the implementer to configure such a way that he/she can apply filter(s) on programs and also can configure specific set of fields to be in the output.

The following fields are always available in the report irrespective of the options provided in the config.

• Patient Identifier
• Patient Name (First Name + Last Name)
• Age
• Birthdate
• Gender
• Patient Created Date
• Program Name
• Date Enrolled
• Date Completed
• Current State

Please refer to the code snippet below for the available configurations:

Example:-

We have entity based generic reports, for eg: observations report, to extract data from observations into excel and can apply macros to get some statistics. But this report gives the flexibility by providing pivot information in the configuration instead of writing macros will produce the required output.

Please refer to the code snippet below for the sample configurations:

Example:

If an user wants to generate aggregation for the above observations and based on sample config shown above will produce the following output. This reports shows the number of males and females based on their diastolic and systolic values as we defined rowGroups as Gender and columnGroups as Concept Name and Value. The count is based on Patient Identifier which is specified in distinct Group.

There is an ability to concatenate multiple reports. Concatenated reports does not support CSV format.

Please refer to the code snippet below for the sample configurations:

Example:

If user wants to generate a concatenated report of Visit Report and Obs Canned Report, he will be able to view it each report on different sheet of excel. For other formats like PDF, HTML, etc., reports will be one below the other.

Bahmni allows one to embed the data exported by the report in an existing workbook template which can contains formulae to create pivot table on the generated data. Workbook template has to be in .xls format.

The reports can be generated from the screen Home > Reports. To generate the report with formula from the workbook template applied on data, select format as 'CUSTOM EXCEL' and upload the required excel formula template and click on 'Run Report'. A report would be generated with actual data on sheet named 'Report' and data generated by formula in the template in 'Sheet1'. Please refer below to configure the Macro file to avoid uploading it every time for a report.

A excel template can be found which contains a macro. Formulae has to be added in 'Sheet1' of the above excel template and can be uploaded to generate a report. On opening the generated excel report,관련 문서: template.xls

macro that is present in the above excel template would apply the formula over the actual data. So 'Enable macros' should be selected on opening the generated excel report.

Example Formula: =SUM(Report!G9, Report!G10) - 'Report' sheet is the sheet which would contain the raw data without applying the formulae.

Note: If formula is added to any other template and used for generation of report, it wont work. Please use only the above template linked.

Steps to Configure :

1. Copy the xls(Microsoft 1997-2000) file with macro formula to bahmni_config
2. Configure the xls file path in bahmni_config as below in report.jsonxml

   "diabetes":{
           "name": "Diabetes",
           "type": "obsCount",
           "config": {
               "ageGroupName": "All Ages",
               "conceptNames": ["Diabetes, Intake"],
               "visitTypes": ["OPD","IPD"],
               "macroTemplatePath" : "/var/www/bahmni_config/openmrs/apps/reports/macroTemplates/Diabetes.xls"
           }
       },