RA-1610: 'diagnosisConceptSources' attribute for <encounterDiagnoses*/>.

Ruhanga · mks-d · commit d6cd5b19d706 · 2019-07-11T11:36:13.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
@@ -66,6 +66,8 @@ public class EncounterDiagnosesElement implements HtmlGeneratorElement, FormSubm
 
     private String diagnosisSets;
 
+    private String diagnosisConceptSources;
+
     private EmrApiProperties emrApiProperties;
 
     private ConceptService conceptService;
@@ -137,6 +139,7 @@ public String generateHtml(FormEntryContext context) {
                 fragmentConfig.put("formFieldName", "encounterDiagnoses");
                 fragmentConfig.put("existingDiagnoses", existingDiagnoses);
                 fragmentConfig.put("diagnosisSets", validateAndFormat(diagnosisSets));
+                fragmentConfig.put("diagnosisConceptSources", StringUtils.deleteWhitespace(diagnosisConceptSources));
 
                 // add the prior diagnoses if requested
                 if (FormEntryContext.Mode.ENTER == context.getMode() && dispositionTypeForPriorDiagnoses != null) {
@@ -408,6 +411,14 @@ public String getDiagnosisSets() {
         return diagnosisSets;
     }
 
+    public void setDiagnosisConceptSources(String diagnosisConceptSources) {
+        this.diagnosisConceptSources = diagnosisConceptSources;
+    }
+
+    public String getDiagnosisConceptSources() {
+        return diagnosisConceptSources;
+    }
+
     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
@@ -71,6 +71,8 @@ public class EncounterDiagnosesElement implements HtmlGeneratorElement, FormSubm
 
     private String diagnosisSets;
 
+    private String diagnosisConceptSources;
+
     private AdtService adtService;
 
     private DispositionType dispositionTypeForPriorDiagnoses = null;
@@ -116,6 +118,7 @@ public String generateHtml(FormEntryContext context) {
                 fragmentConfig.put("formFieldName", "encounterDiagnoses");
                 fragmentConfig.put("existingDiagnoses", existingDiagnoses);
                 fragmentConfig.put("diagnosisSets", validateAndFormat(diagnosisSets));
+                fragmentConfig.put("diagnosisConceptSources", StringUtils.deleteWhitespace(diagnosisConceptSources));
 
                 // add the prior diagnoses if requested
                 if (FormEntryContext.Mode.ENTER == context.getMode() && dispositionTypeForPriorDiagnoses != null) {
@@ -357,6 +360,14 @@ public String getDiagnosisSets() {
         return diagnosisSets;
     }
 
+    public void setDiagnosisConceptSources(String diagnosisConceptSources) {
+        this.diagnosisConceptSources = diagnosisConceptSources;
+    }
+
+    public String getDiagnosisConceptSources() {
+        return diagnosisConceptSources;
+    }
+
     public void setUiUtils(UiUtils uiUtils) {
         this.uiUtils = uiUtils;
     }
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
@@ -71,6 +71,8 @@ public class EncounterDiagnosesByObsElement implements HtmlGeneratorElement, For
 
     private String diagnosisSets;
 
+    private String diagnosisConceptSources;
+
     private AdtService adtService;
 
     private DispositionType dispositionTypeForPriorDiagnoses = null;
@@ -116,6 +118,7 @@ public String generateHtml(FormEntryContext context) {
                 fragmentConfig.put("formFieldName", "encounterDiagnoses");
                 fragmentConfig.put("existingDiagnoses", existingDiagnoses);
                 fragmentConfig.put("diagnosisSets", validateAndFormat(diagnosisSets));
+                fragmentConfig.put("diagnosisConceptSources", StringUtils.deleteWhitespace(diagnosisConceptSources));
 
                 // add the prior diagnoses if requested
                 if (FormEntryContext.Mode.ENTER == context.getMode() && dispositionTypeForPriorDiagnoses != null) {
@@ -357,6 +360,14 @@ public String getDiagnosisSets() {
         return diagnosisSets;
     }
 
+    public void setDiagnosisConceptSources(String diagnosisConceptSources) {
+        this.diagnosisConceptSources = diagnosisConceptSources;
+    }
+
+    public String getDiagnosisConceptSources() {
+        return diagnosisConceptSources;
+    }
+
     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
@@ -76,6 +76,7 @@ protected String getSubstitution(FormEntrySession session, FormSubmissionControl
         element.setConceptService(conceptService);
         element.setAdtService(adtService);
         element.setDiagnosisSets(attributes.get("diagnosisSets") != null ? attributes.get("diagnosisSets") : "");
+        element.setDiagnosisConceptSources(attributes.get("diagnosisConceptSources") != null ? attributes.get("diagnosisConceptSources") : "");
 
         /**
          *  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
@@ -76,6 +76,7 @@ protected String getSubstitution(FormEntrySession session, FormSubmissionControl
         element.setConceptService(conceptService);
         element.setAdtService(adtService);
         element.setDiagnosisSets(attributes.get("diagnosisSets") != null ? attributes.get("diagnosisSets") : "");
+        element.setDiagnosisConceptSources(attributes.get("diagnosisConceptSources") != null ? attributes.get("diagnosisConceptSources") : "");
 
         /**
          *  Handle the attribute to specify loading any prior diagnoses from the most recent encounter with a specific disposition
diff --git a/omod/src/main/java/org/openmrs/module/coreapps/fragment/controller/DiagnosesFragmentController.java b/omod/src/main/java/org/openmrs/module/coreapps/fragment/controller/DiagnosesFragmentController.java
@@ -57,6 +57,7 @@ public List<SimpleObject> search(UiSessionContext context,
                                      @SpringBean("conceptService") ConceptService conceptService,
                                      @RequestParam("term") String query,
                                      @RequestParam(value = "diagnosisSets", defaultValue = "") String diagnosisSetUuids,
+                                     @RequestParam(value = "diagnosisConceptSources", defaultValue = "") String diagnosisConceptSources,
                                      @RequestParam(value = "start", defaultValue = "0") Integer start,
                                      @RequestParam(value = "size", defaultValue = "50") Integer size) throws Exception {
 
@@ -73,9 +74,23 @@ public List<SimpleObject> search(UiSessionContext context,
         else{
             diagnosisSets = emrApiProperties.getDiagnosisSets();
         }
-        Locale locale = context.getLocale();
 
-        List<ConceptSource> sources = emrApiProperties.getConceptSourcesForDiagnosisSearch();
+        List<ConceptSource> sources = new ArrayList<ConceptSource>();
+
+        if (StringUtils.isNotEmpty(diagnosisConceptSources)) {
+            String [] sourceNames = diagnosisConceptSources.split(",");
+            for (String sourceName : sourceNames) {
+                ConceptSource source = conceptService.getConceptSourceByName(sourceName);
+                if (source != null) {
+                    sources.add(source);
+                }                
+            }
+        }
+        else{
+            sources = emrApiProperties.getConceptSourcesForDiagnosisSearch();
+        }
+
+        Locale locale = context.getLocale();
 
         List<ConceptSearchResult> hits = emrConceptService.conceptSearch(query, locale, null, diagnosisSets, sources, null);
         List<SimpleObject> ret = new ArrayList<SimpleObject>();
@@ -85,25 +100,17 @@ public List<SimpleObject> search(UiSessionContext context,
         return ret;
     }
 
+    @Deprecated
     public List<SimpleObject> searchNonCoded(UiSessionContext context,
                                      UiUtils ui,
                                      @SpringBean("emrApiProperties") EmrApiProperties emrApiProperties,
                                      @SpringBean("emrConceptService") EmrConceptService emrConceptService,
+                                     @SpringBean("conceptService") ConceptService conceptService,
                                      @RequestParam("term") String query,
                                      @RequestParam(value = "start", defaultValue = "0") Integer start,
                                      @RequestParam(value = "size", defaultValue = "50") Integer size) throws Exception {
 
-        Collection<Concept> diagnosisSets = emrApiProperties.getDiagnosisSets();
-        Locale locale = context.getLocale();
-
-        List<ConceptSource> sources = emrApiProperties.getConceptSourcesForDiagnosisSearch();
-
-        List<ConceptSearchResult> hits = emrConceptService.conceptSearch(query, locale, null, diagnosisSets, sources, null);
-        List<SimpleObject> ret = new ArrayList<SimpleObject>();
-        for (ConceptSearchResult hit : hits) {
-            ret.add(simplify(hit, ui, locale));
-        }
-        return ret;
+        return search(context, ui, emrApiProperties, emrConceptService, conceptService, query, null, null, start, size);
     }
 
     public FragmentActionResult codeDiagnosis(UiUtils ui,
diff --git a/omod/src/main/webapp/fragments/diagnosis/encounterDiagnoses.gsp b/omod/src/main/webapp/fragments/diagnosis/encounterDiagnoses.gsp
@@ -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 }"/>
+            <input id="diagnosis-search" type="text" placeholder="${ ui.message("coreapps.consult.addDiagnosis.placeholder") }" autocomplete itemFormatter="autocomplete-render-item" diagnosisSets="${ config.diagnosisSets }" diagnosisConceptSources="${ config.diagnosisConceptSources }"/>
 
             <% 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-angular.js b/omod/src/main/webapp/resources/scripts/diagnoses/diagnoses-angular.js
@@ -4,7 +4,7 @@ var app = angular.module('diagnoses', [])
             // I don't know how to use an angular template programmatically, so use an underscore template instead. :-(
             var itemFormatter = _.template($('#' + attrs.itemformatter).html());
             element.autocomplete({
-                source: emr.fragmentActionLink("coreapps", "diagnoses", "search", {diagnosisSets: attrs.diagnosissets}),
+                source: emr.fragmentActionLink("coreapps", "diagnoses", "search", {diagnosisSets: attrs.diagnosissets, diagnosisConceptSources: attrs.diagnosissonceptsources}),
                 response: function(event, ui) {
                     var query = event.target.value.toLowerCase();
                     var items = ui.content;
diff --git a/omod/src/test/java/org/openmrs/module/coreapps/fragment/controller/DiagnosesFragmentControllerTest.java b/omod/src/test/java/org/openmrs/module/coreapps/fragment/controller/DiagnosesFragmentControllerTest.java
@@ -53,7 +53,7 @@ public class DiagnosesFragmentControllerTest {
     @Test
     public void search_shouldSearchForDiagnosisConceptsFromSpecifiedSets() throws Exception {
         // replay
-        controller.search(context, uiUtils, emrApiProperties, emrConceptService, conceptService, queryString, "1st_diagnosis_set_uuid,2nd_diagnosis_set_uuid", null, null);
+        controller.search(context, uiUtils, emrApiProperties, emrConceptService, conceptService, queryString, "1st_diagnosis_set_uuid,2nd_diagnosis_set_uuid", null, null, null);
         
         // verify
         verify(emrApiProperties, never()).getDiagnosisSets();
@@ -62,7 +62,7 @@ public void search_shouldSearchForDiagnosisConceptsFromSpecifiedSets() throws Ex
     @Test
     public void search_shouldSearchForDiagnosisConceptsUsingGloballyDefinedSuperSetGivenEmptyDiagnosisSets() throws Exception {
         // replay
-        controller.search(context, uiUtils, emrApiProperties, emrConceptService, conceptService, queryString, "", null, null);
+        controller.search(context, uiUtils, emrApiProperties, emrConceptService, conceptService, queryString, "", null, null, null);
 
         // verify
         verify(emrApiProperties, times(1)).getDiagnosisSets();
@@ -71,10 +71,37 @@ public void search_shouldSearchForDiagnosisConceptsUsingGloballyDefinedSuperSetG
     @Test
     public void search_shouldSearchForDiagnosisConceptsUsingGloballyDefinedSuperSetGivenNullDiagnosisSets() throws Exception {
         // replay
-        controller.search(context, uiUtils, emrApiProperties, emrConceptService, conceptService, queryString, null, null, null);
+        controller.search(context, uiUtils, emrApiProperties, emrConceptService, conceptService, queryString, null, null, null, null);
 
         // verify
         verify(emrApiProperties, times(1)).getDiagnosisSets();
 
     }
+
+    @Test
+    public void search_shouldSearchForDiagnosesFromSpecifiedDiagnosisConceptSources() throws Exception {
+        // replay
+        controller.search(context, uiUtils, emrApiProperties, emrConceptService, conceptService, queryString, null, "CIEL,ICD-10-WHO", null, null);
+        
+        // verify
+        verify(emrApiProperties, never()).getConceptSourcesForDiagnosisSearch();
+    }
+
+    @Test
+    public void search_shouldSearchForDiagnosesUsingGloballyDefinedConceptSourcesGivenEmptyDiagnosisConceptSourcesAttr() throws Exception {
+        // replay
+        controller.search(context, uiUtils, emrApiProperties, emrConceptService, conceptService, queryString, null, "", null, null);
+
+        // verify
+        verify(emrApiProperties, times(1)).getConceptSourcesForDiagnosisSearch();
+    }
+
+    @Test
+    public void search_shouldSearchForDiagnosesUsingGloballyDefinedConceptSourcesGivenNullDiagnosisConceptSourcesAttr() throws Exception {
+        // replay
+        controller.search(context, uiUtils, emrApiProperties, emrConceptService, conceptService, queryString, null, null, null, null);
+
+        // verify
+        verify(emrApiProperties, times(1)).getConceptSourcesForDiagnosisSearch();
+    }
 }
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
@@ -131,6 +131,7 @@ public void setUp() throws Exception {
         when(formEntryContext.getMode()).thenReturn(FormEntryContext.Mode.ENTER);
         when(formEntrySession.getContext()).thenReturn(formEntryContext);
         when(uiUtils.message(anyString())).thenReturn("message");
+        // this ensures that our mock of UiUtils renders the fragment it's been given (the third argument)
         when(uiUtils.includeFragment(eq("coreapps"), eq("diagnosis/encounterDiagnoses"), any(Map.class))).thenAnswer(new Answer<String>() {
 			@Override
 			public String answer(InvocationOnMock invocation) throws Throwable {
@@ -365,7 +366,7 @@ public void testEditedResults(SubmissionResults results) {
     }
 
     @Test
-    public void getSubstitution_shouldAddDiagnosisSetsAttributeOnDiagnosisSearchFieldGivenDiagnosisUuids() throws Exception {
+    public void getSubstitution_shouldAddUuidsToDiagnosisSetsAttributeOnDiagnosisSearchFieldGivenDiagnosisUuids() throws Exception {
         // setup
         String diagnosisSetsUuids = GENERAL_AND_SPECIFIED_DIAGNOSIS_SET_UUID + "," + HIV_OPPORTUNISTIC_INFECTION_DIAGNOSIS_SET_UUID;
         
@@ -384,7 +385,7 @@ public void getSubstitution_shouldAddDiagnosisSetsAttributeOnDiagnosisSearchFiel
     }
 
     @Test
-    public void getSubstitution_shouldAddDiagnosisSetsAttributeOnDiagnosisSearchFieldGivenDiagnosisMappings() throws Exception {
+    public void getSubstitution_shouldAddUuidsToDiagnosisSetsAttributeOnDiagnosisSearchFieldGivenDiagnosisMappings() throws Exception {
         // setup
         String diagnosisSetsUuids = GENERAL_AND_SPECIFIED_DIAGNOSIS_SET_UUID + "," + HIV_OPPORTUNISTIC_INFECTION_DIAGNOSIS_SET_UUID;
         
@@ -420,7 +421,7 @@ public void getSubstitution_shouldAddEmptyStringToDiagnosisSetsAttributeOnDiagno
     }
 
     @Test(expected = IllegalArgumentException.class)
-    public void getSubstitution_shouldThrowExceptionDiagnosisSetsAttributeHasNonExistingSets() throws Exception {
+    public void getSubstitution_shouldThrowWhenDiagnosisSetsAttributeContainsInvalidSetsIds() throws Exception {
     	// setup
     	Map<String,String> attributes = new HashMap<String, String>();
         attributes.put("required", "true");
@@ -432,6 +433,42 @@ public void getSubstitution_shouldThrowExceptionDiagnosisSetsAttributeHasNonExis
         encounterDiagnosesTagHandler.getSubstitution(formEntrySession, formSubmissionController, attributes);
     }
 
+    @Test
+    public void getSubstitution_shouldAddDiagnosisConceptSourcesAttributeOnDiagnosisSearchField() throws Exception {
+        // setup
+        String diagnosisConceptSources = "ICPC,CIEL";
+        
+        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("diagnosisConceptSources", "ICPC, CIEL");
+        String generatedHtml = encounterDiagnosesTagHandler.getSubstitution(formEntrySession, formSubmissionController, attributes);
+
+        // verify
+        assertTrue(StringUtils.contains(generatedHtml, "diagnosisConceptSources=\"" + diagnosisConceptSources + "\""));
+    }
+
+    @Test
+    public void getSubstitution_shouldAddEmptyStringToDiagnosisConceptSourcesAttributeOnDiagnosisSearchFieldGivenNullAttribute() throws Exception {
+        // setup
+        String diagnosisConceptSources = "";
+        
+        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("diagnosisConceptSources", null);
+        String generatedHtml = encounterDiagnosesTagHandler.getSubstitution(formEntrySession, formSubmissionController, attributes);
+
+        // verify
+        assertTrue(StringUtils.contains(generatedHtml, "diagnosisConceptSources=\"" + diagnosisConceptSources + "\""));
+    }
+
     private String renderFragmentHtml(Map<String, Object> fragmentConfig) throws Exception {
         InputStream inputStream = getClass().getClassLoader().getResourceAsStream("web/module/fragments/diagnosis/encounterDiagnoses.gsp");
         String string = IOUtils.toString(inputStream, UTF_8.toString());
