NIAD-3004 - Introduce a feature flag which generates "RCMR_IN030000UK07" messages from GP2GP adaptor (#792)

martin-nhs · web-flow · commit 3c76753cf2fc · 2024-07-19T16:35:03.000+01:00
* [NIAD-3004] Add schemas to MiM * [NIAD-3004] Add initial tests * [NIAD-3004] Refactor OutputMessageWrapperMapper, OutputMessageWrapperTemplateParameters and output_message_wrapper_template.mustache to support both interactions * [NIAD-3004] Enhance tests * [NIAD-3004] Add flag to application.yml * [NIAD-3004] Renamed environment variable for flag within application.yml * [NIAD-3004] Address checkstyle violations * [NIAD-3004] Update CHANGELOG.md * [NIAD-3004] Add redactions feature flag to application.yml * [NIAD-3004] Addressed PR comment #792 (comment) * [NIAD-3004] Address PR comment #792 (comment) * [NIAD-3004] Address PR comment #792 (comment)
diff --git a/service/src/intTest/resources/application.yml b/service/src/intTest/resources/application.yml
@@ -14,6 +14,7 @@ management:
         include: info, health, metrics
 
 gp2gp:
+  redactions-enabled: ${GP2GP_REDACTIONS_ENABLED:false}
   largeAttachmentThreshold: ${GP2GP_LARGE_ATTACHMENT_THRESHOLD:4500000} # value in bytes. Default value for Spine is ~4.5MB
   largeEhrExtractThreshold: ${GP2GP_LARGE_ATTACHMENT_THRESHOLD:4500000}
   storage:
diff --git a/service/src/main/java/uk/nhs/adaptors/gp2gp/common/configuration/RedactionsConfiguration.java b/service/src/main/java/uk/nhs/adaptors/gp2gp/common/configuration/RedactionsConfiguration.java
@@ -0,0 +1,26 @@
+package uk.nhs.adaptors.gp2gp.common.configuration;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+class RedactionsConfiguration {
+    private static final String EHR_EXTRACT_INTERACTION_ID = "RCMR_IN030000UK06";
+    private static final String EHR_EXTRACT_INTERACTION_ID_WITH_REDACTIONS = "RCMR_IN030000UK07";
+    private boolean redactionsEnabled;
+
+    @Value("${gp2gp.redactions-enabled}")
+    protected void setRedactionsEnabled(boolean redactionsEnabled) {
+        this.redactionsEnabled = redactionsEnabled;
+    }
+
+    @Bean
+    RedactionsContext redactionsContext() {
+        final String ehrExtractInteractionId = redactionsEnabled
+            ? EHR_EXTRACT_INTERACTION_ID_WITH_REDACTIONS
+            : EHR_EXTRACT_INTERACTION_ID;
+
+        return new RedactionsContext(ehrExtractInteractionId);
+    }
+}
diff --git a/service/src/main/java/uk/nhs/adaptors/gp2gp/common/configuration/RedactionsContext.java b/service/src/main/java/uk/nhs/adaptors/gp2gp/common/configuration/RedactionsContext.java
@@ -0,0 +1,5 @@
+package uk.nhs.adaptors.gp2gp.common.configuration;
+
+public record RedactionsContext(
+    String ehrExtractInteractionId
+) { }
diff --git a/service/src/main/java/uk/nhs/adaptors/gp2gp/ehr/mapper/OutputMessageWrapperMapper.java b/service/src/main/java/uk/nhs/adaptors/gp2gp/ehr/mapper/OutputMessageWrapperMapper.java
@@ -1,11 +1,13 @@
 package uk.nhs.adaptors.gp2gp.ehr.mapper;
 
+import lombok.RequiredArgsConstructor;
+
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 
 import com.github.mustachejava.Mustache;
 
-import lombok.RequiredArgsConstructor;
+import uk.nhs.adaptors.gp2gp.common.configuration.RedactionsContext;
 import uk.nhs.adaptors.gp2gp.common.service.RandomIdGeneratorService;
 import uk.nhs.adaptors.gp2gp.common.service.TimestampService;
 import uk.nhs.adaptors.gp2gp.ehr.mapper.parameters.OutputMessageWrapperTemplateParameters;
@@ -14,14 +16,18 @@
 import uk.nhs.adaptors.gp2gp.gpc.GetGpcStructuredTaskDefinition;
 
 @Component
-@RequiredArgsConstructor(onConstructor = @__(@Autowired))
+@RequiredArgsConstructor(onConstructor_ = @__(@Autowired))
 public class OutputMessageWrapperMapper {
     private static final Mustache TEMPLATE = TemplateUtils.loadTemplate("output_message_wrapper_template.mustache");
+
     private final RandomIdGeneratorService randomIdGeneratorService;
     private final TimestampService timestampService;
+    private final RedactionsContext redactionsContext;
 
     public String map(GetGpcStructuredTaskDefinition getGpcDocumentTaskDefinition, String ehrExtractContent) {
-        OutputMessageWrapperTemplateParameters outputMessageWrapperTemplateParameters = OutputMessageWrapperTemplateParameters.builder()
+        final OutputMessageWrapperTemplateParameters outputMessageWrapperTemplateParameters = OutputMessageWrapperTemplateParameters
+            .builder()
+            .interactionId(redactionsContext.ehrExtractInteractionId())
             .eventId(randomIdGeneratorService.createNewId())
             .creationTime(DateFormatUtil.toHl7Format(timestampService.now()))
             .fromAsid(getGpcDocumentTaskDefinition.getFromAsid())
@@ -31,4 +37,4 @@ public String map(GetGpcStructuredTaskDefinition getGpcDocumentTaskDefinition, S
 
         return TemplateUtils.fillTemplate(TEMPLATE, outputMessageWrapperTemplateParameters);
     }
-}
+}
diff --git a/service/src/main/java/uk/nhs/adaptors/gp2gp/ehr/mapper/parameters/OutputMessageWrapperTemplateParameters.java b/service/src/main/java/uk/nhs/adaptors/gp2gp/ehr/mapper/parameters/OutputMessageWrapperTemplateParameters.java
@@ -6,6 +6,7 @@
 @Data
 @Builder
 public class OutputMessageWrapperTemplateParameters {
+    private String interactionId;
     private String eventId;
     private String creationTime;
     private String fromAsid;
diff --git a/service/src/main/java/uk/nhs/adaptors/gp2gp/mhs/MhsRequestBuilder.java b/service/src/main/java/uk/nhs/adaptors/gp2gp/mhs/MhsRequestBuilder.java
@@ -20,6 +20,7 @@
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import reactor.netty.http.client.HttpClient;
+import uk.nhs.adaptors.gp2gp.common.configuration.RedactionsContext;
 import uk.nhs.adaptors.gp2gp.common.service.RequestBuilderService;
 import uk.nhs.adaptors.gp2gp.common.service.WebClientFilterService;
 import uk.nhs.adaptors.gp2gp.mhs.configuration.MhsClientConfiguration;
@@ -31,7 +32,6 @@
 public class MhsRequestBuilder {
     private static final String ODS_CODE = "ods-code";
     private static final String INTERACTION_ID = "Interaction-Id";
-    private static final String MHS_OUTBOUND_EXTRACT_CORE_INTERACTION_ID = "RCMR_IN030000UK06";
     private static final String CORRELATION_ID = "Correlation-Id";
     private static final String WAIT_FOR_RESPONSE = "wait-for-response";
     private static final String FALSE = "false";
@@ -43,10 +43,11 @@ public class MhsRequestBuilder {
     private final MhsConfiguration mhsConfiguration;
     private final RequestBuilderService requestBuilderService;
     private final MhsClientConfiguration mhsClientConfig;
+    private final RedactionsContext redactionsContext;
 
     public RequestHeadersSpec<?> buildSendEhrExtractCoreRequest(
             String extractCoreMessage, String conversationId, String fromOdsCode, String messageId) {
-        return buildRequest(extractCoreMessage, fromOdsCode, conversationId, MHS_OUTBOUND_EXTRACT_CORE_INTERACTION_ID, messageId);
+        return buildRequest(extractCoreMessage, fromOdsCode, conversationId, redactionsContext.ehrExtractInteractionId(), messageId);
     }
 
     public RequestHeadersSpec<?> buildSendAcknowledgementRequest(
@@ -102,4 +103,4 @@ private WebClient buildWebClient(HttpClient httpClient) {
             .defaultUriVariables(Collections.singletonMap("url", mhsConfiguration.getUrl()))
             .build();
     }
-}
+}
diff --git a/service/src/main/resources/application.yml b/service/src/main/resources/application.yml
@@ -10,6 +10,7 @@ management:
         include: info, health, metrics, mappings
 
 gp2gp:
+  redactions-enabled: ${GP2GP_REDACTIONS_ENABLED:false}
   largeAttachmentThreshold: ${GP2GP_LARGE_ATTACHMENT_THRESHOLD:4500000} # value in bytes. Default value for Spine is ~4.5MB
   largeEhrExtractThreshold: ${GP2GP_LARGE_EHR_EXTRACT_THRESHOLD:4500000}
   storage:
diff --git a/service/src/main/resources/templates/output_message_wrapper_template.mustache b/service/src/main/resources/templates/output_message_wrapper_template.mustache
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<RCMR_IN030000UK06 xmlns="urn:hl7-org:v3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:hl7-org:v3 ..\Schemas\RCMR_IN030000UK06.xsd">
+<{{interactionId}} xmlns="urn:hl7-org:v3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:hl7-org:v3 ..\Schemas\{{interactionId}}.xsd">
     <id root="{{eventId}}" />
     <creationTime value="{{creationTime}}" />
     <versionCode code="V3NPfIT3.1.10" />
-    <interactionId root="2.16.840.1.113883.2.1.3.2.4.12" extension="RCMR_IN030000UK06" />
+    <interactionId root="2.16.840.1.113883.2.1.3.2.4.12" extension="{{interactionId}}" />
     <processingCode code="P" />
     <processingModeCode code="T" />
     <acceptAckCode code="NE" />
@@ -29,4 +29,4 @@
             {{{ehrExtractContent}}}
         </subject>
     </ControlActEvent>
-</RCMR_IN030000UK06>
+</{{interactionId}}>
diff --git a/service/src/test/java/uk/nhs/adaptors/gp2gp/ehr/mapper/OutputMessageWrapperMapperTest.java b/service/src/test/java/uk/nhs/adaptors/gp2gp/ehr/mapper/OutputMessageWrapperMapperTest.java
@@ -1,6 +1,7 @@
 package uk.nhs.adaptors.gp2gp.ehr.mapper;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertAll;
 import static org.mockito.Mockito.when;
 
 import java.io.IOException;
@@ -9,53 +10,83 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.InjectMocks;
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
 
+import uk.nhs.adaptors.gp2gp.common.configuration.RedactionsContext;
 import uk.nhs.adaptors.gp2gp.common.service.RandomIdGeneratorService;
 import uk.nhs.adaptors.gp2gp.common.service.TimestampService;
 import uk.nhs.adaptors.gp2gp.gpc.GetGpcStructuredTaskDefinition;
 import uk.nhs.adaptors.gp2gp.utils.ResourceTestFileUtils;
 
 @ExtendWith(MockitoExtension.class)
-public class OutputMessageWrapperMapperTest {
+class OutputMessageWrapperMapperTest {
     private static final String TEST_ID = "394559384658936";
     private static final String TEST_DATE_TIME = "2020-02-18T17:09:46.01Z";
-    private static final String EXPECTED_OUTPUT_MESSAGE_WRAPPER_XML = "/ehr/mapper/expected-output-message-wrapper.xml";
+    private static final String EHR_EXTRACT_INTERACTION_ID_NO_REDACTIONS = "RCMR_IN030000UK06";
+    private static final String EHR_EXTRACT_INTERACTION_ID_WITH_REDACTIONS = "RCMR_IN030000UK07";
+    private static final String EXPECTED_OUTPUT_MESSAGE_WRAPPER_NO_REDACTIONS_XML
+        = "/ehr/mapper/expected-output-message-wrapper-no-redactions.xml";
+    private static final String EXPECTED_OUTPUT_MESSAGE_WRAPPER_WITH_REDACTIONS_XML
+        = "/ehr/mapper/expected-output-message-wrapper-redactions.xml";
     private static final String TRANSFORMED_EXTRACT = "<EhrExtract classCode=\"EXTRACT\" moodCode=\"EVN\"><id "
         + "root=\"12345\"/></EhrExtract>";
     private static final String TO_ASID_VALUE = "to-asid-value";
     private static final String FROM_ASID_VALUE = "from-asid-value";
 
     @Mock
     private RandomIdGeneratorService randomIdGeneratorService;
+
     @Mock
     private TimestampService timestampService;
 
+    @Mock
+    private RedactionsContext redactionsContext;
+
+    @InjectMocks
     private OutputMessageWrapperMapper outputMessageWrapperMapper;
-    private GetGpcStructuredTaskDefinition getGpcStructuredTaskDefinition;
-    private CharSequence expectedOutputMessage;
+
+    private GetGpcStructuredTaskDefinition gpcStructuredTaskDefinition;
 
     @BeforeEach
-    public void setUp() throws IOException {
+    void setUp() throws IOException {
         when(randomIdGeneratorService.createNewId()).thenReturn(TEST_ID);
         when(timestampService.now()).thenReturn(Instant.parse(TEST_DATE_TIME));
-        outputMessageWrapperMapper = new OutputMessageWrapperMapper(randomIdGeneratorService, timestampService);
 
-        getGpcStructuredTaskDefinition = GetGpcStructuredTaskDefinition.builder()
+        gpcStructuredTaskDefinition = GetGpcStructuredTaskDefinition.builder()
             .toAsid(TO_ASID_VALUE)
             .fromAsid(FROM_ASID_VALUE)
             .build();
+    }
 
-        expectedOutputMessage = ResourceTestFileUtils.getFileContent(EXPECTED_OUTPUT_MESSAGE_WRAPPER_XML);
+    @Test
+    void When_MappingOutputMessageWrapperWithStringContentAndRedactionsDisabled_Expect_UK06InteractionIdToBePresentAndProperXmlOutput() {
+        final String expected = ResourceTestFileUtils.getFileContent(EXPECTED_OUTPUT_MESSAGE_WRAPPER_NO_REDACTIONS_XML);
+
+        when(redactionsContext.ehrExtractInteractionId()).thenReturn(EHR_EXTRACT_INTERACTION_ID_NO_REDACTIONS);
+
+        final String actual = outputMessageWrapperMapper.map(gpcStructuredTaskDefinition, TRANSFORMED_EXTRACT);
+
+        assertAll(
+            () -> assertThat(actual).isEqualToIgnoringWhitespace(expected),
+            () -> assertThat(actual).contains(EHR_EXTRACT_INTERACTION_ID_NO_REDACTIONS),
+            () -> assertThat(actual).doesNotContain(EHR_EXTRACT_INTERACTION_ID_WITH_REDACTIONS)
+        );
     }
 
     @Test
-    public void When_MappingOutputMessageWrapperWithStringContent_Expect_ProperXmlOutput() {
-        String outputMessage = outputMessageWrapperMapper.map(
-            getGpcStructuredTaskDefinition,
-            TRANSFORMED_EXTRACT);
+    void When_MappingOutputMessageWrapperWithStringContentAndRedactionsEnabled_Expect_UK07InteractionIdToBePresentAndProperXmlOutput() {
+        final String expected = ResourceTestFileUtils.getFileContent(EXPECTED_OUTPUT_MESSAGE_WRAPPER_WITH_REDACTIONS_XML);
+
+        when(redactionsContext.ehrExtractInteractionId()).thenReturn(EHR_EXTRACT_INTERACTION_ID_WITH_REDACTIONS);
+
+        final String actual = outputMessageWrapperMapper.map(gpcStructuredTaskDefinition, TRANSFORMED_EXTRACT);
 
-        assertThat(outputMessage).isEqualToIgnoringWhitespace(expectedOutputMessage);
+        assertAll(
+            () -> assertThat(actual).isEqualToIgnoringWhitespace(expected),
+            () -> assertThat(actual).contains(EHR_EXTRACT_INTERACTION_ID_WITH_REDACTIONS),
+            () -> assertThat(actual).doesNotContain(EHR_EXTRACT_INTERACTION_ID_NO_REDACTIONS)
+        );
     }
-}
+}
diff --git a/service/src/test/java/uk/nhs/adaptors/gp2gp/uat/EhrExtractUATTest.java b/service/src/test/java/uk/nhs/adaptors/gp2gp/uat/EhrExtractUATTest.java
@@ -14,6 +14,7 @@
 import org.w3c.dom.NodeList;
 import org.xml.sax.SAXException;
 import uk.nhs.adaptors.gp2gp.RandomIdGeneratorServiceStub;
+import uk.nhs.adaptors.gp2gp.common.configuration.RedactionsContext;
 import uk.nhs.adaptors.gp2gp.common.service.FhirParseService;
 import uk.nhs.adaptors.gp2gp.common.service.RandomIdGeneratorService;
 import uk.nhs.adaptors.gp2gp.common.service.TimestampService;
@@ -79,6 +80,7 @@ public class EhrExtractUATTest {
 
     private EhrExtractMapper ehrExtractMapper;
     private MessageContext messageContext;
+    private RedactionsContext redactionsContext;
     private OutputMessageWrapperMapper outputMessageWrapperMapper;
     private GetGpcStructuredTaskDefinition getGpcStructuredTaskDefinition;
 
@@ -131,7 +133,7 @@ public void setUp() {
         final RandomIdGeneratorService randomIdGeneratorService = new RandomIdGeneratorServiceStub();
         when(timestampService.now()).thenReturn(Instant.parse("2020-01-01T01:01:01.01Z"));
 
-        outputMessageWrapperMapper = new OutputMessageWrapperMapper(randomIdGeneratorService, timestampService);
+        outputMessageWrapperMapper = new OutputMessageWrapperMapper(randomIdGeneratorService, timestampService, redactionsContext);
         messageContext = new MessageContext(randomIdGeneratorService);
 
         CodeableConceptCdMapper codeableConceptCdMapper = new CodeableConceptCdMapper();
diff --git a/service/src/test/resources/ehr/mapper/expected-output-message-wrapper-no-redactions.xml b/service/src/test/resources/ehr/mapper/expected-output-message-wrapper-no-redactions.xml
diff --git a/service/src/test/resources/ehr/mapper/expected-output-message-wrapper-redactions.xml b/service/src/test/resources/ehr/mapper/expected-output-message-wrapper-redactions.xml
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<RCMR_IN030000UK07 xmlns="urn:hl7-org:v3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                   xsi:schemaLocation="urn:hl7-org:v3 ..\Schemas\RCMR_IN030000UK07.xsd">
+    <id root="394559384658936"/>
+    <creationTime value="20200218170946"/>
+    <versionCode code="V3NPfIT3.1.10"/>
+    <interactionId root="2.16.840.1.113883.2.1.3.2.4.12" extension="RCMR_IN030000UK07"/>
+    <processingCode code="P"/>
+    <processingModeCode code="T"/>
+    <acceptAckCode code="NE"/>
+    <communicationFunctionRcv typeCode="RCV">
+        <device classCode="DEV" determinerCode="INSTANCE">
+            <id root="1.2.826.0.1285.0.2.0.107" extension="from-asid-value"/>
+        </device>
+    </communicationFunctionRcv>
+    <communicationFunctionSnd typeCode="SND">
+        <device classCode="DEV" determinerCode="INSTANCE">
+            <id root="1.2.826.0.1285.0.2.0.107" extension="to-asid-value"/>
+        </device>
+    </communicationFunctionSnd>
+    <ControlActEvent classCode="CACT" moodCode="EVN">
+        <author1 typeCode="AUT">
+            <AgentSystemSDS classCode="AGNT">
+                <agentSystemSDS classCode="DEV" determinerCode="INSTANCE">
+                    <id root="1.2.826.0.1285.0.2.0.107" extension="to-asid-value"/>
+                </agentSystemSDS>
+            </AgentSystemSDS>
+        </author1>
+        <subject typeCode="SUBJ" contextConductionInd="false">
+            <EhrExtract classCode="EXTRACT" moodCode="EVN">
+                <id root="12345"/>
+            </EhrExtract>
+        </subject>
+    </ControlActEvent>
+</RCMR_IN030000UK07>
diff --git a/service/src/test/resources/mim/Schemas/RCMR_IN030000UK07.xsd b/service/src/test/resources/mim/Schemas/RCMR_IN030000UK07.xsd
diff --git a/service/src/test/resources/mim/Schemas/RCMR_MT030101UK05.xsd b/service/src/test/resources/mim/Schemas/RCMR_MT030101UK05.xsd
