Self review

Author: dlzhry2nhs

backend/src/controller/fhir_api_exception_handler.py

@@ -28,8 +28,8 @@
 
 _CUSTOM_EXCEPTION_TO_STATUS_MAP: dict[Type[Exception], int] = {
     InconsistentResourceVersion: 400,
-    InconsistentIdentifierError: 400,
-    InconsistentIdError: 400,
+    InconsistentIdentifierError: 400,  # Identifier refers to the local FHIR identifier composed of system and value.
+    InconsistentIdError: 400,  # ID refers to the top-level ID of the FHIR resource.
     InvalidImmunizationId: 400,
     InvalidJsonError: 400,
     InvalidResourceVersion: 400,

backend/src/models/immunization_record_metadata.py

@@ -5,7 +5,7 @@
 
 @dataclass
 class ImmunizationRecordMetadata:
-    """Simple class to hold data for the Immunization Record Metadata"""
+    """Simple data class for the Immunization Record Metadata"""
 
     resource_version: int
     is_deleted: bool

backend/src/models/utils/validation_utils.py

@@ -105,7 +105,7 @@ def validate_identifiers_match(new_immunization: dict, existing_immunization: di
     return None
 
 
-def validate_resource_version_matches(
+def validate_resource_versions_match(
     resource_version_in_request: int, actual_resource_version: int, imms_id: str
 ) -> None:
     """Checks if the resource version in the request and the resource version of the actual Immunization record matches.

backend/src/service/fhir_service.py

@@ -35,7 +35,7 @@
     get_contained_patient,
     get_occurrence_datetime,
 )
-from models.utils.validation_utils import get_vaccine_type, validate_identifiers_match, validate_resource_version_matches
+from models.utils.validation_utils import get_vaccine_type, validate_identifiers_match, validate_resource_versions_match
 from repository.fhir_repository import ImmunizationRepository
 
 logging.basicConfig(level="INFO")
@@ -164,7 +164,7 @@ def update_immunization(self, imms_id: str, immunization: dict, supplier_system:
         validate_identifiers_match(immunization, existing_immunization)
 
         if not existing_resource_meta.is_deleted:
-            validate_resource_version_matches(resource_version, existing_resource_meta.resource_version, imms_id)
+            validate_resource_versions_match(resource_version, existing_resource_meta.resource_version, imms_id)
 
         return self.immunization_repo.update_immunization(imms_id, immunization, existing_resource_meta, supplier_system)
 

backend/tests/models/utils/test_validation_utils.py

@@ -12,7 +12,7 @@
     obtain_name_field_location,
     patient_and_practitioner_value_and_index,
 )
-from models.utils.validation_utils import validate_identifiers_match, validate_resource_version_matches
+from models.utils.validation_utils import validate_identifiers_match, validate_resource_versions_match
 from testing_utils.generic_utils import (
     load_json_data,
 )
@@ -280,12 +280,12 @@ def test_obtain_name_field_location(self):
             result = obtain_name_field_location(imms, resource_type, name_value)
             self.assertEqual(result, expected_location)
 
-    def test_validate_resource_version_matches_passes_when_version_matches(self):
-        """Tests validate_resource_version_matches passes when the resource versions match"""
-        self.assertIsNone(validate_resource_version_matches(3, 3, "12345-id"))
+    def test_validate_resource_versions_match_passes_when_version_matches(self):
+        """Tests validate_resource_versions_match passes when the resource versions match"""
+        self.assertIsNone(validate_resource_versions_match(3, 3, "12345-id"))
 
-    def test_validate_resource_version_matches_raises_error_when_versions_do_not_match(self):
-        """Tests validate_resource_version_matches raises a InconsistentResourceVersion when the versions do not
+    def test_validate_resource_versions_match_raises_error_when_versions_do_not_match(self):
+        """Tests validate_resource_versions_match raises a InconsistentResourceVersion when the versions do not
         match"""
         test_cases = [
             (
@@ -299,7 +299,7 @@ def test_validate_resource_version_matches_raises_error_when_versions_do_not_mat
         for actual_version, expected_error in test_cases:
             with self.subTest(actual_version=actual_version, expected_error=expected_error):
                 with self.assertRaises(InconsistentResourceVersion) as error:
-                    validate_resource_version_matches(3, actual_version, "12345-id")
+                    validate_resource_versions_match(3, actual_version, "12345-id")
 
                 self.assertEqual(str(error.exception), expected_error)