Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

The dashboard.json contains configurations that allows different display controls to be displayed on the patient dashboard.

 

Steps

Every display control on the patient dashboard requires a particular configuration to be added to the dashboard.json which allows it to appear and also defines what values the display control will show.

 

  1. Configuring patient information section: 

      The following configuration, when added to the dashboard.json will enable the patient information display control. This will contain the following details :

  1. Patient information
  2. Address information

 

"sections": { "patientInformation": {
Code Block
Code Block
languagejs
titleSample dashboard config
{
  "general": {
    "titletranslationKey": "Patient InformationDASHBOARD_TAB_GENERAL_KEY",
   
            "name"displayByDefault": "patientInformation"true,
                "displayOrder"maxRecentlyViewedPatients": 010,
    "sections": {}
   },
      "ageLimittrends":100,  {
              "patientAttributes"label": [ "ClassTrends",
           
    "educationmaxRecentlyViewedPatients": 10,
                "occupation",
             "sections": {}
  },
  "secondaryContactpatientSummary"],: {
               "addressFields": [
                    "address1",
               "translationKey": "DASHBOARD_TAB_PATIENT_SUMMARY_KEY",
    "address2maxRecentlyViewedPatients",
                    "cityVillage",
               : 10,
    "countryDistrictsections": {}
               ]
            }
}

Note : The patient attributes that will be displayed on the display control are mapped to the person attributes in OpenMRS and the address fields are mapped to address hierarchy in OpenMRS.

When this configuration is added to the dashboard.json, the following display control (highlighted in red) will appear on the patient dashboard.

 

Image Removed

 

Configuring Diagnosis display control

The following configuration, when added to the dashboard.json will enable the diagnosis display control.

Code Block
"diagnosis": {
  "title": "Diagnosis",
  "translationKey": "DASHBOARD_TITLE_DIAGNOSIS_KEY", //Applicable only for internationalization.	
  "showRuledOutDiagnoses": false,
  "name": "diagnosis",
  "showCertainty": true,
  "showOrder": true,
  "showDetailsButton":true
}

Note : The "showRuledOutDiagnoses" is, by default always set to true. If it needs to be disabled, it will have to be explicitly set to false as shown above.

Adding the configuration mentioned above will display the following display control (highlighted in red) :

Image Removed

Configuring Lab Result  section: 

The following configuration, when added to the dashboard.json will enable the Lab Result  display control. This will configuration contains all detail page as overlay.

Code Block
"sections": "labResults": {
                "title":"Lab Results",
                "translationKey":"DASHBOARD_TITLE_LAB_RESULTS_KEY",
                "name": "labOrders",
                "displayOrder": 10,
                "dashboardParams": {
                    "title": null,
                    "numberOfVisits": 1,
                    "showChart": false,
                    "showTable": true,
                    "showDetailsButton": false,
                    "initialAccessionCount": 0,
                    "latestAccessionCount": 1
                },
                "allLabDetails": {
                    "numberOfVisits": 10
                }
            },

Note:  User can configure numbeofVisit, showChart, showTable, showDetailsButton, intialAccessionCount, latestAccessionCount.

Adding the configuration mentioned, above will display the following display control (highlighted in red) :

Image Removed

On clicking "Lab Result" heading in Highlighted section ( In above image). Overlay window will open and look like.

 Image Removed
KeyInfoValue Type
translationKeyInternationalizes the dashboard title. You can provide the key or the title itself.Text
labelIf internationalisation is not required, then title of the dashboard can be directly given in label.
Either translationKey or label is mandatory. 
Text
displayByDefaulttrue/false. Opens the dashboard tab by default if given as true. Atleast one dashboard should mandatorily have this as true.True/false
maxRecentlyViewedPatientsConfigure the number of patients you want to see recently viewed patients under patient switch buttonNumber
sectionsAny display control can be configured in this sections. To configure display controls see
Display Controls 
{}
Tip
titleOn this Page

Table of Contents