formConditions.js

Description

FormConditions.js is located under bahmni_config/openmrs/apps/clinical.

This configuration allows users to enable or disable observation fields as well as show errors based on specific conditions or inputs on the form.

Some sections of the form are only filled when a particular set of information is needed. So, if we disable such fields, it simplifies the form.

Consider for example the case where there are two dates being entered in a form and one of the date should be always lesser than the other one. This condition can be checked in this JavaScript file and an appropriate error message can be shown upon validation.

Steps

The following function takes two inputs (formName and formFieldValues) and returns an object that contains array of enable and disable field/s and an error message if any.This code snippet will make "Posture" option disabled on initial rendering. Once data is entered for "Systolic Data" field, "Posture" option is enabled.

Example

'Systolic Data' : function (formName, formFieldValues) {
        var systolic = formFieldValues['Systolic'];
        if (systolic) {
            return {
                enable: ["Posture"]
            }
        } else {
            return {
                disable: ["Posture"],
				error: "Error message here if any"
            }
        }
	}

 

 In this case, the returned object will be-

{
      enable: ["Posture"],
      disable: [],
      error: "Error message here if any"
}

Passing Patient Context:

Example

'ANC' : function (formName, formFieldValues, patient) {
        if (patient.gender === "F") {
            return {
                enable: ["LMP", "Delivery Date"]
            }
        } else {
            return {
                disable: ["LMP", "Delivery Date"]
				error: "Error message here if any"
            }
        }
	}

 

 In this case, the returned object will be-

{
      enable: ["LMP", "Delivery Date"],
      disable: [],
      error: "Error message here if any"
}

Function signature which needs to be used

<Concept Full Name> : function (formName, formFieldValues, patient) { }

Overriding Form Conditions:

Over-riding form conditions is needed when a particular implementation needs to override the master Bahmni config to support varied implementation specific needs.

Existing form conditions can be overriden by the formConditions.js file in /implementation_config/openmrs/apps/clinical folder.

 Bahmni.ConceptSet.FormConditions.rulesOverride is used as variable.

Bahmni.ConceptSet.FormConditions.rulesOverride	= {
'Systolic Data' : null,
'Diastolic Data' : function (formName, formFieldValues, patient) {
        var diastolic = formFieldValues['Diastolic'];
        if (diastolic) {
            return {
                enable: ["Posture"]
            }
        } else {
            return {
                disable: ["Posture"],
				error: "Error message here if any"
            }
        }
	}
}