VED-464 Vaccine Product Code (#717)

* pre-validation snomed check for vaccineCode

* python = ">=3.11"

* poetry env use 3.11

* revert: python = "~3.11"

* python = ">=3.11,<4.0"

* python = ">=3.11,<4.0"

* init: move 'install poetry'

* move 'install poetry' II

* retooled after VED-699

Author: JamesW1-NHS

backend/poetry.lock

@@ -94,6 +94,7 @@ def validate(self):
             self.pre_validate_value_codeable_concept,
             self.pre_validate_extension_length,
             self.pre_validate_vaccination_procedure_code,
+            self.pre_validate_vaccine_code,
         ]
 
         for method in validation_methods:
@@ -903,3 +904,21 @@ def pre_validate_location_identifier_system(self, values: dict) -> dict:
             PreValidation.for_string(field_value, "location.identifier.system")
         except KeyError:
             pass
+
+    def pre_validate_vaccine_code(self, values: dict) -> dict:
+        """
+        Pre-validate that, if vaccineCode.coding[?(@.system=='http://snomed.info/sct')].code
+        (legacy CSV field : VACCINE_PRODUCT_CODE) exists, then it is a valid snomed code
+
+        NOTE: vaccineCode is a mandatory FHIR field. A value of None will be rejected by the
+        FHIR model before pre-validators are run.
+        """
+        url = "http://snomed.info/sct"
+        field_location = f"vaccineCode.coding[?(@.system=='{url}')].code"
+        try:
+            field_value = [x for x in values["vaccineCode"]["coding"] if x.get("system") == url][0]["code"]
+            PreValidation.for_string(field_value, field_location)
+            PreValidation.for_snomed_code(field_value, field_location)
+        except (KeyError, IndexError):
+            pass
+

backend/src/models/fhir_immunization_pre_validators.py

@@ -75,6 +75,7 @@ def is_valid_simple_snomed(simple_snomed: str) -> bool:
     return (
         simple_snomed is not None
         and simple_snomed.isdigit()
+        and simple_snomed[0] != '0'
         and min_snomed_length <= len(simple_snomed) <= max_snomed_length
         and validate(simple_snomed)
         and (simple_snomed[-3:-1] in ("00", "10"))

backend/src/models/utils/generic_utils.py

@@ -749,7 +749,7 @@ def test_pre_validate_extension_snomed_code(self):
         """Test test_pre_validate_extension_url accepts valid values and rejects invalid values for extension[0].url"""
         # Test case: missing "extension"
         invalid_json_data = deepcopy(self.json_data)
-        test_values = ["12345abc", "12345", "1234567890123456789", "12345671", "1324681000000111"]
+        test_values = ["12345abc", "12345", "1234567890123456789", "12345671", "1324681000000111", "0101291008"]
         for values in test_values:
             invalid_json_data["extension"][0]["valueCodeableConcept"]["coding"][0]["code"] = values
 
@@ -1201,6 +1201,20 @@ def test_pre_validate_location_identifier_system(self):
             valid_strings_to_test=["https://fhir.hl7.org.uk/Id/140565"],
         )
 
+    def test_pre_validate_vaccine_code(self):
+        """Test pre_validate_vaccine_code accepts valid values and rejects invalid values for vaccineCode.coding[0].code"""
+        invalid_json_data = deepcopy(self.json_data)
+        test_values = ["12345abc", "12345", "1234567890123456789", "12345671", "1324681000000111", "0101291008"]
+        for values in test_values:
+            invalid_json_data["vaccineCode"]["coding"][0]["code"] = values
+
+            with self.assertRaises(Exception) as error:
+                self.validator.validate(invalid_json_data)
+
+            full_error_message = str(error.exception)
+            actual_error_messages = full_error_message.replace("Validation errors: ", "").split("; ")
+            self.assertIn("vaccineCode.coding[?(@.system=='http://snomed.info/sct')].code is not a valid snomed code", actual_error_messages)
+
 
 class TestImmunizationModelPreValidationRulesForReduceValidation(unittest.TestCase):
     """Test immunization pre validation rules on the FHIR model using the status="reduce validation" data"""