VED-350: Generic Validation Dose Unit Code (#734)

* VED-350: generic validation for require system when code is present

Author: Akol125

backend/src/models/fhir_immunization_pre_validators.py

@@ -85,6 +85,8 @@ def validate(self):
             self.pre_validate_route_coding_display,
             self.pre_validate_dose_quantity_value,
             self.pre_validate_dose_quantity_code,
+            self.pre_validate_dose_quantity_system,
+            self.pre_validate_dose_quantity_system_and_code,
             self.pre_validate_dose_quantity_unit,
             self.pre_validate_reason_code_codings,
             self.pre_validate_reason_code_coding_codes,
@@ -799,9 +801,6 @@ def pre_validate_route_coding_display(self, values: dict) -> dict:
         except (KeyError, IndexError):
             pass
 
-    # TODO: need to validate that doseQuantity.system is "http://unitsofmeasure.org"?
-    # Check with Martin
-
     def pre_validate_dose_quantity_value(self, values: dict) -> dict:
         """
         Pre-validate that, if doseQuantity.value (legacy CSV field name: DOSE_AMOUNT) exists,
@@ -818,6 +817,17 @@ def pre_validate_dose_quantity_value(self, values: dict) -> dict:
         except KeyError:
             pass
 
+    def pre_validate_dose_quantity_system(self, values: dict) -> dict:
+        """
+        Pre-validate that if doseQuantity.system exists then it is a non-empty string:
+        If system exists, it must be a non-empty string.
+        """
+        try:
+            field_value = values["doseQuantity"]["system"]
+            PreValidation.for_string(field_value, "doseQuantity.system")            
+        except KeyError:
+            pass
+    
     def pre_validate_dose_quantity_code(self, values: dict) -> dict:
         """
         Pre-validate that, if doseQuantity.code (legacy CSV field name: DOSE_UNIT_CODE) exists,
@@ -829,6 +839,21 @@ def pre_validate_dose_quantity_code(self, values: dict) -> dict:
         except KeyError:
             pass
 
+    def pre_validate_dose_quantity_system_and_code(self, values: dict) -> dict:
+        """
+        Pre-validate doseQuantity.code and doseQuantity.system:
+        1. If code exists, system MUST also exist (FHIR SimpleQuantity rule).
+        """
+        dose_quantity = values.get("doseQuantity", {})
+        code = dose_quantity.get("code")
+        system = dose_quantity.get("system")
+        
+        PreValidation.require_system_when_code_present(
+            code, system, "doseQuantity.code", "doseQuantity.system"
+            )
+    
+        return values
+
     def pre_validate_dose_quantity_unit(self, values: dict) -> dict:
         """
         Pre-validate that, if doseQuantity.unit (legacy CSV field name: DOSE_UNIT_TERM) exists,

backend/src/models/utils/pre_validator_utils.py

@@ -194,6 +194,19 @@ def for_integer_or_decimal(field_value: Union[int, Decimal], field_location: str
             or type(field_value) is Decimal  # pylint: disable=unidiomatic-typecheck
         ):
             raise TypeError(f"{field_location} must be a number")
+    
+    @staticmethod
+    def require_system_when_code_present(
+        code_value:str, 
+        system_value:str,
+        code_location:str,
+        system_location:str,
+        ) -> None:
+        """
+        If code is present (non-empty), system must also be present (non-empty).
+        """
+        if code_value is not None and system_value is None:
+            raise ValueError(f"If {code_location} is present, {system_location} must also be present")
 
     @staticmethod
     def for_unique_list(

backend/tests/test_immunization_pre_validator.py

@@ -1140,11 +1140,36 @@ def test_pre_validate_dose_quantity_value(self):
                 Decimal("1.123456789"),  # 9 decimal place
             ],
         )
+    def test_pre_validate_dose_quantity_system(self):
+        """Test pre_validate_dose_quantity_system accepts valid values and rejects invalid values"""
 
+        system_location = "doseQuantity.system"
+        ValidatorModelTests.test_string_value(self, system_location, valid_strings_to_test=["http://unitsofmeasure.org"])
+    
     def test_pre_validate_dose_quantity_code(self):
         """Test pre_validate_dose_quantity_code accepts valid values and rejects invalid values"""
-        field_location = "doseQuantity.code"
-        ValidatorModelTests.test_string_value(self, field_location, valid_strings_to_test=["ABC123"])
+
+        code_location = "doseQuantity.code"
+        ValidatorModelTests.test_string_value(self, code_location, valid_strings_to_test=["ABC123"])
+    
+    def test_pre_validate_dose_quantity_system_and_code(self):
+        """Test pre_validate_dose_quantity_system_and_code accepts valid values and rejects invalid values"""
+
+        field_location = "doseQuantity"
+        _test_valid_values_accepted(
+            self,
+            valid_json_data=deepcopy(self.json_data),
+            field_location=field_location,
+            valid_values_to_test=ValidValues.valid_dose_quantity,
+        )
+
+        _test_invalid_values_rejected(
+            self,
+            valid_json_data=deepcopy(self.json_data),
+            field_location=field_location,
+            invalid_value=InvalidValues.invalid_dose_quantity,
+            expected_error_message="If doseQuantity.code is present, doseQuantity.system must also be present"
+        )
 
     def test_pre_validate_dose_quantity_unit(self):
         """Test pre_validate_dose_quantity_unit accepts valid values and rejects invalid values"""

backend/tests/utils/generic_utils.py

@@ -72,7 +72,7 @@ def test_invalid_values_rejected(
     invalid_json_data = parse(field_location).update(valid_json_data, invalid_value)
 
     # Test that correct error type is raised
-    with test_instance.assertRaises(ValueError or TypeError) as error:
+    with test_instance.assertRaises((ValueError, TypeError)) as error:
         test_instance.validator.validate(invalid_json_data)
 
     full_error_message = str(error.exception)

backend/tests/utils/values_for_tests.py

@@ -55,6 +55,13 @@ class ValidValues:
     # Not a valid snomed code, but is valid coding format for format testing
     snomed_coding_element = {"system": "http://snomed.info/sct", "code": "ABC123", "display": "test"}
 
+    valid_dose_quantity = [
+        {"value": 3, "unit": "milliliter", "system": "http://unitsofmeasure.org", "code": "ml"},
+        {"value": 2, "unit": "ml", "system": "http://snomed.info/sct", "code": "258773002"},
+        {"value": 4, "unit": "ml", "system": "http://snomed.info/sct"},
+        {"value": 5, "unit": "ml" }
+    ]
+
     manufacturer_resource_id_Man1 = {"resourceType": "Manufacturer", "id": "Man1"}
 
     practitioner_resource_id_Pract1 = {"resourceType": "Practitioner", "id": "Pract1"}
@@ -377,3 +384,6 @@ class InvalidValues:
         {"use": "official", "given": ["Florence"]},
         {"family": "Nightingale", "given": ""},
     ]
+    
+    invalid_dose_quantity = {"value": 2, "unit": "ml", "code": "258773002"}
+