add gp identifier

Author: motola

infrastructure/instance/modules/mns_publisher/mns_publisher_lambda.tf

@@ -191,9 +191,9 @@ resource "aws_lambda_function" "mns_publisher_lambda" {
 
   environment {
     variables = {
-      SPLUNK_FIREHOSE_NAME     = var.splunk_firehose_stream_name
-      "IMMUNIZATION_ENV"       = var.resource_scope,
-      "IMMUNIZATION_BASE_PATH" = var.sub_environment
+      SPLUNK_FIREHOSE_NAME   = var.splunk_firehose_stream_name
+      IMMUNIZATION_ENV       = var.resource_scope,
+      IMMUNIZATION_BASE_PATH = var.sub_environment
     }
   }
 

lambdas/id_sync/src/id_sync.py

@@ -1,16 +1,16 @@
 """
 - Parses the incoming AWS event into `AwsLambdaEvent` and iterate its `records`.
 - Delegate each record to `process_record` and collect `nhs_number` from each result.
-- If any record has status == "error" raise `PdsSyncException` with aggregated nhs_numbers.
-- Any unexpected error is wrapped into `PdsSyncException(message="Error processing id_sync event")`.
+- If any record has status == "error" raise `IdSyncException` with aggregated nhs_numbers.
+- Any unexpected error is wrapped into `IdSyncException(message="Error processing id_sync event")`.
 """
 
 from typing import Any, Dict
 
-from common.api_clients.errors import PdsSyncException
 from common.aws_lambda_event import AwsLambdaEvent
 from common.clients import STREAM_NAME, logger
 from common.log_decorator import logging_decorator
+from exceptions.id_sync_exception import IdSyncException
 from record_processor import process_record
 
 
@@ -34,7 +34,7 @@ def handler(event_data: Dict[str, Any], _context) -> Dict[str, Any]:
                 error_count += 1
 
         if error_count > 0:
-            raise PdsSyncException(
+            raise IdSyncException(
                 message=f"Processed {len(records)} records with {error_count} errors",
             )
 
@@ -43,10 +43,10 @@ def handler(event_data: Dict[str, Any], _context) -> Dict[str, Any]:
         logger.info("id_sync handler completed: %s", response)
         return response
 
-    except PdsSyncException as e:
+    except IdSyncException as e:
         logger.exception(f"id_sync error: {e.message}")
         raise
     except Exception:
         msg = "Error processing id_sync event"
         logger.exception(msg)
-        raise PdsSyncException(message=msg)
+        raise IdSyncException(message=msg)

lambdas/id_sync/tests/test_id_sync.py

@@ -3,7 +3,7 @@
 
 with patch("common.log_decorator.logging_decorator") as mock_decorator:
     mock_decorator.return_value = lambda f: f  # Pass-through decorator
-    from common.api_clients.errors import PdsSyncException
+    from exceptions.id_sync_exception import IdSyncException
     from id_sync import handler
 
 
@@ -93,7 +93,7 @@ def test_handler_error_single_record(self):
         }
 
         # Call handler
-        with self.assertRaises(PdsSyncException) as exception_context:
+        with self.assertRaises(IdSyncException) as exception_context:
             handler(self.single_sqs_event, None)
 
         exception = exception_context.exception
@@ -117,7 +117,7 @@ def test_handler_mixed_success_error(self):
         ]
 
         # Call handler
-        with self.assertRaises(PdsSyncException) as exception_context:
+        with self.assertRaises(IdSyncException) as exception_context:
             handler(self.multi_sqs_event, None)
 
         error = exception_context.exception
@@ -139,7 +139,7 @@ def test_handler_all_records_fail(self):
         ]
 
         # Call handler
-        with self.assertRaises(PdsSyncException) as exception_context:
+        with self.assertRaises(IdSyncException) as exception_context:
             handler(self.multi_sqs_event, None)
         exception = exception_context.exception
         # Assertions
@@ -187,7 +187,7 @@ def test_handler_aws_lambda_event_exception(self):
         self.mock_aws_lambda_event.side_effect = Exception("AwsLambdaEvent creation failed")
 
         # Call handler
-        with self.assertRaises(PdsSyncException) as exception_context:
+        with self.assertRaises(IdSyncException) as exception_context:
             handler(self.single_sqs_event, None)
 
         result = exception_context.exception
@@ -208,7 +208,7 @@ def test_handler_process_record_exception(self):
         self.mock_process_record.side_effect = Exception("Process record failed")
 
         # Call handler
-        with self.assertRaises(PdsSyncException) as exception_context:
+        with self.assertRaises(IdSyncException) as exception_context:
             handler(self.single_sqs_event, None)
         exception = exception_context.exception
         # Assertions
@@ -233,12 +233,12 @@ def test_handler_process_record_missing_nhs_number(self):
         }
 
         # Call handler and expect exception
-        with self.assertRaises(PdsSyncException) as exception_context:
+        with self.assertRaises(IdSyncException) as exception_context:
             handler(self.single_sqs_event, None)
 
         exception = exception_context.exception
 
-        self.assertIsInstance(exception, PdsSyncException)
+        self.assertIsInstance(exception, IdSyncException)
         self.assertEqual(exception.message, "Processed 1 records with 1 errors")
         self.mock_logger.exception.assert_called_once_with(f"id_sync error: {exception.message}")
 
@@ -275,7 +275,7 @@ def test_handler_error_count_tracking(self):
         ]
 
         # Call handler
-        with self.assertRaises(PdsSyncException) as exception_context:
+        with self.assertRaises(IdSyncException) as exception_context:
             handler(self.multi_sqs_event, None)
         exception = exception_context.exception
         # Assertions - should track 2 errors out of 4 records

lambdas/mns_publisher/src/constants.py

@@ -2,7 +2,7 @@
 
 # Static constants for the MNS notification creation process
 SPEC_VERSION = "1.0"
-IMMUNISATION_TYPE = "imms-vaccinations-2"
+IMMUNISATION_TYPE = "imms-vaccinations-1"
 
 
 # Fields from the incoming SQS message that forms part of the base schema and filtering attributes for MNS notifications

lambdas/mns_publisher/src/create_notification.py

@@ -75,11 +75,26 @@ def get_practitioner_details_from_pds(nhs_number: str) -> str | None:
             return None
 
         patient_gp = general_practitioners[0]
-        gp_ods_code = patient_gp.get("identifier", {}).get("value")
+        patient_gp_identifier = patient_gp.get("identifier", {})
+
+        gp_ods_code = patient_gp_identifier.get("value")
         if not gp_ods_code:
             logger.warning("GP ODS code not found in practitioner details")
             return None
 
+        # Check if registration is current
+        period = patient_gp_identifier.get("period", {})
+        gp_period_end_date = period.get("end", None)
+
+        if gp_period_end_date:
+            # Parse end date (format: YYYY-MM-DD)
+            end_date = datetime.strptime(gp_period_end_date, "%Y-%m-%d").date()
+            today = datetime.now().date()
+
+            if end_date < today:
+                logger.warning("GP registration has ended")
+                return None
+
         return gp_ods_code
     except Exception as error:
         logger.exception("Failed to get practitioner details from pds", error)

lambdas/mns_publisher/tests/test_create_notification.py

@@ -86,7 +86,7 @@ class TestGetPractitionerDetailsFromPds(unittest.TestCase):
     @patch("create_notification.logger")
     def test_get_practitioner_success(self, mock_logger, mock_pds_get):
         """Test successful retrieval of GP ODS code."""
-        mock_pds_get.return_value = {"generalPractitioner": {"value": "Y12345"}}
+        mock_pds_get.return_value = {"generalPractitioner": [{"identifier": {"value": "Y12345"}}]}
 
         result = get_practitioner_details_from_pds("9481152782")
 
@@ -103,7 +103,7 @@ def test_get_practitioner_no_gp_details(self, mock_logger, mock_pds_get):
         result = get_practitioner_details_from_pds("9481152782")
 
         self.assertIsNone(result)
-        mock_logger.warning.assert_called_once_with("No patient details found for NHS number")
+        mock_logger.warning.assert_called_once_with("No GP details found for patient")
 
     @patch("create_notification.pds_get_patient_details")
     @patch("create_notification.logger")
@@ -120,7 +120,7 @@ def test_get_practitioner_gp_is_none(self, mock_logger, mock_pds_get):
     @patch("create_notification.logger")
     def test_get_practitioner_no_value_field(self, mock_logger, mock_pds_get):
         """Test when value field is missing from generalPractitioner."""
-        mock_pds_get.return_value = {"generalPractitioner": {"system": "https://fhir.nhs.uk"}}
+        mock_pds_get.return_value = {"generalPractitioner": [{"identifier": {}}]}
 
         result = get_practitioner_details_from_pds("9481152782")
 
@@ -131,7 +131,7 @@ def test_get_practitioner_no_value_field(self, mock_logger, mock_pds_get):
     @patch("create_notification.logger")
     def test_get_practitioner_empty_value(self, mock_logger, mock_pds_get):
         """Test when value is empty string."""
-        mock_pds_get.return_value = {"generalPractitioner": {"value": ""}}
+        mock_pds_get.return_value = {"generalPractitioner": [{"identifier": {"value": ""}}]}
 
         result = get_practitioner_details_from_pds("9481152782")
 
@@ -342,5 +342,85 @@ def test_create_mns_notification_with_update_action(self, mock_get_service_url,
     mock_get_gp.assert_called()
 
 
+@patch("create_notification.pds_get_patient_details")
+@patch("create_notification.logger")
+def test_get_practitioner_success_no_end_date(self, mock_logger, mock_pds_get):
+    """Test successful retrieval when no end date (current registration)."""
+    mock_pds_get.return_value = {
+        "generalPractitioner": [{"identifier": {"value": "Y12345", "period": {"start": "2024-01-01"}}}]
+    }
+
+    result = get_practitioner_details_from_pds("9481152782")
+
+    self.assertEqual(result, "Y12345")
+    mock_logger.warning.assert_not_called()
+
+
+@patch("create_notification.pds_get_patient_details")
+@patch("create_notification.logger")
+def test_get_practitioner_success_future_end_date(self, mock_logger, mock_pds_get):
+    """Test successful retrieval when end date is in the future."""
+    mock_pds_get.return_value = {
+        "generalPractitioner": [
+            {"identifier": {"value": "Y12345", "period": {"start": "2024-01-01", "end": "2030-12-31"}}}
+        ]
+    }
+
+    result = get_practitioner_details_from_pds("9481152782")
+
+    self.assertEqual(result, "Y12345")
+    mock_logger.warning.assert_not_called()
+
+
+@patch("create_notification.pds_get_patient_details")
+@patch("create_notification.logger")
+def test_get_practitioner_expired_registration(self, mock_logger, mock_pds_get):
+    """Test when GP registration has ended (expired)."""
+    mock_pds_get.return_value = {
+        "generalPractitioner": [
+            {"identifier": {"value": "Y12345", "period": {"start": "2020-01-01", "end": "2023-12-31"}}}
+        ]
+    }
+
+    result = get_practitioner_details_from_pds("9481152782")
+
+    self.assertIsNone(result)
+    mock_logger.warning.assert_called_with(
+        "GP registration has ended",
+        extra={"nhs_number": "9481152782", "gp_ods_code": "Y12345", "end_date": "2023-12-31"},
+    )
+
+
+@patch("create_notification.pds_get_patient_details")
+@patch("create_notification.logger")
+def test_get_practitioner_invalid_end_date_format(self, mock_logger, mock_pds_get):
+    """Test when end date has invalid format - should still return GP."""
+    mock_pds_get.return_value = {
+        "generalPractitioner": [
+            {"identifier": {"value": "Y12345", "period": {"start": "2024-01-01", "end": "invalid-date"}}}
+        ]
+    }
+
+    result = get_practitioner_details_from_pds("9481152782")
+
+    # Should still return GP even with invalid date
+    self.assertEqual(result, "Y12345")
+    mock_logger.warning.assert_called_with(
+        "Invalid end date format in GP registration", extra={"nhs_number": "9481152782", "end_date": "invalid-date"}
+    )
+
+
+@patch("create_notification.pds_get_patient_details")
+@patch("create_notification.logger")
+def test_get_practitioner_no_period_field(self, mock_logger, mock_pds_get):
+    """Test when period field is missing entirely."""
+    mock_pds_get.return_value = {"generalPractitioner": [{"identifier": {"value": "Y12345"}}]}
+
+    result = get_practitioner_details_from_pds("9481152782")
+
+    self.assertEqual(result, "Y12345")
+    mock_logger.warning.assert_not_called()
+
+
 if __name__ == "__main__":
     unittest.main()