NRL-936 add validation to create for category and type

Author: eesa456

api/producer/createDocumentReference/create_document_reference.py

@@ -4,6 +4,7 @@
 from nrlf.core.constants import (
     PERMISSION_AUDIT_DATES_FROM_PAYLOAD,
     PERMISSION_SUPERSEDE_IGNORE_DELETE_FAIL,
+    TYPE_CATEGORIES,
 )
 from nrlf.core.decorators import request_handler
 from nrlf.core.dynamodb.repository import DocumentPointer, DocumentPointerRepository
@@ -90,6 +91,19 @@ def _check_permissions(
             expression="type.coding[0].code",
         )
 
+    type_category = TYPE_CATEGORIES.get(core_model.type)
+    if type_category != core_model.category:
+        logger.log(
+            LogReference.PROCREATE005a,
+            ods_code=metadata.ods_code,
+            type=core_model.type,
+            category=core_model.category,
+        )
+        return SpineErrorResponse.BAD_REQUEST(
+            diagnostics=f"The Category code of the provided document '{core_model.category}' must match the allowed category for pointer type '{core_model.type}' with a category value of '{type_category}'",
+            expression="category.coding[0].code",
+        )
+
 
 def _get_document_ids_to_supersede(
     resource: DocumentReference,

api/producer/createDocumentReference/tests/test_create_document_reference.py

@@ -424,6 +424,51 @@ def test_create_document_reference_invalid_pointer_type():
     }
 
 
+def test_create_document_reference_invalid_category_type():
+    doc_ref = load_document_reference("Y05868-736253002-Valid")
+
+    assert doc_ref.category and doc_ref.category[0].coding
+    doc_ref.category[0].coding[0].code = "1102421000000108"
+    doc_ref.category[0].coding[0].display = "Observations"
+
+    event = create_test_api_gateway_event(
+        headers=create_headers(),
+        body=doc_ref.json(exclude_none=True),
+    )
+
+    result = handler(event, create_mock_context())
+    body = result.pop("body")
+
+    assert result == {
+        "statusCode": "400",
+        "headers": {},
+        "isBase64Encoded": False,
+    }
+
+    parsed_body = json.loads(body)
+
+    assert parsed_body == {
+        "resourceType": "OperationOutcome",
+        "issue": [
+            {
+                "severity": "error",
+                "code": "invalid",
+                "details": {
+                    "coding": [
+                        {
+                            "code": "BAD_REQUEST",
+                            "display": "Bad request",
+                            "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
+                        }
+                    ]
+                },
+                "diagnostics": "The Category code of the provided document 'http://snomed.info/sct|1102421000000108' must match the allowed category for pointer type 'http://snomed.info/sct|736253002' with a category value of 'http://snomed.info/sct|734163000'",
+                "expression": ["category.coding[0].code"],
+            }
+        ],
+    }
+
+
 def test_create_document_reference_no_relatesto_target():
     doc_ref = load_document_reference("Y05868-736253002-Valid")
     doc_ref.relatesTo = [

layer/nrlf/core/log_references.py

@@ -210,6 +210,10 @@ class LogReference(Enum):
     PROCREATE005 = _Reference(
         "WARN", "Organisation is not allowed to create pointer type"
     )  #
+    PROCREATE005a = _Reference(
+        "WARN",
+        "Organisation is not allowed to create pointer type with incorrect category",
+    )  #
     PROCREATE006 = _Reference("DEBUG", "Performing relatesTo validation on resource")
     PROCREATE007a = _Reference(
         "WARN", "RelatesTo validation failed - no target identifier value"

layer/nrlf/core/tests/test_validators.py

@@ -485,42 +485,6 @@ def test_validate_category_coding_display_mismatch_observations():
     }
 
 
-def test_validate_category_coding_and_type_mismatch():
-    validator = DocumentReferenceValidator()
-    document_ref_data = load_document_reference_json("Y05868-736253002-Valid")
-
-    document_ref_data["category"][0] = {
-        "coding": [
-            {
-                "system": "http://snomed.info/sct",
-                "code": "1102421000000108",
-                "display": "Observations",
-            }
-        ]
-    }
-
-    result = validator.validate(document_ref_data)
-
-    assert result.is_valid is False
-    assert result.resource.id == "Y05868-99999-99999-999999"
-    assert len(result.issues) == 1
-    assert result.issues[0].dict(exclude_none=True) == {
-        "severity": "error",
-        "code": "value",
-        "details": {
-            "coding": [
-                {
-                    "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
-                    "code": "INVALID_RESOURCE",
-                    "display": "Invalid validation of resource",
-                }
-            ]
-        },
-        "diagnostics": "category code '1102421000000108' must match the allowed category for pointer type 736253002 with a category value of '734163000'",
-        "expression": ["category[0].coding[0].code"],
-    }
-
-
 def test_validate_category_coding_invalid_code():
     validator = DocumentReferenceValidator()
     document_ref_data = load_document_reference_json("Y05868-736253002-Valid")

layer/nrlf/core/validators.py

@@ -5,7 +5,7 @@
 from pydantic import ValidationError
 
 from nrlf.core.codes import SpineErrorConcept
-from nrlf.core.constants import CATEGORIES, REQUIRED_CREATE_FIELDS, TYPE_CATEGORIES
+from nrlf.core.constants import CATEGORIES, REQUIRED_CREATE_FIELDS
 from nrlf.core.errors import ParseError
 from nrlf.core.logger import LogReference, logger
 from nrlf.core.types import DocumentReference, OperationOutcomeIssue, RequestQueryType
@@ -392,18 +392,6 @@ def _validate_category(self, model: DocumentReference):
             )
             return
 
-        pointer_type = model.type.coding[0].code
-        type_category = TYPE_CATEGORIES[f"http://snomed.info/sct|{pointer_type}"].split(
-            "|"
-        )[1]
-        if type_category != coding.code:
-            self.result.add_error(
-                issue_code="value",
-                error_code="INVALID_RESOURCE",
-                diagnostics=f"category code '{coding.code}' must match the allowed category for pointer type {pointer_type} with a category value of '{type_category}'",
-                field=f"category[0].coding[{0}].code",
-            )
-
     def _validate_content_extension(self, model: DocumentReference):
         """
         Validate the content.extension field contains an appropriate coding.