Merge pull request #1422 from b2ihealthcare/fix/SO-6343-valueset-include-designations-display-bug

SO-6343: Valueset include designations display bug

Author: cmark

fhir/com.b2international.snowowl.fhir.rest.tests/src/com/b2international/snowowl/fhir/rest/tests/FhirRestTest.java

@@ -24,8 +24,8 @@
 import org.junit.Before;
 import org.junit.Rule;
 
-import com.b2international.snowowl.snomed.common.SnomedTerminologyComponentConstants;
 import com.b2international.snowowl.snomed.common.SnomedConstants.Concepts;
+import com.b2international.snowowl.snomed.common.SnomedTerminologyComponentConstants;
 import com.b2international.snowowl.test.commons.TestMethodNameRule;
 import com.b2international.snowowl.test.commons.codesystem.CodeSystemRestRequests;
 
@@ -95,9 +95,20 @@ protected final static void checkDesignationUseContext(JsonPath jsonPath, String
 
 		assertThat(jsonPath.getString("extension[0].url")).isEqualTo("context");
 		assertThat(jsonPath.getString("extension[0].valueCoding.code")).isEqualTo(refsetId);
+		
 		assertThat(jsonPath.getString("extension[1].url")).isEqualTo("role");
 		assertThat(jsonPath.getString("extension[1].valueCoding.code")).isEqualTo(Concepts.REFSET_DESCRIPTION_ACCEPTABILITY_PREFERRED);
+		assertThat(jsonPath.getString("extension[1].valueCoding.display")).isEqualTo("Preferred");
+		
 		assertThat(jsonPath.getString("extension[2].url")).isEqualTo("type");
 		assertThat(jsonPath.getString("extension[2].valueCoding.code")).isEqualTo(typeId);
+		
+		String display = jsonPath.getString("extension[2].valueCoding.display");
+		
+		if (Concepts.FULLY_SPECIFIED_NAME.equals(typeId)) {
+			assertThat(display).isEqualTo("Fully specified name");
+		} else if (Concepts.SYNONYM.equals(typeId)) {
+			assertThat(display).isEqualTo("Synonym");
+		}
 	}
 }

snomed/com.b2international.snowowl.snomed.datastore/src/com/b2international/snowowl/snomed/core/domain/Acceptability.java

@@ -31,17 +31,19 @@ public enum Acceptability {
 	/**
 	 * Description is acceptable in language or dialect
 	 */
-	ACCEPTABLE(Concepts.REFSET_DESCRIPTION_ACCEPTABILITY_ACCEPTABLE),
+	ACCEPTABLE(Concepts.REFSET_DESCRIPTION_ACCEPTABILITY_ACCEPTABLE, "Acceptable"),
 
 	/**
 	 * Description is preferred in language or dialect
 	 */
-	PREFERRED(Concepts.REFSET_DESCRIPTION_ACCEPTABILITY_PREFERRED);
+	PREFERRED(Concepts.REFSET_DESCRIPTION_ACCEPTABILITY_PREFERRED, "Preferred");
 
 	private final String conceptId;
+	private final String label;
 
-	private Acceptability(final String conceptId) {
+	private Acceptability(final String conceptId, String label) {
 		this.conceptId = conceptId;
+		this.label = label;
 	}
 
 	/**
@@ -52,6 +54,10 @@ private Acceptability(final String conceptId) {
 	public String getConceptId() {
 		return conceptId;
 	}
+	
+	public String getLabel() {
+		return label;
+	}
 
 	/**
 	 * Performs a reverse lookup by concept identifier and returns the matching acceptability value.

snomed/com.b2international.snowowl.snomed.datastore/src/com/b2international/snowowl/snomed/core/request/SnomedConceptSearchRequestEvaluator.java

@@ -36,7 +36,6 @@
 import com.b2international.snowowl.snomed.core.domain.SnomedConcept;
 import com.b2international.snowowl.snomed.core.domain.SnomedConcepts;
 import com.b2international.snowowl.snomed.core.domain.SnomedDescription;
-import com.b2international.snowowl.snomed.core.domain.SnomedDescriptions;
 import com.b2international.snowowl.snomed.datastore.request.SnomedConceptSearchRequestBuilder;
 import com.b2international.snowowl.snomed.datastore.request.SnomedRequests;
 import com.google.common.base.Strings;
@@ -120,7 +119,7 @@ public Concepts evaluate(ResourceURI uri, ServiceProvider context, Options searc
 	private Concept toConcept(ResourceURI codeSystem, SnomedConcept snomedConcept, String pt, boolean requestedExpand) {
 		final Concept concept = toConcept(codeSystem, snomedConcept, snomedConcept.getIconId(), pt, snomedConcept.getScore());
 
-		SortedSet<Description> descriptions = generateGenericDescriptions(snomedConcept.getPreferredDescriptions());
+		SortedSet<Description> descriptions = generateGenericDescriptions(snomedConcept);
 
 		if (!descriptions.isEmpty()) {
 			concept.setDescriptions(descriptions);
@@ -136,16 +135,20 @@ private Concept toConcept(ResourceURI codeSystem, SnomedConcept snomedConcept, S
 	}
 
 	/**
-	 * Generates generic {@link Description} objects for each {@link SnomedDescription} in the given {@link SnomedDescriptions}. This method combines
+	 * Generates generic {@link Description} objects from the descriptions of the given {@link SnomedConcept}. 
+	 * The method uses {@link SnomedConcept#getDescriptions() concept descriptions} when available; if that collection is {@code null}, 
+	 * it falls back to {@link SnomedConcept#getPreferredDescriptions() preferred descriptions}. This method combines
 	 * the language code and each language reference set acceptability membership of the {@link SnomedDescription} to generate a generic
 	 * {@link Description} representation. The number of {@link Description}s generated can be higher than the given number of
 	 * {@link SnomedDescription}s.
-	 * 
-	 * @param descriptions
-	 * @return a {@link SortedSet} of {@link Description} objects, never <code>null</code>
+	 *
+	 * @param concept the {@link SnomedConcept} to read descriptions from
+	 * @return a {@code SortedSet<Description>} of {@link Description} objects, never <code>null</code>
 	 */
-	public static SortedSet<Description> generateGenericDescriptions(SnomedDescriptions descriptions) {
-		return descriptions.stream()
+	public static SortedSet<Description> generateGenericDescriptions(SnomedConcept concept) {
+		return Optional.ofNullable(concept.getDescriptions())
+				.orElse(concept.getPreferredDescriptions())
+				.stream()
 				.flatMap(description -> {
 					// FIXME falling back to en when the languageCode is not available on concept descriptions
 					// descriptions expand is needed but only when the requestor truly needs them, but that requires a bit larger set of changes

snomed/com.b2international.snowowl.snomed.fhir/src/com/b2international/snowowl/snomed/fhir/SnomedFhirCodeSystemLookupConverter.java

@@ -103,7 +103,7 @@ public List<CodeSystemLookupResultParameters.Designation> expandDesignations(Ser
 					// FIXME: "system" may need to be set to the code system's URL we are calling from
 					.setSystem(SNOMED_SYSTEM_URL)
 					.setCode(acceptability.getConceptId())
-					.setDisplay(acceptability.name());
+					.setDisplay(acceptability.getLabel());
 
 				final Extension useContextExtension = new Extension("http://snomed.info/fhir/StructureDefinition/designation-use-context");
 

snomed/com.b2international.snowowl.snomed.fhir/src/com/b2international/snowowl/snomed/fhir/SnomedFhirValueSetExpander.java

@@ -63,7 +63,9 @@ public ValueSet expand(ServiceProvider context, ValueSet valueSet, ValueSetExpan
 			.setLimit(parameters.getCount() == null ? 10 : parameters.getCount().getValue())
 			.setSearchAfter(parameters.getAfter() == null ? null : parameters.getAfter().getValue())
 			// SNOMED only preferred display support (VS should always use FSN)
-			.setPreferredDisplay("FSN") 
+			.setPreferredDisplay("FSN")
+			// Expand descriptions so that type information can be extracted later
+			.setExpand("descriptions(expand(type(expand(pt()))))")
 			.setLocales(FhirRequest.compactLocale(parameters.getDisplayLanguage()))
 			// always return sorted results for consistency, in case of term filtering return by score otherwise by ID
 			.sortBy(!CompareUtils.isEmpty(termFilter) ? SearchIndexResourceRequest.SCORE : SearchResourceRequest.Sort.fieldAsc("id"));
@@ -162,7 +164,7 @@ private void includeDesignations(final String baseUrl, Concept concept, ValueSet
 					// FIXME: "system" may need to be set to the code system's URL we are calling from
 					.setSystem(baseUrl)
 					.setCode(acceptability.getConceptId())
-					.setDisplay(acceptability.name());
+					.setDisplay(acceptability.getLabel());
 
 				final Extension useContextExtension = new Extension("http://snomed.info/fhir/StructureDefinition/designation-use-context");