Configure Clinical Home

This page has been Archived, and is obsolete. It is available on the Bahmni wiki only for reference and historical purposes. Instead of deleting a page, we prefer to "archive" it, so that it is still available to people who have bookmarked the page.

Maybe you would like to read this page: Clinical Module (Implementers Guide)

Purpose:

The Clinical Services feature is used to view the treatment history of existing patients, as well as to start a registered patient's treatment process in the medical facility.

 

Benefits:

  1. Enter Patient data retrospectively or on behalf of another provider.
  2. View Patient Dashboard including Patient Details, Active and Past Programs, etc.

  3. View the summary of a Patient's visit along with graphs and trend mapping.
  4. Capture specific clinical observations for the patient such as Obstetrics, Gynecology, etc.
  5. Autocompletes most data fields for easier data entry.
  6. Capture various diagnoses for the patient.
  7. Capture Dispositions for the patient with Disposition notes.
  8. Capture Consultation notes for the patient.
  9. Prescribe treatment orders for medications.

  10. Place orders for radiology tests via PACS (Picture Archiving and Communication System) integration.

  11. Place orders for Laboratory tests.

  12. View the consultation history of the patient.

  13. View scanned documents and results of tests.

  14. Capture Bacteriology test results for the patient (different from laboratory tests). Bacteriology includes smear test results, culture test results and drug-sensitivity test results.

  15. View Patient Lists with support for sorting by filters.

 

All configuration for the tabs should be in openmrs/apps/clinical/dashboard.json. 

Steps to configure:

1. Configure General Tab

Patient Dashboard View for General Tab 

Please refer to the code snippet below:

"general": {
    "translationKey": "DASHBOARD_TAB_GENERAL_KEY",
    "displayByDefault": true,
    "maxRecentlyViewedPatients": 10,
    "sections": {
        "patientInformation": {
            "translationKey": "DASHBOARD_TITLE_PATIENT_INFORMATION_KEY",
            "type": "patientInformation",
            "displayOrder": 0,
            "ageLimit":100,
            "patientAttributes": [],
            "addressFields": [
                "address1",
                "address2",
                "cityVillage",
                "countryDistrict"
            ]
        },
        "diagnosis": {
            "translationKey": "DASHBOARD_TITLE_DIAGNOSIS_KEY",
            "type": "diagnosis",
            "showCertainty": true,
            "showOrder": true,
            "displayOrder": 1
        },

        "disposition": {
            "translationKey" : "DASHBOARD_TITLE_DISPOSITION_KEY",
            "type": "disposition",
            "numberOfVisits": 1,
            "displayOrder": 2
        },
        "treatments": {
            "translationKey": "DASHBOARD_TITLE_TREATMENTS_KEY",
            "type": "treatment",
            "displayOrder": 3,
            "dashboardConfig": {
                "showFlowSheet": true,
                "showListView": true,
                "showRoute": true,
                "showDrugForm": true,
                "numberOfVisits": 5,
                "showOtherActive": true,
                "showDetailsButton": true
            },
            "expandedViewConfig": {
                "translationKey": "DASHBOARD_TITLE_TREATMENTS_KEY",
                "showFlowSheet": true,
                "showListView": true,
                "showRoute": true,
                "showDrugForm": true,
                "numberOfVisits": 10,
                "showOtherActive": true,
                "showDetailsButton": true
            }
        },
        "radiology": {
            "translationKey": "DASHBOARD_TITLE_RADIOLOGY_KEY",
            "type": "radiology",
            "displayOrder": 4
        },
        "programs": {
            "translationKey": "DASHBOARD_TITLE_PROGRAMS_KEY",
            "type": "programs",
            "displayOrder": 5
        },
        "navigationLinksControl": {
            "translationKey": "DASHBOARD_TITLE_NAVIGATION_LINKS_CONTROL_KEY",
            "type": "navigationLinksControl",
            "displayOrder": 6,
            "links": [
                {
                    "translationKey":"HOME_DASHBOARD_KEY",
                    "url": "../home/#/dashboard"
                },
                {
                    "url": "../clinical/#/default/patient/{{patientUuid}}/dashboard/visit/{{visitUuid}}/?encounterUuid=active",
                    "translationKey":"PATIENT_VISIT_PAGE_KEY"
                },
                {
                    "translationKey":"PATIENT_ADT_PAGE_KEY",
                    "url": "../adt/#/patient/{{patientUuid}}/visit/{{visitUuid}}/"
                },
                {
                    "translationKey":"PATIENT_DASHBOARD_KEY",
                    "url": "../clinical/#/default/patient/{{patientUuid}}/dashboard"
                },
                {
                    "translationKey":"DISCHARGE_SUMMARY_PAGE_KEY",
                    "url": "../clinical/#/default/patient/{{patientUuid}}/dashboard/visit/{{visitUuid}}"
                },
                {
                    "translationKey":"PROGRAM_MANAGEMENT_PAGE_KEY",
                    "url": "../clinical/#/programs/patient/{{patientUuid}}/consultationContext"
                },
                {
                    "translationKey":"CONSULTATION_PAGE_KEY",

                    "url": "../clinical/#/default/patient/{{patientUuid}}/concept-set-group/observations"
                }
            ]
        },
        "radiologyOrders": {
            "orderType": "Radiology Order",
            "type": "ordersControl",
            "translationKey": "DASHBOARD_TITLE_RADIOLOGY_ORDERS_KEY",
            "displayOrder": 7,
            "dashboardConfig": {
                "conceptNames": [
                    "Summary"
                ],
                "numberOfVisits": 4
            }
        },
        "pacs": {
            "orderType": "Radiology Order",
            "type": "pacsOrders",
            "translationKey" : "DASHBOARD_TITLE_PACS_KEY",
            "displayOrder": 8,
            "dashboardConfig": {
                "pacsImageUrl": "/oviyam2/viewer.html?patientID={{patientID}}&accessionNumber={{orderNumber}}",
                "numberOfVisits": 4
            }
        },
        "labOrdersDisplayControl": {
            "translationKey": "DASHBOARD_TITLE_LAB_ORDERS_DISPLAY_CONTROL_KEY",
            "type": "ordersControl",
            "orderType": "Lab Order",
            "showDetailsButton": true,
            "displayOrder": 9,
            "dashboardConfig": {
                "conceptNames": [
                    "Systolic",
                    "Diastolic",
                    "Posture",
                    "Temperature"
                ]
            },
            "expandedViewConfig": {
                "conceptNames": [
                    "Systolic",
                    "Diastolic",
                    "Posture",
                    "Temperature"
                ]
            }
        },
        "bacteriologyResults":{
            "translationKey": "DASHBOARD_TITLE_BACTERIOLOGY_RESULTS_KEY",
            "type": "bacteriologyResultsControl",
            "scope": "All",
            "orderType": "",
            "dashboardConfig": {
                "conceptNames": [
                    "BACTERIOLOGY CONCEPT SET"
                ]

            }
        },
        "labResults": {
            "translationKey":"DASHBOARD_TITLE_LAB_RESULTS_KEY",
            "type": "labOrders",
            "displayOrder": 10,
            "dashboardConfig": {
                "title": null,
                "numberOfVisits": 1,
                "showChart": false,
                "showTable": true,
                "showDetailsButton": false,
                "initialAccessionCount": 0,
                "latestAccessionCount": 1
            },
            "expandedViewConfig": {
                "numberOfVisits": 10
            }
        },
        "nutritionalValues": {
            "translationKey":"DASHBOARD_TITLE_NUTRITIONAL_VALUES_KEY",
            "type": "vitals",
            "isObservation": true,
            "displayOrder": 11,
            "dashboardConfig": {
                "conceptNames": [
                    "HEIGHT",
                    "Weight",
                    "BMI",
                    "BMI STATUS"
                ],
                "numberOfVisits": 2
            },
            "expandedViewConfig": {
                "conceptNames": [
                    "HEIGHT",
                    "Weight",
                    "BMI",
                    "BMI STATUS"
                ],
                "numberOfVisits": 2,
                "scope": "latest",
                "showDetailsButton": true,
                "pivotTable": {
                    "numberOfVisits": "4",
                    "groupBy": "encounters",
                    "obsConcepts": ["Vitals", "Height", "Weight", "Pathology"],
                    "drugConcepts": "",
                    "labConcepts": ""
                },
                "observationGraph" : {
                    "type": "observationGraph",
                    "title": "Temperature",
                    "config": {
                        "yAxisConcepts": ["Temperature"],
                        "numberOfVisits": 3
                    }
                }
            }
        },
        "vitals": {
            "translationKey": "DASHBOARD_TITLE_VITALS_KEY",
            "type": "vitals",
            "isObservation": true,
            "displayOrder": 12,
            "dashboardConfig": {
                "conceptNames": [
                    "Vitals"
                ],
                "numberOfVisits": 2
            },
            "expandedViewConfig": {
                "conceptNames": [
                    "Vitals"
                ],
                "numberOfVisits": 2,
                "showDetailsButton": true,
                "pivotTable": {
                    "numberOfVisits": "10",
                    "groupBy": "encounters",
                    "obsConcepts": [
                        "Weight",
                        "Vitals"
                    ],
                    "drugConcepts": [],
                    "labConcepts": []
                }
            }
        },
        "secondVitals": {
            "translationKey":"DASHBOARD_TITLE_SECOND_VITALS_KEY",
            "type": "second vitals",
            "isObservation": true,
            "displayOrder": 13,
            "dashboardConfig": {
                "conceptNames": [
                    "Second Vitals"
                ],
                "numberOfVisits": 2
            },
            "expandedViewConfig": {
                "conceptNames": [
                    "Second Vitals"
                ],
                "numberOfVisits": 2,
                "showDetailsButton": true,
                "pivotTable": {}
            }
        },
        "historyAndExaminations": {
            "translationKey": "DASHBOARD_TITLE_HISTORY_AND_EXAMINATIONS_KEY",
            "type": "vitals",
            "isObservation": true,
            "displayOrder": 14,
            "dashboardConfig": {
                "conceptNames": [
                    "History and Examination"
                ],
				"obsIgnoreList": [
                  	"Height",
					"Smoking History"
                ]
                "numberOfVisits": 2
            },
            "expandedViewConfig": {
                "conceptNames": [
                    "History and Examination"
                ],
                "numberOfVisits": 2,
                "showDetailsButton": true,
                "pivotTable": {}
            }
        },
        "gynaecology": {
            "translationKey":"DASHBOARD_TITLE_GYNAECOLOGY_KEY",
            "type": "gynaecology",
            "isObservation": true,
            "displayOrder": 15,
            "dashboardConfig": {
                "conceptNames": [
                    "Gynaecology"
                ],
                "numberOfVisits": 2
            },
            "expandedViewConfig": {
                "conceptNames": [
                    "Gynaecology"
                ],
                "numberOfVisits": 2,
                "showDetailsButton": true,
                "pivotTable": {}
            }
        },
        "obstetrics": {
            "translationKey":"DASHBOARD_TITLE_OBSTETRICS_KEY",
            "type": "obstetrics",
            "isObservation": true,
            "displayOrder": 16,
            "dashboardConfig": {
                "conceptNames": [
                    "Obstetrics"
                ],
                "numberOfVisits": 2
            },
            "expandedViewConfig": {
                "conceptNames": [
                    "Obstetrics"
                ],
                "numberOfVisits": 2,
                "showDetailsButton": true,
                "pivotTable": {}
            }
        },
        "visits": {
            "translationKey": "DASHBOARD_TITLE_VISITS_KEY",
            "type": "visits",
            "displayOrder": 17,
            "dashboardConfig": {
                "title": null,
                "maximumNoOfVisits": 8,
                "groupByVisits": true
            }
        },
        "diabetes": {
            "title": "Diabetes",
            "templateName": "Diabetes Templates",
            "type": "diseaseTemplate",
            "displayOrder": 18,
            "dashboardConfig": {
                "showOnly": []
            },
            "expandedViewConfig": {
                "showDetailsButton": true,
                "pivotTable": {
                    "numberOfVisits": "15",
                    "groupBy": "encounters",
                    "obsConcepts": [
                        "Weight",
                        "Height",
                        "Systolic",
                        "Diastolic",
                        "Diabetes, Foot Exam",
                        "Diabetes, Eye Exam"
                    ],
                    "drugConcepts": [
                        "Ipratropium Pressurised",
                        "Garbhpal Rasa"
                    ],
                    "labConcepts": [
                        "RBS",
                        "FBS",
                        "PP2BS",
                        "Hb1AC",
                        "Creatinine",
                        "Albumin",
                        "Polymorph"
                    ]
                }
            }
        },
        "admissionDetails": {
            "translationKey":"DASHBOARD_TITLE_ADMISSION_DETAILS_KEY",
            "type": "admissionDetails",
            "displayOrder": 19
        }
    }
}


2. Configure Patient Summary tab:

 

                               


Please refer to the code snippet below:

"patientSummary": {
    "translationKey": "DASHBOARD_TAB_PATIENT_SUMMARY_KEY",
    "maxRecentlyViewedPatients": 10,
    "sections": {
        "Bacteriology Concept Set": {
            "displayType": "Full-Page",
            "translationKey": "DASHBOARD_TITLE_BACTERIOLOGY_RESULTS_KEY",
            "type": "obsToObsFlowSheet",
            "dashboardConfig": {
                "numberOfVisits": 1,
                "templateName": "BACTERIOLOGY CONCEPT SET",
                "groupByConcept": "Specimen Collection Date",
                "conceptNames": [
                    "Specimen Id"
                ]
            },
            "expandedViewConfig": {
                "templateName": "BACTERIOLOGY CONCEPT SET",
                "groupByConcept": "Specimen Collection Date"
            }
        },
        "Chronic Treatment Chart": {
            "displayType": "Full-Page",
            "title": "Chronic Treatment Chart",
            "type": "chronicTreatmentChart",
            "dashboardConfig": {
                "drugs": []
             },
             "expandedViewConfig": {
                "drugs": []
             }
        }
    }
}


3. Configure Trends tab:

                                             

 

Please refer to the code snippet below:

"trends": {
    "translationKey": "DASHBOARD_TAB_TRENDS_KEY",
    "maxRecentlyViewedPatients": 10,
    "sections": {
        "patientInformation": {
           "translationKey": "DASHBOARD_TITLE_PATIENT_INFORMATION_KEY", 
            "type": "patientInformation",
            "patientAttributes": [
                "caste",
                "class",
                "education",
                "occupation",
                "debt",
                "distanceFromCenter",
                "isUrban",
                "cluster",
                "RationCard",
                "familyIncome"
            ],
            "addressFields": [
                "address1",
                "address2",
                "cityVillage",
                "countryDistrict"
            ],
            "displayOrder": 0
        },
        "growthChart": {
            "type": "observationGraph",
            "title": "Growth Chart",
            "config": {
                "yAxisConcepts": [
                    "Weight"
                ],
                "referenceData": "growthChartReference.csv",
                "numberOfVisits": 20
            },
            "displayOrder": 1
        },
        "BP": {
            "type": "observationGraph",
            "title": "BP",
            "config": {
                "yAxisConcepts": [
                    "Systolic Data",
                    "Diastolic Data"
                ],
                "xAxisConcept": "observationDateTime",
                "numberOfVisits": 10
            },
            "displayOrder": 2
        },
        "weight/BMI": {
            "type": "observationGraph",
            "title": "Weight/BMI",
            "config": {
                "yAxisConcepts": [
                    "Weight",
                    "BMI"
                ],
                "xAxisConcept": "observationDateTime",
                "numberOfVisits": 10
            },
            "displayOrder": 3
        },
        "diabetes/BloodSugar": {
            "type": "observationGraph",
            "title": "Diabetes/Blood Sugar",
            "config": {
                "yAxisConcepts": [
                    "Blood Sugar Fasting",
                    "Blood Sugar P.P"
                ],
                "xAxisConcept": "observationDateTime",
                "numberOfVisits": 10
            },
            "displayOrder": 4
        },
        "observationGraph": {
            "type": "observationGraph",
            "title": "Pulse",
            "config": {
                "yAxisConcepts": [
                    "Pulse Data"
                ],
                "xAxisConcept": "observationDateTime",
                "numberOfVisits": 10
            },
            "displayOrder": 5
        },
        "diabetes": {
            "title": "Diabetes",
            "templateName": "Diabetes, Progress",
            "type": "diseaseTemplate",
            "dashboardConfig": {
                "showOnly": []
            },
            "expandedViewConfig": {
                "showDetailsButton": true,
                "pivotTable": {
                    "numberOfVisits": "10",
                    "groupBy": "visits",
                    "obsConcepts": [
                        "Diabetes, Blood Pressure",
                        "Diabetes, A1C",
                        "Diabetes, LDL",
                        "Diabetes, Ulcers on Feet",
                        "Blood Sugar Fasting",
                        "Blood Sugar PP"
                    ],
                    "labConcepts": [
                        "RBS",
                        "FBS",
                        "PP2BS",
                        "Hb1AC",
                        "Creatinine",
                        "Cholesterol"
                    ]
                }
            },
            "displayOrder": 6
        }
    }
}


 

Key Fields 

 

Please add all key fields to the Glossary here>

KeyUseMandatory
translationKey
Key for tab title 
displayByDefault*
Should be true for the tabs which have to displayed by default. Default value is false.When false, we can navigate to the tab by clicke on the '+' icon just beside the default tab namesAtleast one of the sections should have true.
maxRecentlyViewedPatients*
Number of patients to show in the "Recent Patients" dropdownYes
sections
List of all the display controls (and their configs) to be displayed in the tab. 

 

Here is a reference file: https://github.com/Bhamni/default-config/blob/master/openmrs/apps/clinical/dashboard.json


On this Page

 

 

The Bahmni documentation is licensed under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)