NIAD-3152: Send over ProcedureRequest.meta.security NOPAT field to incumbent (#1145)

* covering code with a test

* checkstyle

* changelog update

Author: ORybak5

CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+* GP2GP Adaptor now populates the PlanStatement / confidentialityCode field 
+when the ProcedureRequest.meta.security field contains NOPAT and the message type is RCMR_IN030000UK07
+
 ## [2.2.2] - 2025-02-07
 
 ### Fixed

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

@@ -26,6 +26,7 @@
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 import lombok.Setter;
+import uk.nhs.adaptors.gp2gp.common.service.ConfidentialityService;
 import uk.nhs.adaptors.gp2gp.ehr.exception.EhrMapperException;
 import uk.nhs.adaptors.gp2gp.ehr.mapper.DiaryPlanStatementMapper.PlanStatementMapperParameters.PlanStatementMapperParametersBuilder;
 import uk.nhs.adaptors.gp2gp.ehr.utils.CodeableConceptMappingUtils;
@@ -49,6 +50,7 @@ public class DiaryPlanStatementMapper {
     private final MessageContext messageContext;
     private final CodeableConceptCdMapper codeableConceptCdMapper;
     private final ParticipantMapper participantMapper;
+    private final ConfidentialityService confidentialityService;
 
     public String mapProcedureRequestToPlanStatement(ProcedureRequest procedureRequest, Boolean isNested) {
         if (procedureRequest.getIntent() == ProcedureRequest.ProcedureRequestIntent.PLAN) {
@@ -61,13 +63,16 @@ public String mapProcedureRequestToPlanStatement(ProcedureRequest procedureReque
     private String mapDiaryEntryToPlanStatement(ProcedureRequest procedureRequest, Boolean isNested) {
         var idMapper = messageContext.getIdMapper();
         var availabilityTime = buildAvailabilityTime(procedureRequest);
+        var confidentialityCode = confidentialityService.generateConfidentialityCode(procedureRequest);
+
         PlanStatementMapperParametersBuilder builder = PlanStatementMapperParameters.builder()
             .isNested(isNested)
             .id(idMapper.getOrNew(ResourceType.ProcedureRequest, procedureRequest.getIdElement()))
             .availabilityTime(availabilityTime)
             .effectiveTime(buildEffectiveTime(procedureRequest))
             .text(buildText(procedureRequest))
-            .code(buildCode(procedureRequest));
+            .code(buildCode(procedureRequest))
+            .confidentialityCode(confidentialityCode.orElse(null));
 
         buildParticipant(procedureRequest).ifPresent(builder::participant);
 
@@ -139,7 +144,7 @@ private Optional<String> getSupportingInformation(ProcedureRequest procedureRequ
         if (procedureRequest.hasSupportingInfo()) {
             return Optional.of("Supporting Information: " + procedureRequest.getSupportingInfo().stream()
                 .filter(this::checkIfReferenceIsObservation)
-                .map((observationReference) -> extractObservation(messageContext, observationReference))
+                .map(observationReference -> extractObservation(messageContext, observationReference))
                 .collect(Collectors.joining(COMMA)));
         }
         return Optional.empty();
@@ -230,5 +235,6 @@ public static class PlanStatementMapperParameters {
         private String effectiveTime;
         private String code;
         private String participant;
+        private String confidentialityCode;
     }
 }

service/src/main/resources/templates/ehr_plan_statement_template.mustache

@@ -12,6 +12,9 @@
             <center {{{effectiveTime}}}/>
         </effectiveTime>
         {{#availabilityTime}}<availabilityTime value="{{.}}"/>{{/availabilityTime}}
+        {{#confidentialityCode}}
+            {{{confidentialityCode}}}
+        {{/confidentialityCode}}
         {{#author}}
         <author typeCode="AUT" contextControlCode="OP">
             {{#authorTime}}<time value="{{.}}" />{{/authorTime}}

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

@@ -5,8 +5,7 @@
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.Mockito.when;
-
-import java.io.IOException;
+import java.util.Optional;
 import java.util.stream.Stream;
 
 import org.hl7.fhir.dstu3.model.Bundle;
@@ -22,6 +21,7 @@
 import org.mockito.junit.jupiter.MockitoSettings;
 import org.mockito.quality.Strictness;
 
+import uk.nhs.adaptors.gp2gp.common.service.ConfidentialityService;
 import uk.nhs.adaptors.gp2gp.common.service.FhirParseService;
 import uk.nhs.adaptors.gp2gp.common.service.RandomIdGeneratorService;
 import uk.nhs.adaptors.gp2gp.ehr.exception.EhrMapperException;
@@ -57,16 +57,23 @@ public class DiaryPlanStatementMapperTest {
         + "expected-output-procedure-request-resource-with-multiple-supportInfo.xml";
     private static final String INPUT_BUNDLE = TEST_DIRECTORY + "input-bundle.json";
 
+    public static final String CONFIDENTIALITY_CODE = "<confidentialityCode code=\"NOPAT\" "
+                                                      + "codeSystem=\"2.16.840.1.113883.4.642.3.47\" "
+                                                      + "displayName=\"no disclosure to patient, family or "
+                                                      + "caregivers without attending provider's authorization\" />";
+
     @Mock
     private RandomIdGeneratorService randomIdGeneratorService;
     @Mock
     private CodeableConceptCdMapper codeableConceptCdMapper;
+    @Mock
+    private ConfidentialityService confidentialityService;
 
     private MessageContext messageContext;
     private DiaryPlanStatementMapper diaryPlanStatementMapper;
 
     @BeforeEach
-    public void setUp() throws IOException {
+    public void setUp() {
         String inputJson = ResourceTestFileUtils.getFileContent(INPUT_BUNDLE);
         Bundle bundle = new FhirParseService().parseResource(inputJson, Bundle.class);
 
@@ -78,7 +85,7 @@ public void setUp() throws IOException {
         messageContext.initialize(bundle);
 
         diaryPlanStatementMapper =
-            new DiaryPlanStatementMapper(messageContext, codeableConceptCdMapper, new ParticipantMapper());
+            new DiaryPlanStatementMapper(messageContext, codeableConceptCdMapper, new ParticipantMapper(), confidentialityService);
     }
 
     @AfterEach
@@ -87,7 +94,19 @@ public void tearDown() {
     }
 
     @Test
-    public void When_MappingProcedureRequestIsNested_Expect_ResourceMappedWithIsNestedFlag() throws IOException {
+    public void When_MappingProcedureRequestWithNopat_Expect_ResourceMappedWithConfidentialityCode() {
+        String inputJson = ResourceTestFileUtils.getFileContent(INPUT_PROCEDURE_REQUEST_WITH_ALL_DATA);
+        ProcedureRequest inputProcedureRequest = new FhirParseService().parseResource(inputJson, ProcedureRequest.class);
+
+        when(confidentialityService.generateConfidentialityCode(inputProcedureRequest)).thenReturn(Optional.of(CONFIDENTIALITY_CODE));
+
+        var mappedXml = diaryPlanStatementMapper.mapProcedureRequestToPlanStatement(inputProcedureRequest, true);
+        assertThat(mappedXml).contains(CONFIDENTIALITY_CODE);
+    }
+
+
+    @Test
+    public void When_MappingProcedureRequestIsNested_Expect_ResourceMappedWithIsNestedFlag() {
         String expectedXml = ResourceTestFileUtils.getFileContent(EXPECTED_PLAN_STATEMENT_WITH_IS_NESTED);
 
         String inputJson = ResourceTestFileUtils.getFileContent(INPUT_PROCEDURE_REQUEST_WITH_ALL_DATA);
@@ -98,7 +117,7 @@ public void When_MappingProcedureRequestIsNested_Expect_ResourceMappedWithIsNest
     }
 
     @Test
-    public void When_MappingProcedureRequestThatIsNotPlan_Expect_ResourceNotMapped() throws IOException {
+    public void When_MappingProcedureRequestThatIsNotPlan_Expect_ResourceNotMapped() {
         String inputJson = ResourceTestFileUtils.getFileContent(INPUT_PROCEDURE_REQUEST_IS_NOT_PLAN);
         ProcedureRequest inputProcedureRequest = new FhirParseService().parseResource(inputJson, ProcedureRequest.class);
 
@@ -107,7 +126,7 @@ public void When_MappingProcedureRequestThatIsNotPlan_Expect_ResourceNotMapped()
     }
 
     @Test
-    public void When_MappingProcedureRequestWithoutRequiredAuthoredOn_Expect_MapperException() throws IOException {
+    public void When_MappingProcedureRequestWithoutRequiredAuthoredOn_Expect_MapperException() {
         String inputJson = ResourceTestFileUtils.getFileContent(INPUT_PROCEDURE_REQUEST_WITHOUT_REQUIRED_AUTHORED_ON);
         ProcedureRequest inputProcedureRequest = new FhirParseService().parseResource(inputJson, ProcedureRequest.class);
 
@@ -275,7 +294,7 @@ public void When_MappingWithDeviceReferenceWhereDeviceHasNoManufacturer_Expect_T
 
     @ParameterizedTest
     @MethodSource("testData")
-    public void When_MappingProcedureRequest_Expect_ResourceMapped(String inputJsonPath, String expectedXmlPath) throws IOException {
+    public void When_MappingProcedureRequest_Expect_ResourceMapped(String inputJsonPath, String expectedXmlPath) {
         String expectedXml = ResourceTestFileUtils.getFileContent(expectedXmlPath);
 
         String inputJson = ResourceTestFileUtils.getFileContent(inputJsonPath);

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

@@ -164,7 +164,7 @@ messageContext, randomIdGeneratorService, new StructuredObservationValueMapper()
                 codeableConceptCdMapper, new ParticipantMapper()),
             new ConditionLinkSetMapper(
                 messageContext, randomIdGeneratorService, codeableConceptCdMapper, participantMapper, confidentialityService),
-            new DiaryPlanStatementMapper(messageContext, codeableConceptCdMapper, participantMapper),
+            new DiaryPlanStatementMapper(messageContext, codeableConceptCdMapper, participantMapper, confidentialityService),
             documentReferenceToNarrativeStatementMapper,
             new ImmunizationObservationStatementMapper(
                 messageContext,

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

@@ -152,7 +152,7 @@ public void setUp() {
             confidentialityService
         );
         DiaryPlanStatementMapper diaryPlanStatementMapper
-            = new DiaryPlanStatementMapper(messageContext, codeableConceptCdMapper, participantMapper);
+            = new DiaryPlanStatementMapper(messageContext, codeableConceptCdMapper, participantMapper, confidentialityService);
         DocumentReferenceToNarrativeStatementMapper documentReferenceToNarrativeStatementMapper
             = new DocumentReferenceToNarrativeStatementMapper(
                 messageContext, new SupportedContentTypes(), participantMapper, confidentialityService);

service/src/test/java/uk/nhs/adaptors/gp2gp/uat/EhrExtractUATTest.java

@@ -184,7 +184,7 @@ messageContext, randomIdGeneratorService, new StructuredObservationValueMapper()
                 codeableConceptCdMapper, new ParticipantMapper()),
             new ConditionLinkSetMapper(
                 messageContext, randomIdGeneratorService, codeableConceptCdMapper, participantMapper, confidentialityService),
-            new DiaryPlanStatementMapper(messageContext, codeableConceptCdMapper, participantMapper),
+            new DiaryPlanStatementMapper(messageContext, codeableConceptCdMapper, participantMapper, confidentialityService),
             documentReferenceToNarrativeStatementMapper,
             new ImmunizationObservationStatementMapper(
                 messageContext,

service/src/test/resources/ehr/mapper/procedurerequest/procedure-request-resource-1.json

@@ -1,6 +1,16 @@
 {
     "resourceType": "ProcedureRequest",
     "id": "1B1C6F50-D8BE-4480-83D6-EF25AC5F1836",
+    "meta": {
+        "profile": [
+            "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Immunization-1"
+        ],
+        "security": [{
+            "system":"http://hl7.org/fhir/v3/ActCode",
+            "code":"NOPAT",
+            "display":"no disclosure to patient, family or caregivers without attending provider's authorization"
+        }]
+    },
     "status": "active",
     "intent": "plan",
     "code": {