search_post_document_reference.py

from pydantic import ValidationError

from nrlf.consumer.fhir.r4.model import Bundle, DocumentReference
from nrlf.core.codes import SpineErrorConcept
from nrlf.core.config import Config
from nrlf.core.decorators import request_handler
from nrlf.core.dynamodb.repository import DocumentPointerRepository
from nrlf.core.logger import LogReference, logger
from nrlf.core.model import ConnectionMetadata, ConsumerRequestParams
from nrlf.core.response import Response, SpineErrorResponse
from nrlf.core.validators import validate_category, validate_type
from nrlf.producer.fhir.r4.model import OperationOutcome, OperationOutcomeIssue


@request_handler(body=ConsumerRequestParams)
def handler(
    body: ConsumerRequestParams,
    metadata: ConnectionMetadata,
    repository: DocumentPointerRepository,
) -> Response:
    """
    Search for document references based on the provided parameters.

    Args:
        body (ConsumerRequestParams): The request parameters for the search.
        metadata (ConnectionMetadata): The metadata containing pointer types.
        repository (DocumentPointerRepository): The repository for document pointers.

    Returns:
        Response: The response containing the search results.

    Raises:
        SpineErrorResponse.INVALID_NHS_NUMBER: If a valid NHS number is not provided.
        SpineErrorResponse.INVALID_CODE_SYSTEM: If the provided type system is invalid.
        OperationOutcomeError: If an error occurs while parsing the document reference.
    """

    logger.log(LogReference.CONPOSTSEARCH000)

    if not body.nhs_number:
        logger.log(
            LogReference.CONPOSTSEARCH001, subject_identifier=body.subject_identifier
        )
        return SpineErrorResponse.INVALID_NHS_NUMBER(
            diagnostics="A valid NHS number is required to search for document references",
            expression="subject:identifier",
        )

    config = Config()
    base_url = f"https://{config.ENVIRONMENT}.api.service.nhs.uk/"
    self_link = f"{base_url}record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|{body.nhs_number}"

    if not validate_type(body.type, metadata.pointer_types):
        logger.log(
            LogReference.CONPOSTSEARCH002,
            type=body.type,
            pointer_types=metadata.pointer_types,
        )
        return SpineErrorResponse.INVALID_CODE_SYSTEM(
            diagnostics="The provided type does not match the allowed types for this organisation",
            expression="type",
        )

    categories = body.category.root.split(",") if body.category else []
    if not validate_category(categories):
        logger.log(
            LogReference.CONPOSTSEARCH002b,
            category=body.category,
        )  # TODO - Should update error message once permissioning by category is implemented
        return SpineErrorResponse.INVALID_CODE_SYSTEM(
            diagnostics="The provided category is not valid",
            expression="category",
        )

    custodian_id = (
        body.custodian_identifier.root.split("|", maxsplit=1)[1]
        if body.custodian_identifier
        else None
    )
    if custodian_id:
        self_link += f"&custodian:identifier=https://fhir.nhs.uk/Id/ods-organization-code|{custodian_id}"

    pointer_types = [body.type.root] if body.type else metadata.pointer_types
    if body.type:
        self_link += f"&type={body.type.root}"

    if body.category:
        self_link += f"&category={body.category.root}"

    bundle = {
        "resourceType": "Bundle",
        "type": "searchset",
        "link": [{"relation": "self", "url": self_link}],
        "total": 0,
        "entry": [],
    }

    logger.log(
        LogReference.CONPOSTSEARCH003,
        nhs_number=body.nhs_number,
        custodian_id=custodian_id,
        pointer_types=pointer_types,
    )

    for result in repository.search(
        nhs_number=body.nhs_number,
        custodian=custodian_id,
        pointer_types=pointer_types,
        categories=categories,
    ):
        try:
            document_reference = DocumentReference.model_validate_json(result.document)
            bundle["total"] += 1
            bundle["entry"].append(
                {"resource": document_reference.model_dump(exclude_none=True)}
            )
            logger.log(
                LogReference.CONPOSTSEARCH004,
                id=document_reference.id,
                count=bundle["total"],
            )

        except ValidationError as exc:
            logger.log(
                LogReference.CONPOSTSEARCH005, error=str(exc), document=result.document
            )
            operation_outcome = OperationOutcome(
                resourceType="OperationOutcome",
                issue=[
                    OperationOutcomeIssue(
                        severity="error",
                        code="exception",
                        details=SpineErrorConcept.from_code("INTERNAL_SERVER_ERROR"),
                        diagnostics="An error occurred whilst parsing the document reference search results",
                    )
                ],
            )
            bundle["total"] += 1
            bundle["entry"].append(
                {"resource": operation_outcome.model_dump(exclude_none=True)}
            )

    response = Response.from_resource(Bundle.model_validate(bundle))
    logger.log(LogReference.CONPOSTSEARCH999)

    return response