Display Controls Configuration (Obsolete) Refer to https://bahmni.atlassian.net/wiki/display/BAH/Display+Controls

 

A display control is a widget that displays a specific medical domain object. It takes in configuration that specifies the context (patient, visit etc) and other parameters (display specific feature toggles), retrieves relevant data on its own and displays it where it is placed on the application.

This page lists down currently existing display controls, places where they can currently be configured to be used and the configuration details. 


Jump to one of the sections:


 Specify one or two column layout

We can specify one or two column layout for display controls. Options can be "Full-Page" and "Half-Page", with "Half-Page" being the default. When the "Full-Page" layout is specified for a display control it should appear on the top of the dashboard.

Sample

"sections": {
"diagnosis": {
"title": "Diagnosis",
"name": "diagnosis",
"showCertainty": true,
"showOrder": true,
"displayType": "Full-Page"
},
"disposition": {
"title": "Disposition",
"name": "disposition",
"numberOfVisits": 1,
"displayType": "Full-Page"
},

"radiology": {
"title": "Radiology",
"name": "radiology"
},
"programs": {
"title": "Programs",
"name": "programs"
}

}


Observation Control

Sample config

"nutritionalValues": {
 "title": "Nutritional Values",
"name": "vitals",
 "isObservation": true,
 "dashboardParams": {   
    "conceptNames": ["Height", "Weight", "BMI", "BMI STATUS"],
    "scope": "latest" or "numberOfVisits": "4",
    "showGroupDateTime": false   
  } ,
  "allObservationDetails": {
    "conceptNames": ["Height", "Weight", "BMI", "BMI STATUS"],
    "showDetailsButton": true,
    "pivotTable": {
    "numberOfVisits": "4",
     "groupBy": "encounters",
  "obsConcepts": ["Vitals", "Height", "Weight", "Pathology"],
     "drugConcepts": "",
     "labConcepts": ""

          },

         "observationGraph" : {

      "type": "observationGraph",
"name": "observationGraph",
      "title": "Temperature",
      "config": {
           "yAxisConcepts": ["Temperature"],
    "numberOfVisits": 3
}

          }

     } 

}

KeyInfo
TitleIndicates the title that will be displayed on the dashboard/visit page for the section
NameThe name/id for the control that needs to be picked from the code
conceptNamesSpecify the concept names of the concepts that need to be displayed in this section
scopeCan be latest/blank. If "latest", then the latest value of the observation across visits is shown. If a scope is not mentioned, then the number of visits has to be mentioned. Otherwise if the scope is blank then the observation values across all visits are displayed
isObservationSpecifies whether the given section is an observation control or a disease template control. If this is set to true then the section behaves as an observation control
observationGraphIndicates the configuration for the pivot table/flowsheet
numberOfVisitsSpecifies the number of visits for which data has to be displayed on the pivot table
groupByCan be encounters/visits. If grouped by the encounter, then the data is displayed per encounter in the pivot table. If grouped by the visit, then the latest value of the observations in each visit is displayed in the pivot table.
obsConceptImplementor must specify the concept names of the observations that need to be displayed in the pivot table
drugConceptImplementor must specify the concept names of the drugs that need to be displayed in the pivot table
labConceptImplementor must specify the concept names of the lab tests that need to be displayed in the pivot table
dashboardParamsIndicates the configuration for the dashboard
allObservationDetailsIndicates the configuration for the details page (All Observations Page)
showDetailsButtonConfiguration to display audit information when '+ ' sign is clicked. If set to false, the '+' button will not be displayed.
showGroupDateTimeConfiguration to display grouped encounter date time. If set to false, it is hidden. Default value is true(which means it is treated as true, if nothing specified). Should be separately configured for both dashboard and allDetails page

 


For Initial And Latest Observations

Sample config

"atAdmission": {
"type": "observation",
"title": "At Admission",
"config": {
"conceptNames": ["Weight", "Height", "BMI"],
"scope": "initial"
}
}

"atDischarge": {
"type": "observation",
"title": "At Discharge",
"config": {
"conceptNames": ["Weight"],
"scope": "latest"
}
}

Disease Template Control

Sample config

"diabetes": {
 "title": "Diabetes",
"templateName": "Diabetes Templates",
"name": "diseaseTemplate",
"dashboardParams":{
    "showOnly": [],
    "showGroupDateTime": false
   }, 
  "allDiseaseDetails": { 
    "showOnly":[],
    "showDetailsButton": true,
    "pivotTable": {
      "numberOfVisits": "15",
      "groupBy": "encounters",
      "obsConcepts": ["Weight", "Height", "Systolic", "Diastolic", "Diabetes, Foot Exam", "Diabetes, Eye Exam","Diabetes, Diabetes, Complications"],
      "drugConcepts": ["Ipratropium Pressurised", "Garbhpal Rasa", "Lente Insulin"],
      "labConcepts": ["RBS", "FBS", "PP2BS", "Hb1AC", "Creatinine", "Albumin", "Polymorph"]
},

         "observationGraph" : {

      "type": "observationGraph",
"name": "observationGraph",
      "title": "Temperature",
      "config": {
           "yAxisConcepts": ["Temperature"],
    "numberOfVisits": 3
}

          }

   }

}

 

KeyInfo
titleIndicates the title that will be displayed on the dashboard/visit page for the section
templateNameindicates the name of the disease template in openMRS that needs to be displayed
namethe name/id for the control that needs to be picked from the code
showOnly

specify the concept names of the concepts that need to be displayed in this section. If blank, then all the concepts in that disease template will be displayed

pivotTableindicates the configuration for the pivot table/flowsheet
observationGraphindicates the configuration for the observationGraph (OPTIONAL)
numberOfVisits

specifies the number of visits for which data has to be displayed on the pivot table

groupBycan be encounters/visits. If grouped by the encounter, then the data is displayed per encounter in the pivot table. If grouped by the visit, then the latest value of the observations in each visit is displayed in the pivot table.
obsConceptsimplementor must specify the concept names of the observations that need to be displayed in the pivot table
drugConcepts

implementor must specify the concept names of the drugs that need to be displayed in the pivot table

labConceptsimplementor must specify the concept names of the lab tests that need to be displayed in the pivot table
dashboardParamsindicates the configuration for the dashboard
allDiseaseDetails

indicates the configuration for the details page (All Disease Details Page)

showDetailsButtonConfiguration to display audit information when '+ ' sign is clicked. If set to false, the '+' button will not be displayed.
showGroupDateTimeConfiguration to display grouped encounter date time. If set to false, it is hidden. Default value is true(which means it is treated as true, if nothing specified). Should be separately configured for both dashboard and allDetails page.

 

Treatment Control

Sample config

"treatment": {
 "title": "Treatments",
"name": "treatment",
"dashboardParams": {
   "showFlowSheet": false,
   "showListView": true,
"showRoute": false,
"showDrugForm": false,
   "numberOfVisits": 2,
   "showOtherActive": true,
   "showDetailsButton": false
},
"allTreatmentDetails": {
   "title": "Treatments",
   "showFlowSheet": false,
   "showListView": true,
"showRoute": true,
"showDrugForm": true,
   "numberOfVisits": 5,
   "showOtherActive": true,
   "showDetailsButton": true
}

}

KeyInfo
title

Indicates the title that will be displayed on the dashboard/visit page for the section

namethe name/id for the control that needs to be picked from the code
showFlowSheetconfiguration to display the flowsheet (treatment chart). If it is on, the flowsheet will be displayed along with the treatment details for IPD patients.
showListViewconfiguration to display the treatment details list. If set to false along with showFlowSheet, only the header will be displayed.
showRouteconfiguration to display the route information. If you don't specify the "showRoute" in the treatment section, the default value will be false.
showDrugFormconfiguration to display the drug form information. If you don't specify the "showDrugForm" in the treatment section, the default value will be false.
numberOfVisitsspecifies the number of visits for which data has to be displayed
showOtherActiveif set to true, then display a separate section "Other Active Drugs" which displays active drugs from other visits.
showDetailsButtonConfiguration to display audit information when '+ ' sign is clicked. If set to false, the '+' button will not be displayed.
dashboardParamsindicates the configuration for the dashboard
allTreatmentDetailsIndicates the configuration for the details page (All Treatments Page)

 


Lab Result Control

Sample config

"labResults": {
 "title": "Lab Results",
"name": "labOrders",
"dashboardParams": {
   "title": null,
   "numberOfVisits": 1,
   "showChart": false,
   "showTable": true,
   "showDetailsButton": false,
"showNormalLabResults": true,
"showCommentsExpanded": true,
"showAccessionNotes": true,
"visitUuids": null, //ignores numberOfVisits if provided
"patientUuid: null, //mandatory if numberOfVisits provided
},
"allLabDetails": {
   "numberOfVisits": 3,
"observationGraph" : {
"type": "observationGraph",
"name": "observationGraph",
"title": "Temperature",
"config": {
    "yAxisConcepts": ["Temperature"],
    "numberOfVisits": 3
}
 }
}
KeyInfo
dashboardParamsindicates the configuration for the dashboard
titleIndicates the title that will be displayed on the dashboard/visit page for the section
namethe name/id for the control that needs to be picked from the code
numberOfVisitsspecifies the number of visits for which data has to be displayed
showChartconfiguration to display the investigation chart. If it is on, the investigation chart will be displayed along with the lab results table for IPD patients
showTableconfiguration to display the lab results table. If set to false along with showFlowSheet, only the header will be displayed.
showDetailsButtonConfiguration to display audit information when '+ ' sign is clicked. If set to false, the '+' button will not be displayed.
showNormalLabResultsShow lab results that are not marked abnormal in OpenElis. 
showCommentsExpandedShow comments expanded where they are present. The comments section will be collapsed by default if there are no comments mentioned in OpenElis
showAccessionNotesDisplay Accession Notes provided by Lab Manager in OpenElis
allLabDetailsindicates the configuration for the details page (All LabDetails Page)
observationGraphindicates the configuration for the observationGraph (OPTIONAL)

 


Diagnosis Control

Sample config

"diagnosis": {
"title": "Diagnosis",
"showRuledOutDiagnoses": false,
"name": "diagnosis",
"showCertainty": true,
"showOrder": true,
},

 

KeyInfo
titleIndicates the title that will be displayed on the dashboard/visit page for the section
namethe name/id for the control that needs to be picked from the code
showRuledOutDiagnoses

Indicates whether to filter out ruled out diagnoses or not. If set to false, ruled out diagnoses will not be displayed in the display control

showCertainty

Indicates whether certainty(CONFIRMED/PRESUMED) of the diagnosis should be displayed for each diagnosis in the display control.

If set to false, certainty of the diagnosis will not be displayed for the diagnoses.

showOrder

Indicates whether order(PRIMARY/SECONDARY) of the diagnosis should be displayed for each diagnosis in the display control.

If set to false, orders for the diagnosis will not be displayed for the diagnoses.


Patient Profile Control

Sample config

"patientInformation": {
 "title" : "Patient Information",
"name" : "patientInformation",
"patientAttributes" : ["caste", "class", "education", "occupation"],
 "showDOB" : false

}

KeyInfo
showDOBIndicates whether date of birth should be displayed in the control. Default value is true if nothing mentioned

Disposition Control

Sample config

"disposition": {
 "title": "Disposition",
"name":"disposition",
"numberOfVisits": 2

}

 


Graph Control

Sample config

"temperature": {
 "type": "observationGraph",
"name": "observationGraph",
 "title": "Temperature",
 "config": {
    "yAxisConcepts": ["Temperature"],
    "xAxisConcept" : "observationDateTime",
    "numberOfVisits": 3
  }
}
KeyInfo
typethe type/id for the control that needs to be picked from the code. (Required in Visit page)
namethe name/id for the control that needs to be picked from the code. (Required)
titleindicates the title that will be displayed on the dashboard/visit page for the section. (Required)
yAxisConceptsarray of concepts for which observations need to be plotted on the graph. (Required)
xAxisConceptsconcept on X Axis (observationDateTime, age or any concept) (Required)
numberOfVisitsspecifies the number of visits for which data has to be displayed. (Optional)

 


Graph With Reference Data Control

Graph Control Config becomes Chart With Reference Data Config with the addition of the 'referenceData' in the config section referring to the .csv file as shown below

"growthChart": {
"type": "observationGraph",
"name": "observationGraph",
"title": "Growth Chart",
"config": {
"yAxisConcepts": [ "Weight" ],
"referenceData": "growthChartReference.csv",
"numberOfVisits": 20
  }
}
KeyInfo
yAxisConcepts
It can be any Numeric Concept name.
It has to be a single value.
It can't be multiple values or empty. (Required)
referenceData
It would be name of the csv file to be loaded.
The csv file has to be in the same folder as this config file. (Required**)
**If the referenceData is not mentioned, the config will become Graph Control Config. Then, Graph Control Config specifications are applicable.
 numberOfVisits
It is the number of visits for which data has to be displayed.

 

Sample Reference Data CSV file
Gender, Age, Ref1, Ref2
M, 1, 10.5, 12.5
M, 2, 20.5, 22.5
F, 1, 9.5, 12
F, 2, 19.5, 22
  • First row is the header row
  • Age, Gender column name should always be 'Age', 'Gender' labels
  • Age, Gender columns are mandatory
  • Age is always assumed to be months (you can give decimals to represent days)
  • Other columns will correspond to the each reference line


Orders Control

Displays all the orders (for configured number of visits) and associated observations (scope latest always) for an orderType configured below.

Sample config

"labOrdersControl": {
 "orderType": "Lab Order",
 "name": "ordersControl",
 "title": "Lab Orders Display Control",
 "dashboardParams": {   
    "conceptNames": ["Systolic", "Diastolic", "Posture", "Temperature"],
    "numberOfVisits": "4"
  } ,
 "allOrdersDetails": {
      "conceptNames": ["Systolic", "Diastolic", "Posture", "Temperature"]
  }

}

KeyInfo
orderTypetype of the order you want to display (Required)
namethe name/id for the control that needs to be picked from the code. (Required)
titleindicates the title that will be displayed on the dashboard/visit page for the section. (Required)
conceptNamesSpecify the concept names of the concepts that need to be displayed in this section. (Required)
numberOfVisits

specifies the number of visits for which orders has to be displayed. (Optional)

dashboardParamsindicates the configuration for the dashboard
allOrdersDetailsIndicates the configuration for the details page (All Orders Page)


Orders Control on the Visit Page

The configuration of the visit page is the "visit.json" file that is under Clinical App. To configure the orders control on the visit page, add the following config.

"radiologyOrderControl":  {
        "type": "order",
        "title": "Radiology Order Display Control",
        "config": {
                           "title": "Radiology Order Display Control",
                           "name": "ordersControl",
                          "orderType": "Radiology Order",
                          "conceptNames":["Systolic", "Diastolic", "Posture", "Temperature"]
          }
}


Programs Display Control

When the user navigates to the patient dashboard by selecting a program from the program management page, the program display control displays only information that pertains to that selected program. However when the user enters consultation directly, the program display control displays all programs and related information. 

"programs": {

    "title": "Programs",
"name": "programs"
}
KeyInformation
titleThe title to be shown in the display control
nameShould be 'programs'


Pacs Orders Control

"allPackOrders": {
"orderType": "Radiology Order",
"name": "pacsOrders",
"title": "ALL PACS ORDER",
"dashboardParams":{
"pacsImageUrl":"http://10.0.0.10:8080/oviyam2/viewer.html?patientID={{patientID}}&accessionNumber={{orderNumber}}",
"numberOfVisits":4
  }
}
KeyInformation
titleThe title to be shown in the display control
nameShould be 'pacsOrders'
orderTypeOnly the orders of this type will shown in the display control
dashboardParams
KeyInformation
pacsImageurl

The url template of the pacs image link. (For ex. It could be the Oviyam2 DICOM image viewer link)

PlacholdersReplaced with
{{patientID}}The identifier of the patient
{{orderNumber}}The order number of the order

These placholders has to be parts of the url template

numberOfVisitsIt is the number of visits for which data has to be displayed

Flow Sheet Control

The flow sheet found in the Observations Display Control and the Disease Template Display Control can be independently set on the dashboard by using the flow sheet display control. 

"flowsheet": {
  "name": "flowSheet",
  "title": "Diabetes Flow Sheet",
  "dashboardParams": {
    "numberOfVisits": "5",
    "groupBy": "visits",
    "obsConcepts": [
      "Diabetes, Blood Pressure",
      "Diabetes, A1C"
    ],
    "labConcepts": [
      "RBS",
      "FBS"
    ]
  },
  "allFlowSheetDetails": {
    "numberOfVisits": "10",
    "groupBy": "visits",
    "obsConcepts": [
      "Diabetes, Blood Pressure",
      "Diabetes, A1C",
    ],
    "labConcepts": [
      "RBS",
      "FBS"
    ],
	"drugConcepts": [
		"Metformin"
	],
  }
}
KeyInformation
titleTitle of the visit tab.

dashboardParams

Parameters of display control on the dashboard.

KeyInformation
numberOfVisits
Specifies the number of visits for which data has to be displayed
groupBy
Can be encounters/visits. If grouped by the encounter, then the data is displayed per encounter in the pivot table. If grouped by the visit, then the latest value of the observations in each visit is displayed in the pivot table.
obsConcepts
Concepts of observations to be chosen for display
labConcepts
Concepts of lab results to be chosen for display
drugConcepts
Concepts of drug orders to be chosen for display
  
 allFlowSheetDetails

Parameters for configuration in the expanded view. Elements inside have the same format as elements inside dashboardParams.

If empty, defaults to dashboardParams

  

Custom Control

Bahmni allows implementers to create their own custom display control.

The following configuration needs to be added in visit.json (openmrs/apps/clinical/visit.json) which will display the custom display control in different visit tabs.

We are configuring the birth certificate in the following example.

"birthCertificate": {
    "title": "Birth Certificate",
    "printing": {
        "title": "Bahmni",
        "header": "Certificate",
        "logo": "../images/bahmniLogo.png"
    },
    "sections": {
        "Birth Certificate": {
            "type": "custom",
            "config": {
                "title": "Birth Certificate",
                "template": "<birth-certificate></birth-certificate>"
            }
        }
    }
}
KeyInformation
titleTitle of the visit tab.

printing

Add printing section to enable the print button on visit page.
 title - Title in print out.
 header - Header in print out.
 logo - Logo to display in print out.
type"custom" (Required and should always be custom)
configconfiguration for the custom display control.
 

title - title of the custom directive

 template - the directive which you want to show.

 

Custom control on Patient Dashboard:

The following configuration needs to be added under sections in dashboard.json (openmrs/apps/clinical/dashboard.json) which will display the custom display control in different dashboard tabs.

We are configuring the birth certificate in the following example.

"General": {
    "translationKey": "DASHBOARD_TAB_GENERAL_KEY",
    "sections": {
        "Birth Certificate": {
            "name": "custom",
            "config": {
                "title": "Birth Certificate",
                "template": "<birth-certificate></birth-certificate>"
            }
        }
    }
}
KeyInformation
name*"custom" (Required and should always be custom)
config

configuration for the custom display control.

keyInformation
titletitle of the custom directive
templatethe directive which you want to show

 

Bahmni provides customDisplayControl module which will provide basic connection b/w the app and config.

You can add new directives as per your requirement in the "openmrs/apps/customDisplayControl/js/customControl.js" file. (Make sure you can create new custom directives only in the existing file)

New directives should be under the same module. ("bahmni.common.displaycontrol.custom"). The scope of the new directive will have patient, visitUuid and config.

We are adding a birthCertificate as new directive in the following example:

'use strict';

angular.module('bahmni.common.displaycontrol.custom')
    .directive('birthCertificate', ['observationsService', 'appService', 'spinner', function (observationsService, appService, spinner) {
            var link = function ($scope) {
                var conceptNames = ["HEIGHT"];
                $scope.contentUrl = appService.configBaseUrl() + "/customDisplayControl/views/birthCertificate.html";
                spinner.forPromise(observationsService.fetch($scope.patient.uuid, conceptNames, "latest", undefined, $scope.visitUuid, undefined).then(function (response) {
                    $scope.observations = response.data;
                }));
            };

            return {
                restrict: 'E',
                template: '<ng-include src="contentUrl"/>',
                link: link
            }
    }])

In the above example, we are configuring the concept names we want to fetch in the variable conceptNames.

You can create your own template in the directive "openmrs/apps/customDisplayControl/views/"

We are creating a birthCertificate.html in the following example:

<div>
    {{config.title}}
    <section class="dashboard-section">
        <ul class="form-field">
            <li ng-repeat="obsGroup in observations">
                <span class="obs-date"> {{obsGroup.conceptNameToDisplay }} </span>
                <span class="obs-date"> {{obsGroup.value}} </span>
            </li>
        </ul>
    </section>
</div>

Note:

1. Make sure you don't create a different file for new directives (all custom directives should be in the same file.)
2. Don't forget to change the contentUrl to the html file you are referring to.

Navigation Links Control

To configure the navigation links control on a Dashboard Page, as an example, add the configuration below in the "dashboard.json" file that is under the Clinical App. 

Sample Config

"navigationLinksControl": {
        "name": "navigationLinksControl",
        "showLinks":[
            "home", "visit"
        ],
      "customLinks": [
         {
            "translationKey":"CONSULTATION_PAGE_KEY",
            "url": "../clinical/#/default/patient/{{patientUuid}}/dashboard/concept-set-group/observations?encounterUuid=active"
        }
     ]
  }
}

KeyInfo
name

Name of the display control 

showLinksList of links user would like to inherit from default links provided by product
  "home" // Enables link to navigate Home Page
 "visit"     // Enables link to navigate to current patient's Active Visit Page
 "registration"     // Enables link to navigate to current patient's Registration Page
 "inpatient"     // Enables link to navigate to current patient's Inpatient Page
 "enrolment"     // Enables link to navigate to current patient's Program Page
 

"visitAttribute     // Enables link to navigate to current patient's Visit Attributes Page ( second page of registration)

customLinksList of links that the user would like to add which are not provided by product
 translationKey : Text to display in the link
 

url: Url to navigate to

Obs To Obs Flow Sheet

To configure the Obs to Obs Flow Sheet on a Dashboard Page, as an example, add the configuration below in the "dashboard.json" file that is under the Clinical App. 

 

Sample Config
"Bacteriology Concept Set": {
    "displayType": "Full-Page",
    "translationKey": "DASHBOARD_TITLE_BACTERIOLOGY_RESULTS_KEY",
    "name": "obsToObsFlowSheet",
    "dashboardParams": {
        "numberOfVisits": 1,
        "initialCount": 3,
        "latestCount": 4,
		"pivotOn": "column",
        "templateName": "BACTERIOLOGY CONCEPT SET",
        "groupByConcept": "Specimen Collection Date",
		"name": "DstExtension",
        "conceptNames": [
            "Specimen Id"
        ],
        "isEditable": true
    },
    "allDetailsParams": {
        "templateName": "BACTERIOLOGY CONCEPT SET",
        "groupByConcept": "Specimen Collection Date"
    }
}
KeyInfoRequired
nameobsToObsFlowSheet (If you configure the name with obsToObsFlowSheet, it will show the obs in tabular view)Yes
numberOfVisitsWhich is used to see specific number of visits data. If you don't provide, it will show data from all visits.

No

initialCountInitial set of observations to be displayed within number of visitsNo
latestCountLatest set of observations to be displayed within number of visitsNo
templateNameName of the template which has to be shown in flowsheetYes
groupByConceptThe member of template which is used for groupingYes
name

The name which specifies the file name(groovy extension), so that you can configure extensions for individual obsToObsFlowSheet (DST, ECG READINGS, CHEST X-RAY etc) to support month calculation.

No

conceptNamesThe concept names which you want to see in that table. By default it will show all leaf member in that template.

No

pivotOnThe orientation of the table. By default it will display row oriented table.No
isEditableThe configuration that enables you to edit the each line entry of the flow sheetNo

Month Extension

Sample Groovy Code: DstExtension.groovy, you can find it at

https://github.com/Bahmni/endtb-config/blob/master/openmrs/treatmentRegimenExtension/DstExtension.groovy

This file should copied into config under /openmrs/treatmentRegimenExtension/ package.

ArrayList<BahmniObservation> obs = pivotRow.getColumns().get("Specimen Collection Date");

In the code at line "Specimen Collection Date" is groupByConcept for the Flowsheet.

Note:  Make sure that the extension file is copied to "/home/Username/.OpenMRS/bahmni_config/openmrs/treatmentRegimenExtension/" directory.

Showing Highest Observation Value : In order to display only the highest observation value for any coded question concept instead of comma separated values, refer the link https://github.com/Bhamni/endtb-config/commit/700823bed1b36cf54e1a52780c56a0f43260a317 where you have to specify the descending order of values and pass it to the comparator. Refer the below example :

List<String> cultureResultObsValueInDescendingOrder = Arrays.asList("Positive for M. tuberculosis", "Negative for M. tuberculosis", "Contaminated",
				"Only positive for other mycobacterium", "Other")
 
ArrayList<BahmniObservation> cultureResultObs = pivotRow.getColumns().get("Bacteriology, Culture results");
if(cultureResultObs != null && cultureResultObs.size() > 1) {
				Collections.sort(cultureResultObs, new obsValueComparator(cultureResultObsValueInDescendingOrder));
				pivotRow.getColumns().remove("Bacteriology, Culture results");
				pivotRow.addColumn("Bacteriology, Culture results", cultureResultObs.get(0));
}

In above example "cultureResultObsValueInDescendingOrder" holds the fully specified names of coded answers in the descending order. "Bacteriology, Culture results" is the 

variabledescription
cultureResultObsValueInDescendingOrderVariable that holds the fully specified names of coded answers in the descending order
Bacteriology, Culture resultsQuestion concept fully specified name

 

 


 

Chronic Treatment Chart

To configure the Chronic Treatment Chart on a Dashboard Page, add the configuration below in the "dashboard.json" file that is under the Clinical App.

"Chronic Treatment Chart": {
	"displayType": "Full-Page",
	"title": "Chronic Treatment Chart",
    "name": "chronicTreatmentChart",
    "dashboardParams": {
    	"drugs": []
     },
     "allDetailsParams": {
     	"drugs": []
     }
}
KeyValueRequired
name
chronicTreatmentChart (If you configure the name with chronicTreatmentChart, it will show the chronicTreatmentChart display control)
true
Drugs
drugs concept name which you want to show. (If you don't specify drugs it shows all the drugs which patient is undergoing)optional

Month Extension

If you want month column to be shown in chronicTreatmentChart, then add the following groovy extension.

Sample Groovy Code: TreatmentRegimenExtension.groovy, you can find it at

https://github.com/Bahmni/endtb-config/blob/master/openmrs/treatmentRegimenExtension/TreatmentRegimenExtension.groovy

This file should copied into config under /openmrs/treatmentRegimenExtension/ package.

Note:  Make sure that the extension file is copied to "/home/Username/.OpenMRS/bahmni_config/openmrs/treatmentRegimenExtension/" directory.

 

 

Drug Order Details Control

Add the below config under drugOrder --> sections in app.json to see it on treatment page or else in dashboard.json --> sections to see it on dashboard.

Sample config

Sample Config
"treatmentsDetails": {
    "title":"Treatments Details",
    "translationKey" : "DASHBOARD_TITLE_TREATMENT_DETAIL",
    "name": "drugOrderDetails",
    "displayOrder": 3,
    "dashboardParams": {
        "showOnlyActive":true,                      
        "drugConceptSet": "All TB Drugs",
        "showDetailsButton": true
      }
}
KeyInfo
title

Indicates the title that will be displayed on the dashboard for the section

namethe name/id for the control that needs to be picked from the code
drugConceptSetDrug orders will be filtered upon the concepts specified as part of this concept set. If not specified, it will display all drug orders.

dashboardParams

indicates the configuration for the dashboard

showOnlyActiveSet this to "true" to display only active drug orders. If "false" or not configured anything will show all the drugs
showDetailsButtonConfiguration to display audit information when arrow sign is clicked. If set to false, the arrow button will not be displayed.

 


Bacteriology Results Control

Add the below config in dashboard.json --> sections to see it on dashboard.

Sample config

Sample Config
"bacteriologyResults": {
    "translationKey": "DASHBOARD_TITLE_BACTERIOLOGY_RESULTS_KEY",
    "name": "bacteriologyResultsControl",
    "orderType": "",
    "displayOrder": 4,
    "dashboardParams": {
        "conceptNames": ["BACTERIOLOGY CONCEPT SET"]
    }
}
KeyInfo
title

Indicates the title that will be displayed on the dashboard for the section

namethe name/id for the control that needs to be picked from the code
orderType 

dashboardParams

indicates the configuration for the dashboard

conceptNamesConcepts of observations to be chosen for display
  

 


 Admission Details Control

Add the below config  in dashboard.json --> sections to see it on dashboard.

Sample Config
"admissionDetails": {
    "title": "Admission Details",
    "translationKey":"DASHBOARD_TITLE_ADMISSION_DETAILS_KEY",
    "name": "admissionDetails",
    "displayOrder": 19
}