Niad 3304 bug fix for description display (#1150)

* * Remove duplicated test

* * Amended test for when Description extension is present with nested display extension when mapping to null flavor codeable concept, to now allow the original text to be taken from the display extension.
* Remove now unneeded function overrides and wrappers which were in place to work around this existing bug.
* Refactor `findOriginalText` to use existing method to retrieve original text

* * Add CHANGELOG.md

* * Remove now unused method in the test file.

Author: MartinWheelerMT

CHANGELOG.md

@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Fixed
+
+* When mapping to `<code nullFlavor="UNK">` XML elements from an existing `CodeableConcept` the element will now contain
+the original text value from the DisplayExtension, if a separate text field is not provided. 
+In the case that neither of these are present, the existing behavior of using the `code.display` element is used. 
+
 ### Added
 
 * GP2GP Adaptor now populates the PlanStatement / confidentialityCode field 

service/src/main/java/uk/nhs/adaptors/gp2gp/ehr/mapper/CodeableConceptCdMapper.java

@@ -4,7 +4,6 @@
 import java.util.List;
 import java.util.Optional;
 import java.util.function.BiFunction;
-import java.util.function.Function;
 
 import org.apache.commons.lang3.StringUtils;
 import org.hl7.fhir.dstu3.model.AllergyIntolerance;
@@ -153,7 +152,7 @@ public String mapCodeableConceptToCdForBloodPressure(CodeableConcept codeableCon
         var mainCode = getSnomedCodeCoding(codeableConcept);
 
         builder.nullFlavor(mainCode.isEmpty());
-        var originalText = findOriginalTextUsingNestedDisplayExtension(codeableConcept, mainCode);
+        var originalText = findOriginalText(codeableConcept, mainCode);
         originalText.ifPresent(builder::mainOriginalText);
 
         if (mainCode.isPresent()) {
@@ -325,10 +324,7 @@ private List<Coding> getNonSnomedCodeCodings(CodeableConcept codeableConcept) {
         return nonSnomedCodeCodings;
     }
 
-    private Optional<String> findOriginalText(
-        CodeableConcept codeableConcept,
-        Optional<Coding> coding,
-        Function<Coding, Optional<String>> findOriginalTextInDisplayExtension) {
+    private Optional<String> findOriginalText(CodeableConcept codeableConcept, Optional<Coding> coding) {
 
         if (codeableConcept.hasText()) {
             return Optional.ofNullable(codeableConcept.getText());
@@ -339,20 +335,12 @@ private Optional<String> findOriginalText(
                 return getCodingDisplayName(coding.get());
             }
 
-            return findOriginalTextInDisplayExtension.apply(coding.get());
+            return getDisplayTextFromDescriptionExtension(coding.get());
         }
 
         return CodeableConceptMappingUtils.extractTextOrCoding(codeableConcept);
     }
 
-    private Optional<String> findOriginalText(CodeableConcept codeableConcept, Optional<Coding> coding) {
-        return findOriginalText(codeableConcept, coding, codingParameter -> Optional.empty());
-    }
-
-    private Optional<String> findOriginalTextUsingNestedDisplayExtension(CodeableConcept codeableConcept, Optional<Coding> coding) {
-        return findOriginalText(codeableConcept, coding, this::getDisplayTextFromDescriptionExtension);
-    }
-
     private Optional<String> findOriginalTextForAllergy(
         CodeableConcept codeableConcept,
         Optional<Coding> coding,

service/src/test/java/uk/nhs/adaptors/gp2gp/ehr/mapper/CodeableConceptCdMapperTest.java

@@ -23,7 +23,6 @@
 
 public class CodeableConceptCdMapperTest {
     private static final String TEST_FILE_DIRECTORY = "/ehr/mapper/codeableconcept/";
-    private static final String TEST_FILE_DIRECTORY_NULL_FLAVOR = "/ehr/mapper/codeableconcept/nullFlavor/";
     private static final String TEST_FILE_DIRECTORY_ACTUAL_PROBLEM = "/ehr/mapper/codeableconcept/actualProblem/";
     private static final String TEST_FILE_DIRECTORY_ALLERGY_RESOLVED = "/ehr/mapper/codeableconcept/allergyResolved/";
     private static final String TEST_FILE_DIRECTORY_ALLERGY_ACTIVE = "/ehr/mapper/codeableconcept/allergyActive/";
@@ -48,10 +47,6 @@ private static Stream<Arguments> getTestArguments() {
         return TestArgumentsLoaderUtil.readTestCases(TEST_FILE_DIRECTORY);
     }
 
-    private static Stream<Arguments> getTestArgumentsNullFlavor() {
-        return TestArgumentsLoaderUtil.readTestCases(TEST_FILE_DIRECTORY_NULL_FLAVOR);
-    }
-
     private static Stream<Arguments> getTestArgumentsActualProblem() {
         return TestArgumentsLoaderUtil.readTestCases(TEST_FILE_DIRECTORY_ACTUAL_PROBLEM);
     }
@@ -184,20 +179,6 @@ public void When_MappingStubbedCodeableConceptForActualProblemHeader_Expect_HL7C
             .isEqualToIgnoringWhitespace(expectedOutput);
     }
 
-    @ParameterizedTest
-    @MethodSource("getTestArgumentsNullFlavor")
-    public void When_MappingStubbedCodeableConceptAsNullFlavor_Expect_HL7CdObjectXml(String inputJson, String outputXml)
-        throws IOException {
-        var observationCodeableConcept = ResourceTestFileUtils.getFileContent(inputJson);
-        var expectedOutput = ResourceTestFileUtils.getFileContent(outputXml);
-        var codeableConcept = fhirParseService.parseResource(observationCodeableConcept, Observation.class).getCode();
-
-        var outputMessage = codeableConceptCdMapper.mapToNullFlavorCodeableConcept(codeableConcept);
-        assertThat(outputMessage)
-            .describedAs(TestArgumentsLoaderUtil.FAIL_MESSAGE, inputJson, outputXml)
-            .isEqualToIgnoringWhitespace(expectedOutput);
-    }
-
     @ParameterizedTest
     @MethodSource("getTestArgumentsAllergyResolved")
     void When_MappingStubbedCodeableConceptAsResolvedAllergy_Expect_HL7CdObjectXml(String inputJson, String outputXml) {
@@ -502,6 +483,7 @@ void When_WithSnomedCodingNoTextNoDisplayWithDescriptionExtensionWithDisplayExte
 
             var expectedOutput = """
                 <code nullFlavor="UNK">
+                    <originalText>Prothrombin time (observed)</originalText>
                 </code>""";
             var codeableConcept = fhirParseService.parseResource(inputJson, Observation.class).getCode();
 
@@ -522,7 +504,7 @@ void When_WithSnomedCodingNoTextNoDisplayWithNonDescriptionExtension_Expect_Snom
                                 "code": "852471000000107",
                                 "extension": [
                                     {
-                                        "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-coding-sctdescid",
+                                        "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-some-other",
                                         "extension": [
                                             {
                                                 "url": "descriptionDisplay",
@@ -547,7 +529,7 @@ void When_WithSnomedCodingNoTextNoDisplayWithNonDescriptionExtension_Expect_Snom
         }
 
         @Test
-        void When_WithNonSnomedCodingWithText_Expect_SnomedCdXmlWithOriginalTexFromText() {
+        void When_WithNonSnomedCodingWithText_Expect_SnomedCdXmlWithOriginalTextFromText() {
             var inputJson = """
                 {
                     "resourceType": "Observation",