Merge pull request #624 from NHSDigital/feature/kabo5-NRL-525-self-links-serch

katebobyn-nhs · web-flow · commit ca20f72e5102 · 2024-05-27T20:22:58.000+01:00
Feature/kabo5 nrl 525 self links serch
diff --git a/api/consumer/searchDocumentReference/search_document_reference.py b/api/consumer/searchDocumentReference/search_document_reference.py
@@ -2,6 +2,7 @@
 
 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.errors import OperationOutcomeError
@@ -41,6 +42,9 @@ def handler(
             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|{params.nhs_number}"
 
     if not validate_type_system(params.type, metadata.pointer_types):
         logger.log(
@@ -58,8 +62,20 @@ def handler(
         if params.custodian_identifier
         else None
     )
-    bundle = {"resourceType": "Bundle", "type": "searchset", "total": 0, "entry": []}
+    if custodian_id:
+        self_link += f"&custodian:identifier=https://fhir.nhs.uk/Id/ods-organization-code|{custodian_id}"
+
     pointer_types = [params.type.__root__] if params.type else metadata.pointer_types
+    if params.type:
+        self_link += f"&type={params.type.__root__}"
+
+    bundle = {
+        "resourceType": "Bundle",
+        "type": "searchset",
+        "link": [{"relation": "self", "url": self_link}],
+        "total": 0,
+        "entry": [],
+    }
 
     logger.log(
         LogReference.CONSEARCH003,
diff --git a/api/consumer/searchDocumentReference/tests/test_search_document_reference_consumer.py b/api/consumer/searchDocumentReference/tests/test_search_document_reference_consumer.py
@@ -33,9 +33,16 @@ def test_search_document_reference_happy_path(repository: DocumentPointerReposit
     assert result == {"statusCode": "200", "headers": {}, "isBase64Encoded": False}
 
     parsed_body = json.loads(body)
+
     assert parsed_body == {
         "resourceType": "Bundle",
         "type": "searchset",
+        "link": [
+            {
+                "relation": "self",
+                "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191",
+            }
+        ],
         "total": 1,
         "entry": [{"resource": doc_ref.dict(exclude_none=True)}],
     }
@@ -67,6 +74,49 @@ def test_search_document_reference_happy_path_with_custodian(
     assert parsed_body == {
         "resourceType": "Bundle",
         "type": "searchset",
+        "link": [
+            {
+                "relation": "self",
+                "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191&custodian:identifier=https://fhir.nhs.uk/Id/ods-organization-code|Y05868",
+            }
+        ],
+        "total": 1,
+        "entry": [{"resource": doc_ref.dict(exclude_none=True)}],
+    }
+
+
+@mock_aws
+@mock_repository
+def test_search_document_reference_happy_path_with_type(
+    repository: DocumentPointerRepository,
+):
+    doc_ref = load_document_reference("Y05868-736253002-Valid")
+    doc_pointer = DocumentPointer.from_document_reference(doc_ref)
+    repository.create(doc_pointer)
+
+    event = create_test_api_gateway_event(
+        headers=create_headers(),
+        query_string_parameters={
+            "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191",
+            "type": "http://snomed.info/sct|736253002",
+        },
+    )
+
+    result = handler(event, create_mock_context())
+    body = result.pop("body")
+
+    assert result == {"statusCode": "200", "headers": {}, "isBase64Encoded": False}
+
+    parsed_body = json.loads(body)
+    assert parsed_body == {
+        "resourceType": "Bundle",
+        "type": "searchset",
+        "link": [
+            {
+                "relation": "self",
+                "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191&type=http://snomed.info/sct|736253002",
+            }
+        ],
         "total": 1,
         "entry": [{"resource": doc_ref.dict(exclude_none=True)}],
     }
@@ -91,6 +141,12 @@ def test_search_document_reference_no_results(repository: DocumentPointerReposit
     assert parsed_body == {
         "resourceType": "Bundle",
         "type": "searchset",
+        "link": [
+            {
+                "relation": "self",
+                "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191",
+            }
+        ],
         "total": 0,
         "entry": [],
     }
diff --git a/api/consumer/searchPostDocumentReference/search_post_document_reference.py b/api/consumer/searchPostDocumentReference/search_post_document_reference.py
@@ -2,6 +2,7 @@
 
 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.errors import OperationOutcomeError
@@ -45,6 +46,10 @@ def handler(
             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_system(body.type, metadata.pointer_types):
         logger.log(
             LogReference.CONPOSTSEARCH002,
@@ -61,9 +66,20 @@ def handler(
         if body.custodian_identifier
         else None
     )
+    if custodian_id:
+        self_link += f"&custodian:identifier=https://fhir.nhs.uk/Id/ods-organization-code|{custodian_id}"
 
-    bundle = {"resourceType": "Bundle", "type": "searchset", "total": 0, "entry": []}
     pointer_types = [body.type.__root__] if body.type else metadata.pointer_types
+    if body.type:
+        self_link += f"&type={body.type.__root__}"
+
+    bundle = {
+        "resourceType": "Bundle",
+        "type": "searchset",
+        "link": [{"relation": "self", "url": self_link}],
+        "total": 0,
+        "entry": [],
+    }
 
     logger.log(
         LogReference.CONPOSTSEARCH003,
diff --git a/api/consumer/searchPostDocumentReference/tests/test_search_post_document_reference_consumer.py b/api/consumer/searchPostDocumentReference/tests/test_search_post_document_reference_consumer.py
@@ -42,6 +42,12 @@ def test_search_post_document_reference_happy_path(
     assert parsed_body == {
         "resourceType": "Bundle",
         "type": "searchset",
+        "link": [
+            {
+                "relation": "self",
+                "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191",
+            }
+        ],
         "total": 1,
         "entry": [{"resource": doc_ref.dict(exclude_none=True)}],
     }
@@ -75,6 +81,51 @@ def test_search_post_document_reference_happy_path_with_custodian(
     assert parsed_body == {
         "resourceType": "Bundle",
         "type": "searchset",
+        "link": [
+            {
+                "relation": "self",
+                "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191&custodian:identifier=https://fhir.nhs.uk/Id/ods-organization-code|Y05868",
+            }
+        ],
+        "total": 1,
+        "entry": [{"resource": doc_ref.dict(exclude_none=True)}],
+    }
+
+
+@mock_aws
+@mock_repository
+def test_search_post_document_reference_happy_path_with_type(
+    repository: DocumentPointerRepository,
+):
+    doc_ref = load_document_reference("Y05868-736253002-Valid")
+    doc_pointer = DocumentPointer.from_document_reference(doc_ref)
+    repository.create(doc_pointer)
+
+    event = create_test_api_gateway_event(
+        headers=create_headers(),
+        body=json.dumps(
+            {
+                "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191",
+                "type": "http://snomed.info/sct|736253002",
+            },
+        ),
+    )
+
+    result = handler(event, create_mock_context())
+    body = result.pop("body")
+
+    assert result == {"statusCode": "200", "headers": {}, "isBase64Encoded": False}
+
+    parsed_body = json.loads(body)
+    assert parsed_body == {
+        "resourceType": "Bundle",
+        "type": "searchset",
+        "link": [
+            {
+                "relation": "self",
+                "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191&type=http://snomed.info/sct|736253002",
+            }
+        ],
         "total": 1,
         "entry": [{"resource": doc_ref.dict(exclude_none=True)}],
     }
@@ -101,6 +152,12 @@ def test_search_document_reference_no_results(repository: DocumentPointerReposit
     assert parsed_body == {
         "resourceType": "Bundle",
         "type": "searchset",
+        "link": [
+            {
+                "relation": "self",
+                "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191",
+            }
+        ],
         "total": 0,
         "entry": [],
     }
diff --git a/layer/nrlf/core/config.py b/layer/nrlf/core/config.py
@@ -8,7 +8,7 @@ class Config(BaseSettings):
     All Environment Variables are validated using pydantic, and will result in
     a 500 Internal Server Error if validation fails.
 
-    To add a new Environment Variable simply a new pydantic compatible
+    To add a new Environment Variable simply add a new pydantic compatible
     definition below, and pydantic should allow for even complex validation
     logic to be supported.
     """
diff --git a/tests/features/consumer/searchDocumentReference-success.feature b/tests/features/consumer/searchDocumentReference-success.feature
@@ -19,6 +19,7 @@ Feature: Consumer - searchDocumentReference - Success Scenarios
       | subject   | 9278693472 |
     Then the response status code is 200
     And the response is a searchset Bundle
+    And the Bundle has a self link matching 'DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9278693472'
     And the Bundle has a total of 1
     And the Bundle has 1 entry
     And the Bundle contains an DocumentReference with values
@@ -68,6 +69,7 @@ Feature: Consumer - searchDocumentReference - Success Scenarios
       | subject   | 9278693472 |
     Then the response status code is 200
     And the response is a searchset Bundle
+    And the Bundle has a self link matching 'DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9278693472'
     And the Bundle has a total of 2
     And the Bundle has 2 entries
     And the Bundle contains an DocumentReference with values
diff --git a/tests/features/consumer/searchPostDocumentReference-success.feature b/tests/features/consumer/searchPostDocumentReference-success.feature
@@ -19,6 +19,7 @@ Feature: Consumer - searchDocumentReference - Success Scenarios
       | subject   | 9278693472 |
     Then the response status code is 200
     And the response is a searchset Bundle
+    And the Bundle has a self link matching 'DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9278693472'
     And the Bundle has a total of 1
     And the Bundle has 1 entry
     And the Bundle contains an DocumentReference with values
diff --git a/tests/features/steps/3_assert.py b/tests/features/steps/3_assert.py
@@ -69,6 +69,42 @@ def assert_bundle_total_step(context: Context, total: str):
     )
 
 
+@then("the Bundle has a self link matching '{rel_url}'")
+def assert_bundle_self(context: Context, rel_url: str):
+    assert (
+        context.bundle is not None
+    ), "The Bundle has not yet been parsed from the response"
+    assert context.bundle.link is not None, format_error(
+        "No links present in the Bundle",
+        f"{context.base_url}{rel_url}",
+        "None",
+        context.response.text,
+    )
+
+    assert len(context.bundle.link) == 1, format_error(
+        "The Bundle's link array should contain a single item if no pagination is used",
+        "1 entry",
+        f"{len(context.bundle.link)} entries",
+        context.response.text,
+    )
+
+    link_entry = context.bundle.link[0].dict(exclude_none=True)
+    assert link_entry.get("relation") == "self", format_error(
+        "Link should specify a 'self' type relation",
+        "self",
+        link_entry.get("relation"),
+        context.response.text,
+    )
+
+    actual_url_params = link_entry.get("url").split("consumer/FHIR/R4/")[-1]
+    assert actual_url_params == rel_url, format_error(
+        "Link url does not specify the search parameters expected",
+        rel_url,
+        actual_url_params,
+        context.response.text,
+    )
+
+
 @then("the Bundle has {num_entries} entry")
 @then("the Bundle has {num_entries} entries")
 def assert_bundle_entries_step(context: Context, num_entries: str):
