NRL-1050 Do not map type-category when one invalid, remove later mapping check

axelkrastek1-nhs · axelkrastek1-nhs · commit dd89e49a2356 · 2024-11-08T11:18:51.000Z
diff --git a/api/producer/createDocumentReference/create_document_reference.py b/api/producer/createDocumentReference/create_document_reference.py
@@ -4,7 +4,6 @@
 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
@@ -91,19 +90,6 @@ 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,
diff --git a/api/producer/createDocumentReference/tests/test_create_document_reference.py b/api/producer/createDocumentReference/tests/test_create_document_reference.py
@@ -423,22 +423,7 @@ def test_create_document_reference_invalid_pointer_type():
                 },
                 "diagnostics": "Invalid type code: invalid Type must be a member of the England-NRLRecordType value set (https://fhir.nhs.uk/England/CodeSystem/England-NRLRecordType)",
                 "expression": ["type.coding[0].code"],
-            },
-            {
-                "severity": "error",
-                "code": "value",
-                "details": {
-                    "coding": [
-                        {
-                            "code": "INVALID_RESOURCE",
-                            "display": "Invalid validation of resource",
-                            "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
-                        }
-                    ]
-                },
-                "diagnostics": "type (http://snomed.info/sct|invalid) does not map to the category: http://snomed.info/sct|734163000",
-                "expression": ["type.coding[0]"],
-            },
+            }
         ],
     }
 
@@ -520,12 +505,12 @@ def test_create_document_reference_invalid_category_type():
         "issue": [
             {
                 "severity": "error",
-                "code": "invalid",
+                "code": "value",
                 "details": {
                     "coding": [
                         {
-                            "code": "BAD_REQUEST",
-                            "display": "Bad request",
+                            "code": "INVALID_RESOURCE",
+                            "display": "Invalid validation of resource",
                             "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
                         }
                     ]
diff --git a/api/producer/upsertDocumentReference/tests/test_upsert_document_reference.py b/api/producer/upsertDocumentReference/tests/test_upsert_document_reference.py
@@ -222,12 +222,12 @@ def test_upsert_document_reference_invalid_category_type():
         "issue": [
             {
                 "severity": "error",
-                "code": "invalid",
+                "code": "value",
                 "details": {
                     "coding": [
                         {
-                            "code": "BAD_REQUEST",
-                            "display": "Bad request",
+                            "code": "INVALID_RESOURCE",
+                            "display": "Invalid validation of resource",
                             "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
                         }
                     ]
@@ -550,21 +550,6 @@ def test_upsert_document_reference_invalid_pointer_type():
                 "diagnostics": "Invalid type code: invalid Type must be a member of the England-NRLRecordType value set (https://fhir.nhs.uk/England/CodeSystem/England-NRLRecordType)",
                 "expression": ["type.coding[0].code"],
             },
-            {
-                "severity": "error",
-                "code": "value",
-                "details": {
-                    "coding": [
-                        {
-                            "code": "INVALID_RESOURCE",
-                            "display": "Invalid validation of resource",
-                            "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
-                        }
-                    ]
-                },
-                "diagnostics": "type (http://snomed.info/sct|invalid) does not map to the category: http://snomed.info/sct|734163000",
-                "expression": ["type.coding[0]"],
-            },
         ],
     }
 
diff --git a/api/producer/upsertDocumentReference/upsert_document_reference.py b/api/producer/upsertDocumentReference/upsert_document_reference.py
@@ -2,7 +2,6 @@
 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
@@ -89,19 +88,6 @@ 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.PROUPSERT005a,
-            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,
diff --git a/layer/nrlf/core/log_references.py b/layer/nrlf/core/log_references.py
@@ -221,11 +221,7 @@ 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"
diff --git a/layer/nrlf/core/tests/test_validators.py b/layer/nrlf/core/tests/test_validators.py
@@ -459,6 +459,16 @@ def test_validate_category_coding_display_mismatch_observations():
     validator = DocumentReferenceValidator()
     document_ref_data = load_document_reference_json("Y05868-736253002-Valid")
 
+    document_ref_data["type"] = {
+        "coding": [
+            {
+                "system": "http://snomed.info/sct",
+                "code": "1363501000000100",
+                "display": "Royal College of Physicians NEWS2 (National Early Warning Score 2) chart",
+            }
+        ]
+    }
+
     document_ref_data["category"][0] = {
         "coding": [
             {
@@ -613,15 +623,19 @@ def test_validate_type_coding_invalid_code():
 
     document_ref_data["type"] = {
         "coding": [
-            {"system": "http://snomed.info/sct", "code": "1234", "display": "Care plan"}
+            {
+                "system": "http://snomed.info/sct",
+                "code": "1234",
+                "display": "Mental health crisis plan",
+            }
         ]
     }
 
     result = validator.validate(document_ref_data)
 
     assert result.is_valid is False
     assert result.resource.id == "Y05868-99999-99999-999999"
-    assert len(result.issues) == 2
+    assert len(result.issues) == 1
     assert result.issues[0].model_dump(exclude_none=True) == {
         "severity": "error",
         "code": "value",
@@ -637,21 +651,6 @@ def test_validate_type_coding_invalid_code():
         "diagnostics": "Invalid type code: 1234 Type must be a member of the England-NRLRecordType value set (https://fhir.nhs.uk/England/CodeSystem/England-NRLRecordType)",
         "expression": ["type.coding[0].code"],
     }
-    assert result.issues[1].model_dump(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": "type (http://snomed.info/sct|1234) does not map to the category: http://snomed.info/sct|734163000",
-        "expression": ["type.coding[0]"],
-    }
 
 
 def test_validate_type_coding_multiple_codings():
@@ -708,8 +707,8 @@ def test_validate_type_coding_invalid_system():
         "coding": [
             {
                 "system": "http://snoooooomed/sctfffffg",
-                "code": "734163000",
-                "display": "Care plan",
+                "code": "736253002",
+                "display": "Mental health crisis plan",
             }
         ]
     }
@@ -718,7 +717,7 @@ def test_validate_type_coding_invalid_system():
 
     assert result.is_valid is False
     assert result.resource.id == "Y05868-99999-99999-999999"
-    assert len(result.issues) == 2
+    assert len(result.issues) == 1
     assert result.issues[0].model_dump(exclude_none=True) == {
         "severity": "error",
         "code": "value",
@@ -734,21 +733,6 @@ def test_validate_type_coding_invalid_system():
         "diagnostics": "Invalid type system: http://snoooooomed/sctfffffg Type system must be either 'http://snomed.info/sct' or 'https://nicip.nhs.uk'",
         "expression": ["type.coding[0].system"],
     }
-    assert result.issues[1].model_dump(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": "type (http://snoooooomed/sctfffffg|734163000) does not map to the category: http://snomed.info/sct|734163000",
-        "expression": ["type.coding[0]"],
-    }
 
 
 @pytest.mark.parametrize(
diff --git a/layer/nrlf/core/validators.py b/layer/nrlf/core/validators.py
@@ -10,6 +10,8 @@
     REQUIRED_CREATE_FIELDS,
     TYPE_ATTRIBUTES,
     TYPE_CATEGORIES,
+    Categories,
+    PointerTypes,
 )
 from nrlf.core.errors import ParseError
 from nrlf.core.logger import LogReference, logger
@@ -445,7 +447,7 @@ def _validate_category(self, model: DocumentReference):
 
     def _validate_type_category_mapping(self, model: DocumentReference):
         """
-        Validate the type field contains an appropriate coding system, code and display.
+        Validate the type field matches the expected category
         """
         logger.log(LogReference.VALIDATOR001, step="type_category_mapping")
 
@@ -454,12 +456,16 @@ def _validate_type_category_mapping(self, model: DocumentReference):
         category_coding = model.category[0].coding[0]
         category_id = f"{category_coding.system}|{category_coding.code}"
 
-        if not TYPE_CATEGORIES.get(type_id):
+        if type_id not in PointerTypes.list() or category_id not in Categories.list():
+            return  # No point mapping to an unexisting/unsupported type/category
+
+        type_category = TYPE_CATEGORIES.get(type_id)
+        if type_category != category_id:
             self.result.add_error(
                 issue_code="value",
                 error_code="INVALID_RESOURCE",
-                diagnostics=f"type ({type_id}) does not map to the category: {category_id}",
-                field=f"type.coding[0]",
+                diagnostics=f"The Category code of the provided document '{category_id}' must match the allowed category for pointer type '{type_id}' with a category value of '{type_category}'",
+                field=f"category.coding[0].code",
             )
 
     def _validate_content_extension(self, model: DocumentReference):
