recorded date

Author: Akol125

backend/src/models/fhir_immunization_pre_validators.py

@@ -519,7 +519,7 @@ def pre_validate_recorded(self, values: dict) -> dict:
         """
         try:
             recorded = values["recorded"]
-            PreValidation.for_date_time(recorded, "recorded")
+            PreValidation.for_recorded_date_time(recorded, "recorded")
         except KeyError:
             pass
 

backend/src/models/utils/pre_validator_utils.py

@@ -96,9 +96,18 @@ def for_date(field_value: str, field_location: str):
             raise ValueError(
                 f'{field_location} must be a valid date string in the format "YYYY-MM-DD"'
             ) from value_error
+    
+    @staticmethod
+    def for_recorded_date_time(field_value: str, field_location: str):
+        """
+        Relaxed validator for the 'recorded' field.
+        Accepts any timezone or no timezone.
+        """
+        return PreValidation.for_date_time(field_value, field_location, strict_timezone=False)
+
 
     @staticmethod
-    def for_date_time(field_value: str, field_location: str):
+    def for_date_time(field_value: str, field_location: str, strict_timezone: bool = True):
         """
         Apply pre-validation to a datetime field to ensure that it is a string (JSON dates must be written as strings)
         containing a valid datetime. Note that partial dates are valid for FHIR, but are not allowed for this API.
@@ -120,9 +129,11 @@ def for_date_time(field_value: str, field_location: str):
             "- 'YYYY-MM-DDThh:mm:ss.f' — Full date and time with milliseconds (any level of precision)"
             "- 'YYYY-MM-DDThh:mm:ss%z' — Full date and time with timezone (e.g. +00:00 or +01:00)"
             "- 'YYYY-MM-DDThh:mm:ss.f%z' — Full date and time with milliseconds and timezone"
-            "Only '+00:00' and '+01:00' are accepted as valid timezone offsets."
-            f"Note that partial dates are not allowed for {field_location} in this service."
         )
+         
+        if strict_timezone:
+            error_message += "Only '+00:00' and '+01:00' are accepted as valid timezone offsets.\n"
+            error_message += f"Note that partial dates are not allowed for {field_location} in this service."
 
         allowed_suffixes = {"+00:00", "+01:00", "+0000", "+0100",}
 
@@ -136,7 +147,7 @@ def for_date_time(field_value: str, field_location: str):
             try:
                 fhir_date = datetime.strptime(field_value, fmt)
 
-                if fhir_date.tzinfo is not None:
+                if strict_timezone and fhir_date.tzinfo is not None:
                    if not any(field_value.endswith(suffix) for suffix in allowed_suffixes):
                        raise ValueError(error_message)
                 return fhir_date.isoformat()

backend/tests/test_immunization_pre_validator.py

@@ -645,7 +645,7 @@ def test_pre_validate_practitioner_name_family(self):
 
     def test_pre_validate_recorded(self):
         """Test pre_validate_recorded accepts valid values and rejects invalid values"""
-        ValidatorModelTests.test_date_time_value(self, field_location="recorded")
+        ValidatorModelTests.test_date_time_value(self, field_location="recorded", is_occurrence_date_time=False)
 
     def test_pre_validate_primary_source(self):
         """Test pre_validate_primary_source accepts valid values and rejects invalid values"""

backend/tests/utils/pre_validation_test_utils.py

@@ -356,12 +356,22 @@ def test_date_time_value(
             "- 'YYYY-MM-DDThh:mm:ss.f' — Full date and time with milliseconds (any level of precision)"
             "- 'YYYY-MM-DDThh:mm:ss%z' — Full date and time with timezone (e.g. +00:00 or +01:00)"
             "- 'YYYY-MM-DDThh:mm:ss.f%z' — Full date and time with milliseconds and timezone"
-            "Only '+00:00' and '+01:00' are accepted as valid timezone offsets."
-            f"Note that partial dates are not allowed for {field_location} in this service."
         )
 
+        if is_occurrence_date_time:
+            expected_error_message += "Only '+00:00' and '+01:00' are accepted as valid timezone offsets.\n"
+            expected_error_message += f"Note that partial dates are not allowed for {field_location} in this service."
+
+        if is_occurrence_date_time:
+            invalid_datetime_formats = InvalidValues.for_date_time_string_formats
+            invalid_datetime_values = InvalidValues.for_date_times
+        else:
+            # For recorded, skip values that are valid ISO with non-restricted timezone
+            invalid_datetime_formats = InvalidValues.for_date_time_string_formats_for_recorded
+            invalid_datetime_values = InvalidValues.for_date_times_for_recorded
+
         # Test invalid date time string formats
-        for invalid_occurrence_date_time in InvalidValues.for_date_time_string_formats:
+        for invalid_occurrence_date_time in invalid_datetime_formats:
             test_invalid_values_rejected(
                 test_instance,
                 valid_json_data,
@@ -371,7 +381,7 @@ def test_date_time_value(
             )
 
         # Test invalid date times
-        for invalid_occurrence_date_time in InvalidValues.for_date_times:
+        for invalid_occurrence_date_time in invalid_datetime_values:
             test_invalid_values_rejected(
                 test_instance,
                 valid_json_data,

backend/tests/utils/values_for_tests.py

@@ -323,6 +323,40 @@ class InvalidValues:
         "2000-01-01T00:00:00+00:60",  # Timezone minute 60
     ]
 
+    for_date_time_string_formats_for_recorded = [
+        "",  # Empty string
+        "invalid",  # Invalid format
+        "20000101",  # Date digits only (i.e. without hypens)
+        "20000101000000",  # Date and time digits only
+        "200001010000000000",  # Date, time and timezone digits only
+        "2000",  # Year only
+        "2000-01",  # Year and month only
+        "2000-01-01T00:00:00+00",  # Date and time with GMT timezone offset only in hours
+        "2000-01-01T00:00:00+01",  # Date and time with BST timezone offset only in hours
+        "12000-01-01T00:00:00+00:00",  # Extra character at start of string
+        "2000-01-01T00:00:00+00:001",  # Extra character at end of string
+        "12000-01-02T00:00:00-01:001",  # Extra characters at start and end of string
+        "2000-01-0122:22:22+00:00",  # Missing T
+        "2000-01-0122:22:22+00:00.000",  # Missing T (with milliseconds)
+        "2000-01-01T222222+00:00",  # Missing time colons
+        "2000-01-01T22:22:2200:00",  # Missing timezone indicator
+        "2000-01-01T22:22:22-01",  # Timezone hours only
+        "99-01-01T00:00:00+00:00",  # Missing century (i.e. only 2 digits for year)
+        "01-01-2000T00:00:00+00:00",  # Date in wrong order (DD-MM-YYYY)
+    ]
+
+    for_date_times_for_recorded = [
+        "2000-00-01T00:00:00+00:00",  # Month 00
+        "2000-13-01T00:00:00+00:00",  # Month 13
+        "2000-01-32T00:00:00+00:00",  # Day 32
+        "2000-02-30T00:00:00+00:00",  # Invalid month and day combination (30th February)
+        "2000-01-01T24:00:00+00:00",  # Hour 24
+        "2000-01-01T00:60:00+00:00",  # Minute 60
+        "2000-01-01T00:00:60+00:00",  # Second 60
+        "2000-01-01T00:00:00+00:60",  # Timezone minute 60
+    ]
+
+
     for_lists_of_strings_of_length_1 = [[1], [False], [["Test1"]]]
 
     for_lists_of_dicts_of_length_1 = [[1], [False], [["Invalid"]], ["Invalid"]]