NIAD-3144-OBSERVATIONS - Confidentiality Code (i.e. Redactions) Support for Observation > Test Group, Test Result and Narrative (#840)

* [NIAD-3144-OBSERVATIONS] Add initial tests

* [NIAD-3144-OBSERVATIONS] Add test resources

* [NIAD-3144-OBSERVATIONS] Update templates

* [NIAD-3144-OBSERVATIONS] Add logic to ObservationMapper.java to add confidentialityCode support to `Observation` > `TestGroup`, `NarrativeStatement` and `TestResult`

* [NIAD-3144-OBSERVATIONS] Add logic to ObservationMapper.java to add confidentialityCode support to `Observation` > `TestGroup`, `NarrativeStatement` and `TestResult`

* [NIAD-3144-OBSERVATIONS] Update tests which constructs a new `ObservationMapper` to take a `confidentialityService` mock

* [NIAD-3144-OBSERVATIONS] Address checkstyle violations

* [NIAD-3144-OBSERVATIONS] Address failing mutation test

* [NIAD-3144-OBSERVATIONS] Address failing mutation test

* [NIAD-3144-OBSERVATIONS] Address failing mutation test

* [NIAD-3144-OBSERVATIONS] Address failing mutation test

* [NIAD-3112] Enhance tests, remove unnecessary XML resources, add utility methods

* [NIAD-3112] Address PR comments #840 (comment) & #840 (comment)

* [NIAD-3144-OBSERVATIONS] Update CHANGELOG.md

* [NIAD-3144-OBSERVATIONS] Address Checkstyle violations

Author: martin-nhs

CHANGELOG.md

@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 will contain a `NOPAT` `confidentialityCode` element.
 * When mapping a `DiagnosticReport` or `Specimen` which contains a `NOPAT` `meta.security` tag the resultant XML for that resource
   will contain a `NOPAT` `confidentialityCode` element.
+* When mapping a `TestResult`, `TestGroupHeader` or `FilingComment` which contains a `NOPAT` `meta.security` tag the resultant XML 
+  for that resource will contain a `NOPAT` `confidentialityCode` element.
 
 ## [2.0.6] - 2024-07-29
 

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

@@ -29,6 +29,7 @@
 
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
+import uk.nhs.adaptors.gp2gp.common.service.ConfidentialityService;
 import uk.nhs.adaptors.gp2gp.ehr.exception.EhrMapperException;
 import uk.nhs.adaptors.gp2gp.ehr.mapper.CodeableConceptCdMapper;
 import uk.nhs.adaptors.gp2gp.ehr.mapper.CommentType;
@@ -87,6 +88,7 @@ public class ObservationMapper {
     private final CodeableConceptCdMapper codeableConceptCdMapper;
     private final ParticipantMapper participantMapper;
     private final MultiStatementObservationHolderFactory multiStatementObservationHolderFactory;
+    private final ConfidentialityService confidentialityService;
 
     public String mapObservationToCompoundStatement(Observation observationAssociatedWithSpecimen) {
         var holder = multiStatementObservationHolderFactory.newInstance(observationAssociatedWithSpecimen);
@@ -156,6 +158,7 @@ private String outputWithCompoundStatement(MultiStatementObservationHolder obser
             .codeElement(codeElement)
             .effectiveTime(effectiveTime)
             .availabilityTimeElement(availabilityTimeElement)
+            .confidentialityCode(confidentialityService.generateConfidentialityCode(observation).orElse(null))
             .observationStatement(observationStatement)
             .narrativeStatements(narrativeStatements)
             .statementsForDerivedObservations(statementsForDerivedObservations);
@@ -181,8 +184,10 @@ private List<MultiStatementObservationHolder> getRelatedObservations(
 
     private String outputWithoutCompoundStatement(MultiStatementObservationHolder observationAssociatedWithSpecimen) {
         CompoundStatementClassCode classCode = CompoundStatementClassCode.CLUSTER;
+
         String observationStatement = prepareObservationStatement(observationAssociatedWithSpecimen, classCode)
             .orElse(StringUtils.EMPTY);
+
         String narrativeStatements = prepareNarrativeStatements(
             observationAssociatedWithSpecimen,
             isInterpretationCodeMapped(observationStatement))
@@ -205,7 +210,8 @@ private String mapObservationToObservationStatement(MultiStatementObservationHol
             .observationStatementId(holder.nextHl7InstanceIdentifier())
             .codeElement(prepareCodeElement(holder.getObservation()))
             .effectiveTime(StatementTimeMappingUtils.prepareEffectiveTimeForObservation(holder.getObservation()))
-            .availabilityTimeElement(StatementTimeMappingUtils.prepareAvailabilityTimeForObservation(holder.getObservation()));
+            .availabilityTimeElement(StatementTimeMappingUtils.prepareAvailabilityTimeForObservation(holder.getObservation()))
+            .confidentialityCode(confidentialityService.generateConfidentialityCode(holder.getObservation()).orElse(null));
 
         if (holder.getObservation().hasValue() && !holder.getObservation().hasValueStringType()) {
             Type value = holder.getObservation().getValue();
@@ -397,7 +403,8 @@ private String mapObservationToNarrativeStatement(MultiStatementObservationHolde
             .commentType(commentType)
             .commentDate(handleEffectiveToCommentDate(observation))
             .comment(comment)
-            .availabilityTimeElement(StatementTimeMappingUtils.prepareAvailabilityTimeForObservation(observation));
+            .availabilityTimeElement(StatementTimeMappingUtils.prepareAvailabilityTimeForObservation(observation))
+            .confidentialityCode(confidentialityService.generateConfidentialityCode(observation).orElse(null));
 
         return TemplateUtils.fillTemplate(NARRATIVE_STATEMENT_TEMPLATE, narrativeStatementTemplateParameters.build());
     }

service/src/main/java/uk/nhs/adaptors/gp2gp/ehr/mapper/parameters/diagnosticreport/NarrativeStatementTemplateParameters.java

@@ -13,5 +13,6 @@ public class NarrativeStatementTemplateParameters {
     private String commentDate;
     private String comment;
     private String availabilityTimeElement;
+    private String confidentialityCode;
     private String participant;
 }

service/src/main/java/uk/nhs/adaptors/gp2gp/ehr/mapper/parameters/diagnosticreport/ObservationCompoundStatementTemplateParameters.java

@@ -13,6 +13,7 @@ public class ObservationCompoundStatementTemplateParameters {
     private String codeElement;
     private String effectiveTime;
     private String availabilityTimeElement;
+    private String confidentialityCode;
     private String observationStatement;
     private String narrativeStatements;
     private String statementsForDerivedObservations;

service/src/main/java/uk/nhs/adaptors/gp2gp/ehr/mapper/parameters/diagnosticreport/ObservationStatementTemplateParameters.java

@@ -12,6 +12,7 @@ public class ObservationStatementTemplateParameters {
     private String codeElement;
     private String effectiveTime;
     private String availabilityTimeElement;
+    private String confidentialityCode;
     private String value;
     private String referenceRange;
     private String interpretation;

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

@@ -9,6 +9,9 @@ CommentDate:{{{.}}}
 {{comment}}</text>
         <statusCode code="COMPLETE"/>
         {{{availabilityTimeElement}}}
+        {{#confidentialityCode}}
+            {{{confidentialityCode}}}
+        {{/confidentialityCode}}
         {{#participant}}
             {{{.}}}
         {{/participant}}

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

@@ -7,6 +7,9 @@
             {{{effectiveTime}}}
         </effectiveTime>
         {{{availabilityTimeElement}}}
+        {{#confidentialityCode}}
+            {{{confidentialityCode}}}
+        {{/confidentialityCode}}
         {{#observationStatement}}
             {{{.}}}
         {{/observationStatement}}

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

@@ -7,6 +7,9 @@
             {{{effectiveTime}}}
         </effectiveTime>
         {{{availabilityTimeElement}}}
+        {{#confidentialityCode}}
+            {{{confidentialityCode}}}
+        {{/confidentialityCode}}
         {{#value}}
             {{{.}}}
         {{/value}}

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

@@ -152,7 +152,7 @@ public void setUp() {
             new MultiStatementObservationHolderFactory(messageContext, randomIdGeneratorService);
         ObservationMapper specimenObservationMapper = new ObservationMapper(
             messageContext, structuredObservationValueMapper, codeableConceptCdMapper,
-            participantMapper, multiStatementObservationHolderFactory);
+            participantMapper, multiStatementObservationHolderFactory, confidentialityService);
         SpecimenMapper specimenMapper = new SpecimenMapper(messageContext, specimenObservationMapper,
             randomIdGeneratorService, confidentialityService);
         DocumentReferenceToNarrativeStatementMapper documentReferenceToNarrativeStatementMapper

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

@@ -195,7 +195,7 @@ public void setUp() {
             new MultiStatementObservationHolderFactory(messageContext, randomIdGeneratorService);
         ObservationMapper specimenObservationMapper = new ObservationMapper(
             messageContext, structuredObservationValueMapper, codeableConceptCdMapper, participantMapper,
-            multiStatementObservationHolderFactory);
+            multiStatementObservationHolderFactory, confidentialityService);
         return new SpecimenMapper(messageContext, specimenObservationMapper, randomIdGeneratorService, confidentialityService);
     }