[PRMP-730] create, post/put/base fhir doc ref services refactoring (#873)

Author: kamenbachvarov-nhs

lambdas/handlers/create_document_reference_handler.py

@@ -3,7 +3,10 @@
 import sys
 
 from enums.feature_flags import FeatureFlags
+from enums.lambda_error import LambdaError
 from enums.logging_app_interaction import LoggingAppInteraction
+from models.document_reference import CreateEventModel
+from pydantic import ValidationError
 from services.create_document_reference_service import CreateDocumentReferenceService
 from services.feature_flags_service import FeatureFlagService
 from utils.audit_logging_setup import LoggingService
@@ -12,12 +15,14 @@
 from utils.decorators.override_error_check import override_error_check
 from utils.decorators.set_audit_arg import set_request_context_for_logging
 from utils.decorators.validate_patient_id import validate_patient_id
-from utils.lambda_response import ApiGatewayResponse
-from utils.request_context import request_context
 from utils.document_reference_common_validations import (
+    normalize_event_body_to_dict,
     process_event_body,
     validate_matching_patient_ids,
 )
+from utils.lambda_exceptions import DocumentRefException
+from utils.lambda_response import ApiGatewayResponse
+from utils.request_context import request_context
 
 sys.path.append(os.path.join(os.path.dirname(__file__)))
 
@@ -43,29 +48,36 @@
 def lambda_handler(event, context):
     request_context.app_interaction = LoggingAppInteraction.UPLOAD_RECORD.value
 
-    FeatureFlagService().validate_feature_flag(
-        FeatureFlags.UPLOAD_LAMBDA_ENABLED.value
-    )
+    feature_flag_service = FeatureFlagService()
+    feature_flag_service.validate_feature_flag(FeatureFlags.UPLOAD_LAMBDA_ENABLED.value)
 
     logger.info("Starting document reference creation process")
-    nhs_number_query = event["queryStringParameters"]["patientId"]
 
-    nhs_number_body, doc_list = process_event_body(
-        event
-    )
+    normalize_event_body_to_dict(event)
+    try:
+        validated_event = CreateEventModel.model_validate(event)
+
+        nhs_number_query = validated_event.query_string_parameters["patientId"]
+
+        nhs_number_body, doc_list = process_event_body(validated_event)
+
+        validate_matching_patient_ids(nhs_number_query, nhs_number_body)
 
-    validate_matching_patient_ids(
-        nhs_number_query, nhs_number_body
-    )
+        request_context.patient_nhs_no = nhs_number_query
 
-    request_context.patient_nhs_no = nhs_number_query
+        logger.info("Processed upload documents from request")
+        create_doc_ref_service = CreateDocumentReferenceService()
 
-    logger.info("Processed upload documents from request")
-    create_doc_ref_service = CreateDocumentReferenceService()
+        url_references = create_doc_ref_service.create_document_reference_request(
+            nhs_number_query, doc_list
+        )
 
-    url_references = create_doc_ref_service.create_document_reference_request(
-        nhs_number_query, doc_list
-    )
+    except ValidationError as e:
+        logger.error(
+            f"Failed to parse Document Reference: {str(e)}",
+            {"Results": "Validation failure during document reference create"},
+        )
+        raise DocumentRefException(400, LambdaError.DocRefNoParse)
 
     return ApiGatewayResponse(
         200, json.dumps(url_references), "POST"

lambdas/handlers/get_document_reference_handler.py

@@ -1,22 +1,23 @@
-from utils.decorators.handle_lambda_exceptions import handle_lambda_exceptions
-from utils.decorators.override_error_check import override_error_check
-from services.feature_flags_service import FeatureFlagService
+import json
+
 from enums.feature_flags import FeatureFlags
+from enums.lambda_error import LambdaError
+from enums.logging_app_interaction import LoggingAppInteraction
+from services.feature_flags_service import FeatureFlagService
 from services.get_document_reference_service import GetDocumentReferenceService
+from utils.audit_logging_setup import LoggingService
+from utils.decorators.ensure_env_var import ensure_environment_variables
+from utils.decorators.handle_lambda_exceptions import handle_lambda_exceptions
+from utils.decorators.override_error_check import override_error_check
+from utils.decorators.set_audit_arg import set_request_context_for_logging
 from utils.decorators.validate_patient_id import validate_patient_id
-from utils.lambda_exceptions import FeatureFlagsException
-from enums.lambda_error import LambdaError
 from utils.lambda_exceptions import GetDocumentRefException
 from utils.lambda_response import ApiGatewayResponse
-from utils.decorators.ensure_env_var import ensure_environment_variables
-from utils.decorators.set_audit_arg import set_request_context_for_logging
-from enums.logging_app_interaction import LoggingAppInteraction
-from utils.audit_logging_setup import LoggingService
 from utils.request_context import request_context
-import json
 
 logger = LoggingService(__name__)
 
+
 @validate_patient_id
 @handle_lambda_exceptions
 @set_request_context_for_logging
@@ -36,20 +37,24 @@ def lambda_handler(event: dict[str, any], context):
     request_context.app_interaction = LoggingAppInteraction.VIEW_LG_RECORD.value
 
     feature_flag_service = FeatureFlagService()
-    feature_flag_service.validate_feature_flag(FeatureFlags.UPLOAD_DOCUMENT_ITERATION_3_ENABLED)
-    
+    feature_flag_service.validate_feature_flag(
+        FeatureFlags.UPLOAD_DOCUMENT_ITERATION_3_ENABLED
+    )
+
     logger.info("Starting document fetch by ID process")
 
     try:
         document_id = event["pathParameters"]["id"]
         nhs_number = event["queryStringParameters"]["patientId"]
     except KeyError:
-        raise GetDocumentRefException(400, LambdaError.DocumentReferenceMissingParameters)
-    
+        raise GetDocumentRefException(
+            400, LambdaError.DocumentReferenceMissingParameters
+        )
+
     service = GetDocumentReferenceService()
 
     document_info = service.get_document_url_by_id(document_id, nhs_number)
 
     return ApiGatewayResponse(
         status_code=200, body=json.dumps(document_info), methods="GET"
-    ).create_api_gateway_response()
+    ).create_api_gateway_response()

lambdas/handlers/update_document_reference_handler.py

@@ -1,11 +1,10 @@
 import json
 
-from pydantic import ValidationError
-
 from enums.feature_flags import FeatureFlags
 from enums.lambda_error import LambdaError
 from enums.logging_app_interaction import LoggingAppInteraction
 from models.document_reference import UpdateEventModel
+from pydantic import ValidationError
 from services.feature_flags_service import FeatureFlagService
 from services.update_document_reference_service import UpdateDocumentReferenceService
 from utils.audit_logging_setup import LoggingService
@@ -17,7 +16,7 @@
 from utils.document_reference_common_validations import (
     normalize_event_body_to_dict,
     process_event_body,
-    validate_matching_patient_ids
+    validate_matching_patient_ids,
 )
 from utils.lambda_exceptions import DocumentRefException
 from utils.lambda_response import ApiGatewayResponse
@@ -46,32 +45,26 @@ def lambda_handler(event, context):
     request_context.app_interaction = LoggingAppInteraction.UPDATE_RECORD.value
 
     feature_flag_service = FeatureFlagService()
-    feature_flag_service.validate_feature_flag(
-        FeatureFlags.UPLOAD_LAMBDA_ENABLED.value
-    )
+    feature_flag_service.validate_feature_flag(FeatureFlags.UPLOAD_LAMBDA_ENABLED.value)
 
     feature_flag_service.validate_feature_flag(
         FeatureFlags.UPLOAD_DOCUMENT_ITERATION_2_ENABLED.value
     )
 
     logger.info("Starting document reference update process")
 
-    event_dict = normalize_event_body_to_dict(event)
+    normalize_event_body_to_dict(event)
 
     try:
-        validated_event = UpdateEventModel.model_validate(event_dict)
-        
+        validated_event = UpdateEventModel.model_validate(event)
+
         nhs_number_query = validated_event.query_string_parameters["patientId"]
         doc_ref_id = validated_event.path_parameters["id"]
 
-        nhs_number_body, document = process_event_body(
-            validated_event.model_dump()
-        )
+        nhs_number_body, document = process_event_body(validated_event)
+
+        validate_matching_patient_ids(nhs_number_query, nhs_number_body)
 
-        validate_matching_patient_ids(
-            nhs_number_query, nhs_number_body
-        )
-        
         request_context.patient_nhs_no = nhs_number_query
 
         logger.info("Processed update documents from request")
@@ -86,9 +79,7 @@ def lambda_handler(event, context):
             f"Failed to parse Document Reference: {str(e)}",
             {"Results": "Validation failure during document reference update"},
         )
-        raise DocumentRefException(
-            400, LambdaError.DocRefNoParse
-        )
+        raise DocumentRefException(400, LambdaError.DocRefNoParse)
 
     return ApiGatewayResponse(
         200, json.dumps(url_responses), "PUT"

lambdas/models/document_reference.py

@@ -45,14 +45,21 @@ class Subject(BaseModel):
     identifier: Identifier
 
 
-class UpdateBody(BaseModel):
+class DocumentReferenceBody(BaseModel):
     model_config = ConfigDict(validate_by_alias=True, alias_generator=to_camel)
     resource_type: str
     subject: Subject
-    content: list[SingleAttachment]
     created: str
 
 
+class UpdateDocumentReferenceBody(DocumentReferenceBody):
+    content: list[SingleAttachment]
+
+
+class CreateDocumentReferenceBody(DocumentReferenceBody):
+    content: list[Attachment]
+
+
 class GenericEventModel(BaseModel):
     model_config = ConfigDict(
         validate_by_alias=True,
@@ -62,11 +69,15 @@ class GenericEventModel(BaseModel):
     )
     http_method: str
     query_string_parameters: dict
-    path_parameters: dict
+    path_parameters: dict | None = None
 
 
 class UpdateEventModel(GenericEventModel):
-    body: UpdateBody
+    body: UpdateDocumentReferenceBody
+
+
+class CreateEventModel(GenericEventModel):
+    body: CreateDocumentReferenceBody
 
 
 class UploadDocumentReference(BaseModel):

lambdas/models/fhir/R4/fhir_document_reference.py

@@ -13,7 +13,6 @@
 )
 from pydantic import BaseModel, Field
 from utils.exceptions import FhirDocumentReferenceException
-
 from utils.ods_utils import PCSE_ODS_CODE
 
 # Constants
@@ -134,8 +133,7 @@ def extract_nhs_number_from_fhir(self) -> str:
         if (
             self.subject
             and self.subject.identifier
-            and self.subject.identifier.system
-            == "https://fhir.nhs.uk/Id/nhs-number"
+            and self.subject.identifier.system == "https://fhir.nhs.uk/Id/nhs-number"
         ):
             return self.subject.identifier.value
         else:
@@ -267,10 +265,12 @@ def create_fhir_document_reference_object(
                     "ods-organization-code", document.custodian or self.custodian
                 )
             ),
-            meta=Meta(versionId=document.version)
+            meta=Meta(versionId=document.version),
         )
 
-    def create_fhir_document_reference_object_basic(self, original_id: str, original_version) -> DocumentReference:
+    def create_fhir_document_reference_object_basic(
+        self, original_id: str, original_version
+    ) -> DocumentReference:
         return DocumentReference(
             resourceType="DocumentReference",
             id=f"{original_id}",
@@ -286,5 +286,5 @@ def create_fhir_document_reference_object_basic(self, original_id: str, original
                     )
                 )
             ],
-            meta=Meta(versionId=original_version)
-        )
+            meta=Meta(versionId=original_version),
+        )