RA-1598: Pref. coding source configurable for <encounterDiagnoses*/>.

Ruhanga · mks-d · commit 7bca6ca3384c · 2019-07-11T13:15:43.000+02:00
diff --git a/api-2.2/src/main/java/org/openmrs/module/coreapps/htmlformentry/EncounterDiagnosesElement.java b/api-2.2/src/main/java/org/openmrs/module/coreapps/htmlformentry/EncounterDiagnosesElement.java
@@ -1,3 +1,4 @@
+
 /**
  * This Source Code Form is subject to the terms of the Mozilla Public License,
  * v. 2.0. If a copy of the MPL was not distributed with this file, You can
@@ -68,6 +69,8 @@ public class EncounterDiagnosesElement implements HtmlGeneratorElement, FormSubm
 
     private String diagnosisConceptSources;
 
+    private String preferredCodingSource;
+
     private EmrApiProperties emrApiProperties;
 
     private ConceptService conceptService;
@@ -139,6 +142,7 @@ public String generateHtml(FormEntryContext context) {
                 fragmentConfig.put("formFieldName", "encounterDiagnoses");
                 fragmentConfig.put("existingDiagnoses", existingDiagnoses);
                 fragmentConfig.put("diagnosisSets", validateAndFormat(diagnosisSets));
+                fragmentConfig.put("preferredCodingSource", preferredCodingSource);
                 fragmentConfig.put("diagnosisConceptSources", StringUtils.deleteWhitespace(diagnosisConceptSources));
 
                 // add the prior diagnoses if requested
@@ -419,6 +423,14 @@ public String getDiagnosisConceptSources() {
         return diagnosisConceptSources;
     }
 
+    public void setPreferredCodingSource(String preferredCodingSource) {
+        this.preferredCodingSource = preferredCodingSource;
+    }
+
+    public String getPreferredCodingSource() {
+        return preferredCodingSource;
+    }
+
     public void setUiUtils(UiUtils uiUtils) {
         this.uiUtils = uiUtils;
     }
diff --git a/api-pre2.2/src/main/java/org/openmrs/module/coreapps/htmlformentry/EncounterDiagnosesElement.java b/api-pre2.2/src/main/java/org/openmrs/module/coreapps/htmlformentry/EncounterDiagnosesElement.java
@@ -1,3 +1,4 @@
+
 /**
  * This Source Code Form is subject to the terms of the Mozilla Public License,
  * v. 2.0. If a copy of the MPL was not distributed with this file, You can
@@ -65,6 +66,8 @@ public class EncounterDiagnosesElement implements HtmlGeneratorElement, FormSubm
     private UiUtils uiUtils;
     private String selectedDiagnosesTarget;
 
+    private String preferredCodingSource;
+
     private EmrApiProperties emrApiProperties;
 
     private ConceptService conceptService;
@@ -118,6 +121,7 @@ public String generateHtml(FormEntryContext context) {
                 fragmentConfig.put("formFieldName", "encounterDiagnoses");
                 fragmentConfig.put("existingDiagnoses", existingDiagnoses);
                 fragmentConfig.put("diagnosisSets", validateAndFormat(diagnosisSets));
+                fragmentConfig.put("preferredCodingSource", preferredCodingSource);
                 fragmentConfig.put("diagnosisConceptSources", StringUtils.deleteWhitespace(diagnosisConceptSources));
 
                 // add the prior diagnoses if requested
@@ -368,6 +372,14 @@ public String getDiagnosisConceptSources() {
         return diagnosisConceptSources;
     }
 
+    public void setPreferredCodingSource(String preferredCodingSource) {
+        this.preferredCodingSource = preferredCodingSource;
+    }
+
+    public String getPreferredCodingSource() {
+        return preferredCodingSource;
+    }
+
     public void setUiUtils(UiUtils uiUtils) {
         this.uiUtils = uiUtils;
     }
diff --git a/api/src/main/java/org/openmrs/module/coreapps/CoreAppsConstants.java b/api/src/main/java/org/openmrs/module/coreapps/CoreAppsConstants.java
@@ -53,5 +53,8 @@ public class CoreAppsConstants {
 
    // Condition list
    public static final String MANAGE_CONDITIONS_PRIVILEGE = "Task: Manage Condition Lists";
+   
    public static final String GLOBAL_PROPERTY_CONDITIONS_CRITERIA = "coreapps.conditionListClasses";
+
+   public static final String DEFAULT_CODING_SOURCE = "ICD-10-WHO";
 }
diff --git a/api/src/main/java/org/openmrs/module/coreapps/htmlformentry/EncounterDiagnosesByObsElement.java b/api/src/main/java/org/openmrs/module/coreapps/htmlformentry/EncounterDiagnosesByObsElement.java
@@ -1,3 +1,4 @@
+
 /**
  * This Source Code Form is subject to the terms of the Mozilla Public License,
  * v. 2.0. If a copy of the MPL was not distributed with this file, You can
@@ -73,6 +74,8 @@ public class EncounterDiagnosesByObsElement implements HtmlGeneratorElement, For
 
     private String diagnosisConceptSources;
 
+    private String preferredCodingSource;
+
     private AdtService adtService;
 
     private DispositionType dispositionTypeForPriorDiagnoses = null;
@@ -118,6 +121,7 @@ public String generateHtml(FormEntryContext context) {
                 fragmentConfig.put("formFieldName", "encounterDiagnoses");
                 fragmentConfig.put("existingDiagnoses", existingDiagnoses);
                 fragmentConfig.put("diagnosisSets", validateAndFormat(diagnosisSets));
+                fragmentConfig.put("preferredCodingSource", preferredCodingSource);
                 fragmentConfig.put("diagnosisConceptSources", StringUtils.deleteWhitespace(diagnosisConceptSources));
 
                 // add the prior diagnoses if requested
@@ -367,6 +371,14 @@ public void setDiagnosisConceptSources(String diagnosisConceptSources) {
     public String getDiagnosisConceptSources() {
         return diagnosisConceptSources;
     }
+    
+    public void setPreferredCodingSource(String preferredCodingSource) {
+        this.preferredCodingSource = preferredCodingSource;
+    }
+
+    public String getPreferredCodingSource() {
+        return preferredCodingSource;
+    }
 
     public void setUiUtils(UiUtils uiUtils) {
         this.uiUtils = uiUtils;
diff --git a/api/src/main/java/org/openmrs/module/coreapps/htmlformentry/EncounterDiagnosesByObsTagHandler.java b/api/src/main/java/org/openmrs/module/coreapps/htmlformentry/EncounterDiagnosesByObsTagHandler.java
@@ -1,3 +1,4 @@
+
 package org.openmrs.module.coreapps.htmlformentry;
 
 import org.openmrs.api.ConceptService;
@@ -77,6 +78,7 @@ protected String getSubstitution(FormEntrySession session, FormSubmissionControl
         element.setAdtService(adtService);
         element.setDiagnosisSets(attributes.get("diagnosisSets") != null ? attributes.get("diagnosisSets") : "");
         element.setDiagnosisConceptSources(attributes.get("diagnosisConceptSources") != null ? attributes.get("diagnosisConceptSources") : "");
+        element.setPreferredCodingSource(attributes.get("preferredCodingSource") != null ? attributes.get("preferredCodingSource"): CoreAppsConstants.DEFAULT_CODING_SOURCE);
 
         /**
          *  Handle the attribute to specify loading any prior diagnoses from the most recent encounter with a specific disposition
diff --git a/api/src/main/java/org/openmrs/module/coreapps/htmlformentry/EncounterDiagnosesTagHandler.java b/api/src/main/java/org/openmrs/module/coreapps/htmlformentry/EncounterDiagnosesTagHandler.java
@@ -1,3 +1,4 @@
+
 package org.openmrs.module.coreapps.htmlformentry;
 
 import org.openmrs.api.ConceptService;
@@ -18,9 +19,11 @@
  *
  * In enter/edit mode, includes the diagnosis/encounterDiagnoses fragment.
  * Currently this is hardcoded to use specific ids and names, and can only be included once on a form
+ * 
+ * It supports specifying the concept source to use for obtaining concept code displayed on the UI
  *
  * Example usage:
- * <encounterDiagnoses required="true" selectedDiagnosesTarget="#encounter-diagnoses-target" includePriorDiagnosesFromMostRecentEncounterWithDispositionOfType="ADMIT"/>)
+ * <encounterDiagnoses required="true" selectedDiagnosesTarget="#encounter-diagnoses-target" includePriorDiagnosesFromMostRecentEncounterWithDispositionOfType="ADMIT" preferredCodingSource="CIEL"/>)
  *
  */
 public class EncounterDiagnosesTagHandler extends SubstitutionTagHandler {
@@ -77,6 +80,7 @@ protected String getSubstitution(FormEntrySession session, FormSubmissionControl
         element.setAdtService(adtService);
         element.setDiagnosisSets(attributes.get("diagnosisSets") != null ? attributes.get("diagnosisSets") : "");
         element.setDiagnosisConceptSources(attributes.get("diagnosisConceptSources") != null ? attributes.get("diagnosisConceptSources") : "");
+        element.setPreferredCodingSource(attributes.get("preferredCodingSource") != null ? attributes.get("preferredCodingSource"): CoreAppsConstants.DEFAULT_CODING_SOURCE);
 
         /**
          *  Handle the attribute to specify loading any prior diagnoses from the most recent encounter with a specific disposition
diff --git a/api/src/main/resources/messages.properties b/api/src/main/resources/messages.properties
@@ -511,7 +511,7 @@ coreapps.consult.primaryDiagnosis=Primary Diagnosis:
 coreapps.consult.primaryDiagnosis.notChosen=Not chosen
 coreapps.consult.secondaryDiagnoses=Secondary Diagnoses:
 coreapps.consult.secondaryDiagnoses.notChosen=None
-coreapps.consult.codedButNoCode=ICD code unknown
+coreapps.consult.codedButNoCode={0} code unknown
 coreapps.consult.nonCoded=Non-Coded
 coreapps.consult.synonymFor=a.k.a.
 coreapps.consult.successMessage=Saved Consult Note for {0}
diff --git a/api/src/test/java/org/openmrs/module/coreapps/htmlformentry/EncounterDiagnosesTagHandlerTest.java b/api/src/test/java/org/openmrs/module/coreapps/htmlformentry/EncounterDiagnosesTagHandlerTest.java
@@ -109,4 +109,4 @@ public boolean matches(Object o) {
             return  matches;
         }
     }
-}
+}
diff --git a/omod/src/main/webapp/fragments/diagnosis/encounterDiagnoses.gsp b/omod/src/main/webapp/fragments/diagnosis/encounterDiagnoses.gsp
@@ -13,7 +13,7 @@
         {{ if (item.code) { }}
         {{- item.code }}
         {{ } else if (item.concept) { }}
-        ${ui.message("coreapps.consult.codedButNoCode")}
+         ${ui.message("coreapps.consult.codedButNoCode", config.preferredCodingSource)}
         {{ } else { }}
         ${ui.message("coreapps.consult.nonCoded")}
         {{ } }}
@@ -36,7 +36,7 @@
             <span class="code">
                 <span data-ng-show="d.diagnosis.code">{{ d.diagnosis.code }}</span>
                 <span data-ng-show="!d.diagnosis.code && d.diagnosis.concept">
-                    ${ui.message("coreapps.consult.codedButNoCode")}
+                    ${ui.message("coreapps.consult.codedButNoCode", config.preferredCodingSource)}
                 </span>
                 <span data-ng-show="!d.diagnosis.code && !d.diagnosis.concept">
                     ${ui.message("coreapps.consult.nonCoded")}
@@ -66,7 +66,7 @@
 
         <div id="diagnosis-search-container">
             <label for="diagnosis-search">${ ui.message("coreapps.consult.addDiagnosis") }</label>
-            <input id="diagnosis-search" type="text" placeholder="${ ui.message("coreapps.consult.addDiagnosis.placeholder") }" autocomplete itemFormatter="autocomplete-render-item" diagnosisSets="${ config.diagnosisSets }" diagnosisConceptSources="${ config.diagnosisConceptSources }"/>
+            <input id="diagnosis-search" type="text" placeholder="${ ui.message("coreapps.consult.addDiagnosis.placeholder") }" autocomplete itemFormatter="autocomplete-render-item" diagnosisSets="${ config.diagnosisSets }" diagnosisConceptSources="${ config.diagnosisConceptSources }" preferredCodingSource="${ config.preferredCodingSource }"/>
 
             <% if(jsForPrior.size > 0) { %>
                 <button type="button" ng-click="addPriorDiagnoses()">${ ui.message("coreapps.consult.priorDiagnoses.add") }</button>
diff --git a/omod/src/main/webapp/resources/scripts/diagnoses/diagnoses.js b/omod/src/main/webapp/resources/scripts/diagnoses/diagnoses.js
@@ -1,10 +1,14 @@
 (function(diagnoses, $, _, undefined) {
 
-    var codingSystemToUse = 'ICD-10-WHO';
-
     var mapTypeOrder = [ "SAME-AS", "NARROWER-THAN" ]
+    
+    findPreferredCodingSource = function() {
+        var preferredCodingSource = $("#diagnosis-search").attr("preferredcodingsource");
+        return preferredCodingSource;
+    };
 
-    findConceptMapping = function(concept, sourceName) {
+    findConceptMapping = function(concept) {
+        var sourceName = findPreferredCodingSource();
         var matches = _.filter(concept.conceptMappings, function(item) {
             return item.conceptReferenceTerm.conceptSource.name == sourceName
         });
@@ -60,7 +64,7 @@
                 matchedName: item.conceptName ? item.conceptName.name : item.concept.preferredName,
                 preferredName: item.conceptName && item.conceptName.name != item.concept.preferredName ? item.concept.preferredName : null,
                 nameIsPreferred: item.conceptName ? (item.conceptName === item.concept.preferredName) : true,
-                code: findConceptMapping(item.concept, codingSystemToUse),
+                code: findConceptMapping(item.concept),
                 conceptId: item.concept.id,
                 exactlyMatchesQuery: function(query) {
                     query = emr.stripAccents(query.toLowerCase());
diff --git a/omod/src/test/java/org/openmrs/module/coreapps/htmlformentry/EncounterDiagnosesTagHandlerComponentTest.java b/omod/src/test/java/org/openmrs/module/coreapps/htmlformentry/EncounterDiagnosesTagHandlerComponentTest.java
@@ -76,6 +76,7 @@
 import org.openmrs.ui.framework.Model;
 import org.openmrs.ui.framework.UiUtils;
 import org.openmrs.ui.framework.page.PageAction;
+import org.openmrs.ui.framework.UiUtils;
 import org.openmrs.web.test.BaseModuleWebContextSensitiveTest;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.mock.web.MockHttpServletRequest;
@@ -365,11 +366,47 @@ public void testEditedResults(SubmissionResults results) {
         }.run();
     }
 
+    @Test
+    public void getSubstitution_shouldAddPreferredCodingSourceWithPreferredValueAttributeOnDiagnosisSearchField() throws Exception {
+        // Setup
+        String preferredCodingSource = "ICPC2";
+
+        Map<String,String> attributes = new HashMap<String, String>();
+        attributes.put("required", "true");
+        attributes.put(CoreAppsConstants.HTMLFORMENTRY_ENCOUNTER_DIAGNOSES_TAG_INCLUDE_PRIOR_DIAGNOSES_ATTRIBUTE_NAME, "admit");
+        attributes.put("selectedDiagnosesTarget", "example-target");
+
+        // Replay
+        attributes.put("preferredCodingSource", preferredCodingSource);
+        String generatedHtml = encounterDiagnosesTagHandler.getSubstitution(formEntrySession, formSubmissionController, attributes);
+
+        // Verify
+        assertTrue(StringUtils.contains(generatedHtml, "preferredCodingSource=\"" + preferredCodingSource + "\""));
+
+    }
+
+    @Test
+    public void getSubstitution_shouldAddPreferredCodingSourceWithDefaultValueAttributeOnDiagnosisSearchField() throws Exception {
+        // Setup
+        Map<String,String> attributes = new HashMap<String, String>();
+        attributes.put("required", "true");
+        attributes.put(CoreAppsConstants.HTMLFORMENTRY_ENCOUNTER_DIAGNOSES_TAG_INCLUDE_PRIOR_DIAGNOSES_ATTRIBUTE_NAME, "admit");
+        attributes.put("selectedDiagnosesTarget", "example-target");
+
+        // Replay
+        attributes.put("preferredCodingSource", null);
+        String generatedHtml = encounterDiagnosesTagHandler.getSubstitution(formEntrySession, formSubmissionController, attributes);
+
+        // Verify
+        assertTrue(StringUtils.contains(generatedHtml, "preferredCodingSource=\"" + CoreAppsConstants.DEFAULT_CODING_SOURCE + "\""));
+
+    }
+
     @Test
     public void getSubstitution_shouldAddUuidsToDiagnosisSetsAttributeOnDiagnosisSearchFieldGivenDiagnosisUuids() throws Exception {
         // setup
         String diagnosisSetsUuids = GENERAL_AND_SPECIFIED_DIAGNOSIS_SET_UUID + "," + HIV_OPPORTUNISTIC_INFECTION_DIAGNOSIS_SET_UUID;
-        
+
         Map<String,String> attributes = new HashMap<String, String>();
         attributes.put("required", "true");
         attributes.put(CoreAppsConstants.HTMLFORMENTRY_ENCOUNTER_DIAGNOSES_TAG_INCLUDE_PRIOR_DIAGNOSES_ATTRIBUTE_NAME, "admit");
@@ -388,7 +425,7 @@ public void getSubstitution_shouldAddUuidsToDiagnosisSetsAttributeOnDiagnosisSea
     public void getSubstitution_shouldAddUuidsToDiagnosisSetsAttributeOnDiagnosisSearchFieldGivenDiagnosisMappings() throws Exception {
         // setup
         String diagnosisSetsUuids = GENERAL_AND_SPECIFIED_DIAGNOSIS_SET_UUID + "," + HIV_OPPORTUNISTIC_INFECTION_DIAGNOSIS_SET_UUID;
-        
+
         Map<String,String> attributes = new HashMap<String, String>();
         attributes.put("required", "true");
         attributes.put(CoreAppsConstants.HTMLFORMENTRY_ENCOUNTER_DIAGNOSES_TAG_INCLUDE_PRIOR_DIAGNOSES_ATTRIBUTE_NAME, "admit");
@@ -431,6 +468,7 @@ public void getSubstitution_shouldThrowWhenDiagnosisSetsAttributeContainsInvalid
         // replay
         attributes.put("diagnosisSets", "NON-EXISTING:MAPPING,CIEL:160170");
         encounterDiagnosesTagHandler.getSubstitution(formEntrySession, formSubmissionController, attributes);
+
     }
 
     @Test
@@ -477,13 +515,13 @@ private String renderFragmentHtml(Map<String, Object> fragmentConfig) throws Exc
         Map<String, Object> model = new LinkedHashMap<String, Object>();
         Model cfgAsModel = new Model();
         for (String prop : fragmentConfig.keySet()) {
-        	cfgAsModel.addAttribute(prop, fragmentConfig.get(prop));
+            cfgAsModel.addAttribute(prop, fragmentConfig.get(prop));
         }
         model.put("config", cfgAsModel);
         model.put("ui", uiUtils);
         model.put("jsForExisting", new ArrayList<String>());
         model.put("jsForPrior", new ArrayList<String>());
-    
+
         return template.make(model).toString();
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -53,5 +53,8 @@ public class CoreAppsConstants {`
`53`	`53`
`54`	`54`	`// Condition list`
`55`	`55`	`public static final String MANAGE_CONDITIONS_PRIVILEGE = "Task: Manage Condition Lists";`
	`56`	`+`
`56`	`57`	`public static final String GLOBAL_PROPERTY_CONDITIONS_CRITERIA = "coreapps.conditionListClasses";`
	`58`	`+`
	`59`	`+ public static final String DEFAULT_CODING_SOURCE = "ICD-10-WHO";`
`57`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -109,4 +109,4 @@ public boolean matches(Object o) {`
`109`	`109`	`return matches;`
`110`	`110`	`}`
`111`	`111`	`}`
`112`		`-}`
	`112`	`+}`