Configure Patient Search & Display Attributes

Purpose and Benefits

Bahmni supports searching of registered patients based on configurable criteria. This could range from amongst the name of the patient (including local names), addresses, phone numbers or other IDs that the patient may have. 

Bahmni also gives implementers the freedom to separately configure the search display attributes, which can be person attributes and address attributes. These are in addition to the attributes which are displayed out-of-the-box in Bahmni such as Patient ID, Name, Gender, Village, etc. Program attributes if configured for patient search will be displayed by default in the search results. Note that display of program attributes is non-configurable for now, i.e. if they are configured to be searched by, they will be displayed by default in the display section.

Steps to Configure Patient Search Attributes

Registration search appears in the registration module as shown below : 

The criteria with which a registered patient can be searched is configured as per the implementation. The configurations are maintained in json files. Bahmni allows configuring search by:

• Address fields
• Custom patient attributes like local name, caste, etc
• Program attributes such as program registration ID, registration facility, etc.

 An example of this configuration for the JSS implementation can be found at the location: https://github.com/Bhamni/jss-config/tree/master/openmrs/apps/registration

To configure search parameters, add the following to  app.json's "config" section.

"patientSearch": {
  "address": {
    "label": "Rural Ward",
    "placeholder": "Enter ward",
    "field": "address2"
  },
  "customAttributes": {
    "label": "रुग्णाचे नाव",
    "placeholder": "रुग्णाचे नाव",
    "fields": ["givenNameLocal", "middleNameLocal", "familyNameLocal", "caste"]
  },
  "programAttributes": {
    "label": "Registration Number",
    "placeholder": "Enter Reg Number",
    "field": "Registration Number"
  },
  "searchByPatientIdentifier": true
}

Example: https://github.com/Bahmni/clinic-config/blob/663671fd4738054d04e966491b54ca668479d443/openmrs/apps/registration/app.json#L36

Key Fields

searchByPatientIdentifier

Steps to Configure Search Display Attributes

To configure patient search results parameters, add the following to  app.json's config section.If we provide this config patient search results will now show only the fields under "patientSearchResults" section and not the patient search config. If "patientSearchResults" is not given, patient search results will show the fields configured under "patientSearch" section. 

"patientSearchResults": {
    "address": {
        "fields" : ["address1", "address2" , "address3"]
    },
    "personAttributes": {
        "fields": ["landHolding", "education","givenNameLocal","familyNameLocal" ]
    }
}

Key Fields