VED-854 High/Medium priority Sonar maintainability issues (#1248)

amarauzoma · JamesW1-NHS · web-flow · commit ac6dcc4886ed · 2026-02-27T12:41:51.000Z
* high/medium priority Sonar maintainability issues

* version

* field names

* post_validator cleanup

---------

Co-authored-by: James Wharmby &lt;james.wharmby1@nhs.net&gt;
Co-authored-by: James W. &lt;218585646+JamesW1-NHS@users.noreply.github.com&gt;
diff --git a/lambdas/shared/src/common/models/fhir_immunization_post_validators.py b/lambdas/shared/src/common/models/fhir_immunization_post_validators.py
@@ -19,8 +19,19 @@ def __init__(self, imms, vaccine_type):
         # Note that the majority of fields require standard validation. Exception not included in the below list is
         # reason_code_coding_code, which has its own bespoke validation function.
         # Status is mandatory in FHIR, so there is no post-validation for status as it is handled by the FHIR validator.
-        # NOTE: SOME FIELDS ARE COMMENTED OUT AS THEY ARE REQUIRED ELEMENTS (VALIDATION SHOULD ALWAYS PASS), AND THE
-        # MEANS TO ACCESS THE VALUE HAS NOT BEEN CONFIRMED. DO NOT DELETE THE FIELDS, THEY MAY NEED REINSTATED LATER.
+
+        # Note: some fields are commented out as they are required elements (validation should always pass), and the
+        # means to access the value has not been confirmed. Do not delete the fields, they may need reinstating later.
+
+        # These are the fields that we may require to reinstate in the future:
+        #   vaccination_procedure_display
+        #   vaccine_code_coding_code
+        #   vaccine_code_coding_display
+        #   site_coding_code
+        #   site_coding_display
+        #   route_coding_code
+        #   route_coding_display
+
         self.fields_with_standard_validation = [
             FieldNames.patient_identifier_value,
             FieldNames.patient_name_given,
@@ -38,17 +49,10 @@ def __init__(self, imms, vaccine_type):
             FieldNames.recorded,
             FieldNames.primary_source,
             FieldNames.vaccination_procedure_code,
-            # FieldNames.vaccination_procedure_display,
             FieldNames.dose_number_positive_int,
-            # FieldNames.vaccine_code_coding_code,
-            # FieldNames.vaccine_code_coding_display,
             FieldNames.manufacturer_display,
             FieldNames.lot_number,
             FieldNames.expiration_date,
-            # FieldNames.site_coding_code,
-            # FieldNames.site_coding_display,
-            # FieldNames.route_coding_code,
-            # FieldNames.route_coding_display,
             FieldNames.dose_quantity_value,
             FieldNames.dose_quantity_code,
             FieldNames.dose_quantity_unit,
@@ -93,8 +97,8 @@ def validate_field(
         field_value = obtain_field_value(self.imms, field_name)
         self.run_field_validation(mandation_functions, validation_set, field_name, field_location, field_value)
 
-    # NOTE: THIS METHOD IS COMMENTED OUT AS IT IS for A REQUIRED ELEMENT (VALIDATION SHOULD ALWAYS PASS),
-    # AND THE MEANS TO ACCESS THE VALUE HAS NOT BEEN CONFIRMED. DO NOT DELETE THE METHOD, IT MAY NEED REINSTATED LATER.
+    # Note: this method is commented out as it is for a required element (validation should always pass),
+    # and the means to access the value has not been confirmed. Do not delete the method, it may need reinstating later.
     # def validate_reason_code_coding_code(self, mandation_functions: MandationFunctions, validation_set: dict):
     #     """
     #     Runs standard validation for each instance of reason_code_coding_code (note that, because reason_code
@@ -142,8 +146,9 @@ def validate(self):
 
         # Validate reason_code_coding_code fields. Note that there may be multiple of each of these
         # - all instances of the field will be validated by the validate_reason_code_coding_field validator
-        # NOTE: THIS METHOD IS COMMENTED OUT AS IT IS for A REQUIRED ELEMENT (VALIDATION SHOULD ALWAYS PASS), AND THE
-        # MEANS TO ACCESS THE VALUE HAS NOT BEEN CONFIRMED. DO NOT DELETE THE METHOD, IT MAY NEED REINSTATED LATER.
+
+        # Note: this method is commented out as it is for a required element (validation should always pass), and the
+        # means to access the value has not been confirmed. Do not delete the method, it may need reinstating later.
         # self.validate_reason_code_coding_code(mandation_functions, validation_set)
 
         # Raise any errors
diff --git a/lambdas/shared/src/common/models/field_names.py b/lambdas/shared/src/common/models/field_names.py
@@ -7,6 +7,19 @@
 class FieldNames:
     """Stores the field name strings for fields of note within the FHIR Immunization Resource JSON data"""
 
+    # Note: some field names are commented out as they are required elements (validation should always pass), and the
+    # means to access the value has not been confirmed. Do not delete the field names, they may need reinstating later.
+
+    # These are the field names that we may require to reinstate in the future:
+    #   vaccination_procedure_display
+    #   vaccine_code_coding_code
+    #   vaccine_code_coding_display
+    #   site_coding_code
+    #   site_coding_display
+    #   route_coding_code
+    #   route_coding_display
+    #   reason_code_coding_code
+
     target_disease = "target_disease"
     target_disease_codes = "target_disease_codes"
     patient_identifier_value = "patient_identifier_value"
@@ -25,20 +38,12 @@ class FieldNames:
     recorded = "recorded"
     primary_source = "primary_source"
     vaccination_procedure_code = "vaccination_procedure_code"
-    # vaccination_procedure_display = "vaccination_procedure_display"
     dose_number_positive_int = "dose_number_positive_int"
-    vaccine_code_coding_code = "vaccine_code_coding_code"
-    vaccine_code_coding_display = "vaccine_code_coding_display"
     manufacturer_display = "manufacturer_display"
     lot_number = "lot_number"
     expiration_date = "expiration_date"
-    site_coding_code = "site_coding_code"
-    site_coding_display = "site_coding_display"
-    route_coding_code = "route_coding_code"
-    route_coding_display = "route_coding_display"
     dose_quantity_value = "dose_quantity_value"
     dose_quantity_code = "dose_quantity_code"
     dose_quantity_unit = "dose_quantity_unit"
-    reason_code_coding_code = "reason_code_coding_code"
     location_identifier_value = "location_identifier_value"
     location_identifier_system = "location_identifier_system"
diff --git a/lambdas/shared/src/common/models/obtain_field_value.py b/lambdas/shared/src/common/models/obtain_field_value.py
@@ -136,30 +136,11 @@ def vaccination_procedure_code(imms: dict):
         """Obtains vaccination_procedure_code value"""
         return get_generic_extension_value(imms, Urls.VACCINATION_PROCEDURE, Urls.SNOMED, "code")
 
-    # @staticmethod
-    # def vaccination_procedure_display(imms: dict):
-    #     """Obtains vaccination_procedure_display value"""
-    #     return get_generic_extension_value(imms, Urls.vaccination_procedure, Urls.snomed, "display")
-
     @staticmethod
     def dose_number_positive_int(imms: dict):
         """Obtains dose_number_positive_int value"""
         return imms["protocolApplied"][0]["doseNumberPositiveInt"]
 
-    # NOTE: THIS METHOD IS COMMENTED OUT AS IT IS for A REQUIRED ELEMENT (VALIDATION SHOULD ALWAYS PASS),
-    # AND THE MEANS TO ACCESS THE VALUE HAS NOT BEEN CONFIRMED. DO NOT DELETE THE METHOD, IT MAY NEED REINSTATED LATER.
-    # @staticmethod
-    # def vaccine_code_coding_code(imms: dict):
-    #     """Obtains vaccine_code_coding_code value"""
-    #     return [x for x in imms["vaccineCode"]["coding"] if x.get("system") == Urls.snomed][0]["code"]
-
-    # NOTE: THIS METHOD IS COMMENTED OUT AS IT IS for A REQUIRED ELEMENT (VALIDATION SHOULD ALWAYS PASS),
-    # AND THE MEANS TO ACCESS THE VALUE HAS NOT BEEN CONFIRMED. DO NOT DELETE THE METHOD, IT MAY NEED REINSTATED LATER.
-    # @staticmethod
-    # def vaccine_code_coding_display(imms: dict):
-    #     """Obtains vaccine_code_coding_display value"""
-    #     return [x for x in imms["vaccineCode"]["coding"] if x.get("system") == Urls.snomed][0]["display"]
-
     @staticmethod
     def manufacturer_display(imms: dict):
         """Obtains manufacturer_display value"""
@@ -175,34 +156,6 @@ def expiration_date(imms: dict):
         """Obtains expiration_date value"""
         return imms["expirationDate"]
 
-    # NOTE: THIS METHOD IS COMMENTED OUT AS IT IS for A REQUIRED ELEMENT (VALIDATION SHOULD ALWAYS PASS),
-    # AND THE MEANS TO ACCESS THE VALUE HAS NOT BEEN CONFIRMED. DO NOT DELETE THE METHOD, IT MAY NEED REINSTATED LATER.
-    # @staticmethod
-    # def site_coding_code(imms: dict):
-    #     """Obtains site_coding_code value"""
-    #     return [x for x in imms["site"]["coding"] if x.get("system") == Urls.snomed][0]["code"]
-
-    # NOTE: THIS METHOD IS COMMENTED OUT AS IT IS for A REQUIRED ELEMENT (VALIDATION SHOULD ALWAYS PASS),
-    # AND THE MEANS TO ACCESS THE VALUE HAS NOT BEEN CONFIRMED. DO NOT DELETE THE METHOD, IT MAY NEED REINSTATED LATER.
-    # @staticmethod
-    # def site_coding_display(imms: dict):
-    #     """Obtains site_coding_display value"""
-    #     return [x for x in imms["site"]["coding"] if x.get("system") == Urls.snomed][0]["display"]
-
-    # NOTE: THIS METHOD IS COMMENTED OUT AS IT IS for A REQUIRED ELEMENT (VALIDATION SHOULD ALWAYS PASS),
-    # AND THE MEANS TO ACCESS THE VALUE HAS NOT BEEN CONFIRMED. DO NOT DELETE THE METHOD, IT MAY NEED REINSTATED LATER.
-    # @staticmethod
-    # def route_coding_code(imms: dict):
-    #     """Obtains route_coding_code value"""
-    #     return [x for x in imms["route"]["coding"] if x.get("system") == Urls.snomed][0]["code"]
-
-    # NOTE: THIS METHOD IS COMMENTED OUT AS IT IS for A REQUIRED ELEMENT (VALIDATION SHOULD ALWAYS PASS),
-    # AND THE MEANS TO ACCESS THE VALUE HAS NOT BEEN CONFIRMED. DO NOT DELETE THE METHOD, IT MAY NEED REINSTATED LATER.
-    # @staticmethod
-    # def route_coding_display(imms: dict):
-    #     """Obtains route_coding_display value"""
-    #     return [x for x in imms["route"]["coding"] if x.get("system") == Urls.snomed][0]["display"]
-
     @staticmethod
     def dose_quantity_value(imms: dict):
         """Obtains dose_quantity_value value"""
@@ -233,8 +186,43 @@ def location_identifier_system(imms: dict):
         """Obtains location_identifier_system value"""
         return imms["location"]["identifier"]["system"]
 
-    # NOTE: THIS METHOD IS COMMENTED OUT AS IT IS for A REQUIRED ELEMENT (VALIDATION SHOULD ALWAYS PASS),
-    # AND THE MEANS TO ACCESS THE VALUE HAS NOT BEEN CONFIRMED. DO NOT DELETE THE METHOD, IT MAY NEED REINSTATED LATER.
+    # Note: these methods are commented out as they are for required elements (validation should always pass),
+    # and the means to access the values have not been confirmed. Do not delete the methods, they may need reinstating later.
+    # @staticmethod
+    # def vaccination_procedure_display(imms: dict):
+    #     """Obtains vaccination_procedure_display value"""
+    #     return get_generic_extension_value(imms, Urls.vaccination_procedure, Urls.snomed, "display")
+    #
+    # @staticmethod
+    # def vaccine_code_coding_code(imms: dict):
+    #     """Obtains vaccine_code_coding_code value"""
+    #     return [x for x in imms["vaccineCode"]["coding"] if x.get("system") == Urls.snomed][0]["code"]
+    #
+    # @staticmethod
+    # def vaccine_code_coding_display(imms: dict):
+    #     """Obtains vaccine_code_coding_display value"""
+    #     return [x for x in imms["vaccineCode"]["coding"] if x.get("system") == Urls.snomed][0]["display"]
+    #
+    # @staticmethod
+    # def site_coding_code(imms: dict):
+    #     """Obtains site_coding_code value"""
+    #     return [x for x in imms["site"]["coding"] if x.get("system") == Urls.snomed][0]["code"]
+    #
+    # @staticmethod
+    # def site_coding_display(imms: dict):
+    #     """Obtains site_coding_display value"""
+    #     return [x for x in imms["site"]["coding"] if x.get("system") == Urls.snomed][0]["display"]
+    #
+    # @staticmethod
+    # def route_coding_code(imms: dict):
+    #     """Obtains route_coding_code value"""
+    #     return [x for x in imms["route"]["coding"] if x.get("system") == Urls.snomed][0]["code"]
+    #
+    # @staticmethod
+    # def route_coding_display(imms: dict):
+    #     """Obtains route_coding_display value"""
+    #     return [x for x in imms["route"]["coding"] if x.get("system") == Urls.snomed][0]["display"]
+    #
     # @staticmethod
     # def reason_code_coding_code(imms: dict, index: int):
     #     """Obtains reason_code_coding_code value"""
diff --git a/lambdas/shared/tests/test_common/test_immunization_post_validator.py b/lambdas/shared/tests/test_common/test_immunization_post_validator.py
@@ -447,20 +447,6 @@ def test_post_dose_number_positive_int(self):
             valid_json_data["protocolApplied"][0]["doseNumberString"] = "Dose sequence not recorded"
             MandationTests.test_missing_field_accepted(self, dose_number_positive_int_field_location, valid_json_data)
 
-    # NOTE: THIS TEST IS COMMENTED OUT AS IT IS TESTING A REQUIRED ELEMENT (VALIDATION SHOULD ALWAYS PASS),
-    # AND THE MEANS TO ACCESS THE VALUE HAS NOT BEEN CONFIRMED. DO NOT DELETE THE TEST, IT MAY NEED REINSTATED LATER.
-    # def test_post_vaccine_code_coding_code(self):
-    #     """Test that the JSON data is rejected when vaccine_code_coding_code is absent"""
-    #     field_location = "vaccineCode.coding[?(@.system=='http://snomed.info/sct')].code"
-    #     MandationTests.test_missing_field_accepted(self, field_location)
-
-    # NOTE: THIS TEST IS COMMENTED OUT AS IT IS TESTING A REQUIRED ELEMENT (VALIDATION SHOULD ALWAYS PASS),
-    # AND THE MEANS TO ACCESS THE VALUE HAS NOT BEEN CONFIRMED. DO NOT DELETE THE TEST, IT MAY NEED REINSTATED LATER.
-    # def test_post_vaccine_code_coding_display(self):
-    #     """Test that the JSON data is accepted when vaccine_code_coding_display is absent"""
-    #     field_location = "vaccineCode.coding[?(@.system=='http://snomed.info/sct')].display"
-    #     MandationTests.test_missing_field_accepted(self, field_location)
-
     def test_post_manufacturer_display(self):
         """
         Test that present or absent manufacturer_display is accepted or rejected
@@ -504,35 +490,6 @@ def test_post_expiration_date(self):
         for vaccine_type in self.all_vaccine_types:
             MandationTests.test_missing_field_accepted(self, field_location, self.completed_json_data[vaccine_type])
 
-    # NOTE: THIS TEST IS COMMENTED OUT AS IT IS TESTING A REQUIRED ELEMENT (VALIDATION SHOULD ALWAYS PASS),
-    # AND THE MEANS TO ACCESS THE VALUE HAS NOT BEEN CONFIRMED. DO NOT DELETE THE TEST, IT MAY NEED REINSTATED LATER.
-    # def test_post_site_coding_code(self):
-    #     """Test that the JSON data is accepted when site_coding_code is absent"""
-    #     MandationTests.test_missing_field_accepted(self, "site.coding[?(@.system=='http://snomed.info/sct')].code")
-
-    # NOTE: THIS TEST IS COMMENTED OUT AS IT IS TESTING A REQUIRED ELEMENT (VALIDATION SHOULD ALWAYS PASS),
-    # AND THE MEANS TO ACCESS THE VALUE HAS NOT BEEN CONFIRMED. DO NOT DELETE THE TEST, IT MAY NEED REINSTATED LATER.
-    # def test_post_site_coding_display(self):
-    #     """Test that the JSON data is accepted when site_coding_display is absent"""
-    #     MandationTests.test_missing_field_accepted(self, "site.coding[?(@.system=='http://snomed.info/sct')].display")
-
-    # NOTE: THIS TEST IS COMMENTED OUT AS IT IS TESTING A REQUIRED ELEMENT (VALIDATION SHOULD ALWAYS PASS),
-    # AND THE MEANS TO ACCESS THE VALUE HAS NOT BEEN CONFIRMED. DO NOT DELETE THE TEST, IT MAY NEED REINSTATED LATER.
-    # def test_post_route_coding_code(self):
-    #     """
-    #     Test that present or absent route_coding_code is accepted or rejected
-    #     as appropriate dependent on other fields
-    #     """
-    #     field_location = "route.coding[?(@.system=='http://snomed.info/sct')].code"
-    #     for vaccine_type in self.all_vaccine_types:
-    #         MandationTests.test_missing_field_accepted(self, field_location, self.completed_json_data[vaccine_type])
-
-    # NOTE: THIS TEST IS COMMENTED OUT AS IT IS TESTING A REQUIRED ELEMENT (VALIDATION SHOULD ALWAYS PASS),
-    # AND THE MEANS TO ACCESS THE VALUE HAS NOT BEEN CONFIRMED. DO NOT DELETE THE TEST, IT MAY NEED REINSTATED LATER.
-    # def test_post_route_coding_display(self):
-    #     """Test that the JSON data is accepted when route_coding_display is absent"""
-    #     MandationTests.test_missing_field_accepted(self, "route.coding[?(@.system=='http://snomed.info/sct')].display")
-
     def test_post_dose_quantity_value(self):
         """
         Test that present or absent dose_quantity_value is accepted or rejected as appropriate dependent on other fields
@@ -572,13 +529,6 @@ def test_post_dose_quantity_unit(self):
         self.mock_redis_getter.return_value = self.mock_redis
         MandationTests.test_missing_field_accepted(self, "doseQuantity.unit")
 
-    # NOTE: THIS TEST IS COMMENTED OUT AS IT IS TESTING A REQUIRED ELEMENT (VALIDATION SHOULD ALWAYS PASS),
-    # AND THE MEANS TO ACCESS THE VALUE HAS NOT BEEN CONFIRMED. DO NOT DELETE THE TEST, IT MAY NEED REINSTATED LATER.
-    # def test_post_reason_code_coding_code(self):
-    #     """Test that the JSON data is accepted when reason_code_coding_code is absent"""
-    #     for index in range(len(self.completed_json_data["COVID"]["reasonCode"])):
-    #         MandationTests.test_missing_field_accepted(self, f"reasonCode[{index}].coding[0].code")
-
     def test_post_organization_identifier_system(self):
         """Test that the JSON data is rejected if it does not contain organization_identifier_system"""
         self.mock_redis.hget.side_effect = None
@@ -703,3 +653,41 @@ def test_post_no_snomed_code(self):
 
         actual_error_message = str(cm.exception)
         self.assertIn(expected_error_message, actual_error_message)
+
+    # Note: these tests are commented out as they are testing required elements (validation should always pass),
+    # and the means to access the values have not been confirmed. Do not delete the tests, they may need reinstating later.
+    # def test_post_vaccine_code_coding_code(self):
+    #     """Test that the JSON data is rejected when vaccine_code_coding_code is absent"""
+    #     field_location = "vaccineCode.coding[?(@.system=='http://snomed.info/sct')].code"
+    #     MandationTests.test_missing_field_accepted(self, field_location)
+    #
+    # def test_post_vaccine_code_coding_display(self):
+    #     """Test that the JSON data is accepted when vaccine_code_coding_display is absent"""
+    #     field_location = "vaccineCode.coding[?(@.system=='http://snomed.info/sct')].display"
+    #     MandationTests.test_missing_field_accepted(self, field_location)
+    #
+    # def test_post_site_coding_code(self):
+    #     """Test that the JSON data is accepted when site_coding_code is absent"""
+    #     MandationTests.test_missing_field_accepted(self, "site.coding[?(@.system=='http://snomed.info/sct')].code")
+    #
+    # def test_post_site_coding_display(self):
+    #     """Test that the JSON data is accepted when site_coding_display is absent"""
+    #     MandationTests.test_missing_field_accepted(self, "site.coding[?(@.system=='http://snomed.info/sct')].display")
+    #
+    # def test_post_route_coding_code(self):
+    #     """
+    #     Test that present or absent route_coding_code is accepted or rejected
+    #     as appropriate dependent on other fields
+    #     """
+    #     field_location = "route.coding[?(@.system=='http://snomed.info/sct')].code"
+    #     for vaccine_type in self.all_vaccine_types:
+    #         MandationTests.test_missing_field_accepted(self, field_location, self.completed_json_data[vaccine_type])
+    #
+    # def test_post_route_coding_display(self):
+    #     """Test that the JSON data is accepted when route_coding_display is absent"""
+    #     MandationTests.test_missing_field_accepted(self, "route.coding[?(@.system=='http://snomed.info/sct')].display")
+    #
+    # def test_post_reason_code_coding_code(self):
+    #     """Test that the JSON data is accepted when reason_code_coding_code is absent"""
+    #     for index in range(len(self.completed_json_data["COVID"]["reasonCode"])):
+    #         MandationTests.test_missing_field_accepted(self, f"reasonCode[{index}].coding[0].code")
diff --git a/sandbox/Dockerfile b/sandbox/Dockerfile
@@ -1,5 +1,5 @@
 # First Stage
-FROM alpine:latest
+FROM alpine:3.23.3
 
 # Create a non-root user
 RUN addgroup -S appgroup && adduser -S appuser -G appgroup && apk add --no-cache jq
@@ -17,7 +17,7 @@ COPY ./specification ./specification
 RUN jq ".paths += $(cat HealthStatusEndpoint.json)" immunisation-fhir-api.json > updated-spec.json
 
 # Second Stage
-FROM stoplight/prism:latest
+FROM stoplight/prism:5
 
 # Create a non-root user in the Prism container
 USER root
