Add response_id and meta to EligibilityResponse.

Author: acerathereinspirative-nhs-nvir

src/eligibility_signposting_api/views/eligibility.py

@@ -1,4 +1,6 @@
 import logging
+import uuid
+from datetime import UTC, datetime
 from http import HTTPStatus
 
 from fhir.resources.R4B.operationoutcome import OperationOutcome, OperationOutcomeIssue
@@ -11,6 +13,8 @@
 from eligibility_signposting_api.views.response_models import (
     ConditionName,
     EligibilityResponse,
+    LastUpdated,
+    Meta,
     ProcessedSuggestion,
     StatusText,
 )
@@ -52,6 +56,8 @@ def check_eligibility(nhs_number: NHSNumber, eligibility_service: Injected[Eligi
 
 def build_eligibility_response(eligibility_status: EligibilityStatus) -> EligibilityResponse:
     return EligibilityResponse(  # pyright: ignore[reportCallIssue]
+        response_id=uuid.uuid4(),  # pyright: ignore[reportCallIssue]
+        meta=Meta(last_updated=LastUpdated(datetime.now(tz=UTC))),  # pyright: ignore[reportCallIssue]
         processed_suggestions=[  # pyright: ignore[reportCallIssue]
             ProcessedSuggestion(  # pyright: ignore[reportCallIssue]
                 condition_name=ConditionName(condition.condition_name),  # pyright: ignore[reportCallIssue]
@@ -62,5 +68,5 @@ def build_eligibility_response(eligibility_status: EligibilityStatus) -> Eligibi
                 actions=[],
             )
             for condition in eligibility_status.conditions
-        ]
+        ],
     )

src/eligibility_signposting_api/views/response_models.py

@@ -1,8 +1,10 @@
+from datetime import datetime
 from enum import Enum
 from typing import NewType
 
-from pydantic import BaseModel, Field, HttpUrl
+from pydantic import UUID4, BaseModel, Field, HttpUrl, SerializationInfo, field_serializer
 
+LastUpdated = NewType("LastUpdated", datetime)
 ConditionName = NewType("ConditionName", str)
 StatusText = NewType("StatusText", str)
 ActionType = NewType("ActionType", str)
@@ -62,7 +64,19 @@ class ProcessedSuggestion(BaseModel):
     model_config = {"populate_by_name": True}
 
 
+class Meta(BaseModel):
+    last_updated: LastUpdated = Field(..., alias="lastUpdated")
+
+    model_config = {"populate_by_name": True}
+
+    @field_serializer("last_updated")
+    def serialize_last_updated(self, last_updated: LastUpdated, _info: SerializationInfo) -> str:
+        return last_updated.isoformat()
+
+
 class EligibilityResponse(BaseModel):
+    response_id: UUID4 = Field(..., alias="responseId")
+    meta: Meta
     processed_suggestions: list[ProcessedSuggestion] = Field(..., alias="processedSuggestions")
 
     model_config = {"populate_by_name": True}