NRL-474 validate author system, length and value format

eesa456 · eesa456 · commit 6a0cfd9760c0 · 2024-11-04T11:37:05.000Z
diff --git a/layer/nrlf/core/constants.py b/layer/nrlf/core/constants.py
@@ -8,7 +8,15 @@ class Source(Enum):
 
 VALID_SOURCES = frozenset(item.value for item in Source.__members__.values())
 EMPTY_VALUES = ("", None, [], {})
-REQUIRED_CREATE_FIELDS = ["custodian", "id", "type", "status", "subject", "category"]
+REQUIRED_CREATE_FIELDS = [
+    "custodian",
+    "id",
+    "type",
+    "status",
+    "subject",
+    "category",
+    "author",
+]
 JSON_TYPES = {dict, list}
 NHS_NUMBER_INDEX = "idx_nhs_number_by_id"
 ID_SEPARATOR = "-"
diff --git a/layer/nrlf/core/tests/test_validators.py b/layer/nrlf/core/tests/test_validators.py
@@ -2,7 +2,7 @@
 
 import pytest
 
-from nrlf.core.constants import PointerTypes
+from nrlf.core.constants import ODS_SYSTEM, PointerTypes
 from nrlf.core.errors import ParseError
 from nrlf.core.validators import (
     DocumentReferenceValidator,
@@ -599,22 +599,44 @@ def test_validate_category_coding_invalid_system():
     }
 
 
-def test_validate_content_extension_too_many_extensions():
+def test_validate_author_no_author():
     validator = DocumentReferenceValidator()
     document_ref_data = load_document_reference_json("Y05868-736253002-Valid")
 
-    document_ref_data["content"][0]["extension"].append(
+    del document_ref_data["author"]
+
+    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].model_dump(exclude_none=True) == {
+        "severity": "error",
+        "code": "required",
+        "details": {
+            "coding": [
+                {
+                    "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
+                    "code": "INVALID_RESOURCE",
+                    "display": "Invalid validation of resource",
+                }
+            ]
+        },
+        "diagnostics": "The required field 'author' is missing",
+        "expression": ["author"],
+    }
+
+
+def test_validate_author_too_many_authors():
+    validator = DocumentReferenceValidator()
+    document_ref_data = load_document_reference_json("Y05868-736253002-Valid")
+
+    document_ref_data["author"].append(
         {
-            "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability",
-            "valueCodeableConcept": {
-                "coding": [
-                    {
-                        "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability",
-                        "code": "static",
-                        "display": "static",
-                    }
-                ]
-            },
+            "identifier": {
+                "system": ODS_SYSTEM,
+                "value": "someODSCode",
+            }
         }
     )
 
@@ -635,8 +657,107 @@ def test_validate_content_extension_too_many_extensions():
                 }
             ]
         },
-        "diagnostics": "Invalid content extension length: 2 Extension must only contain a single value",
-        "expression": ["content[0].extension"],
+        "diagnostics": "Invalid author length: 2 Author must only contain a single value",
+        "expression": ["author"],
+    }
+
+
+def test_validate_author_system_invalid():
+    validator = DocumentReferenceValidator()
+    document_ref_data = load_document_reference_json("Y05868-736253002-Valid")
+
+    document_ref_data["author"][0] = {
+        "identifier": {
+            "system": "some system",
+            "value": "someODSCode",
+        }
+    }
+
+    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].model_dump(exclude_none=True) == {
+        "severity": "error",
+        "code": "invalid",
+        "details": {
+            "coding": [
+                {
+                    "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
+                    "code": "INVALID_RESOURCE",
+                    "display": "Invalid validation of resource",
+                }
+            ]
+        },
+        "diagnostics": f"Invalid author system: 'some system' Author system must be 'https://fhir.nhs.uk/Id/ods-organization-code'",
+        "expression": ["author[0].identifier.system"],
+    }
+
+
+def test_validate_author_value_invalid():
+    validator = DocumentReferenceValidator()
+    document_ref_data = load_document_reference_json("Y05868-736253002-Valid")
+
+    document_ref_data["author"][0] = {
+        "identifier": {
+            "system": ODS_SYSTEM,
+            "value": "!!!!!!12sd",
+        }
+    }
+
+    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].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": f"Invalid author value: '!!!!!!12sd' Author value must be alphanumeric",
+        "expression": ["author[0].identifier.value"],
+    }
+
+
+def test_validate_author_value_too_long():
+    validator = DocumentReferenceValidator()
+    document_ref_data = load_document_reference_json("Y05868-736253002-Valid")
+
+    document_ref_data["author"][0] = {
+        "identifier": {
+            "system": ODS_SYSTEM,
+            "value": "d1111111111111111111111111111111111111111111111",
+        }
+    }
+
+    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].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": f"Invalid author value: 'd1111111111111111111111111111111111111111111111' Author value must be less than 13 characters",
+        "expression": ["author[0].identifier.value"],
     }
 
 
diff --git a/layer/nrlf/core/validators.py b/layer/nrlf/core/validators.py
@@ -5,7 +5,7 @@
 from pydantic import ValidationError
 
 from nrlf.core.codes import SpineErrorConcept
-from nrlf.core.constants import CATEGORY_ATTRIBUTES, REQUIRED_CREATE_FIELDS
+from nrlf.core.constants import CATEGORY_ATTRIBUTES, ODS_SYSTEM, REQUIRED_CREATE_FIELDS
 from nrlf.core.errors import ParseError
 from nrlf.core.logger import LogReference, logger
 from nrlf.core.types import DocumentReference, OperationOutcomeIssue, RequestQueryType
@@ -118,6 +118,7 @@ def validate(self, data: Dict[str, Any] | DocumentReference):
             self._validate_relates_to(resource)
             self._validate_ssp_asid(resource)
             self._validate_category(resource)
+            self._validate_author(resource)
             if resource.content[0].extension:
                 self._validate_content_extension(resource)
 
@@ -464,3 +465,48 @@ def _validate_content_extension(self, model: DocumentReference):
                     field=f"content[{i}].extension[0].url",
                 )
                 return
+
+    def _validate_author(self, model: DocumentReference):
+        """
+        Validate the author field contains an appropriate coding system and code.
+        """
+        logger.log(LogReference.VALIDATOR001, step="author")
+
+        if len(model.author) > 1:
+            self.result.add_error(
+                issue_code="invalid",
+                error_code="INVALID_RESOURCE",
+                diagnostics=f"Invalid author length: {len(model.author)} Author must only contain a single value",
+                field=f"author",
+            )
+            return
+
+        logger.debug("Validating author")
+        identifier = model.author[0].identifier
+
+        if identifier.system != ODS_SYSTEM:
+            self.result.add_error(
+                issue_code="invalid",
+                error_code="INVALID_IDENTIFIER_SYSTEM",
+                diagnostics=f"Invalid author system: '{identifier.system}' Author system must be '{ODS_SYSTEM}'",
+                field=f"author[0].identifier.system",
+            )
+            return
+
+        if not identifier.value.isalnum():
+            self.result.add_error(
+                issue_code="value",
+                error_code="INVALID_RESOURCE",
+                diagnostics=f"Invalid author value: '{identifier.value}' Author value must be alphanumeric",
+                field=f"author[0].identifier.value",
+            )
+            return
+
+        if len(identifier.value) > 12:
+            self.result.add_error(
+                issue_code="value",
+                error_code="INVALID_RESOURCE",
+                diagnostics=f"Invalid author value: '{identifier.value}' Author value must be less than 13 characters",
+                field=f"author[0].identifier.value",
+            )
+            return
diff --git a/tests/features/producer/createDocumentReference-failure.feature b/tests/features/producer/createDocumentReference-failure.feature
@@ -120,6 +120,80 @@ Feature: Producer - createDocumentReference - Failure Scenarios
       }
       """
 
+  Scenario: Invalid Author
+    Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API
+    And the organisation 'TSTCUS' is authorised to access pointer types:
+      | system                 | value     |
+      | http://snomed.info/sct | 736253002 |
+    When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'author' is:
+      """
+      "author":[{
+        "identifier": {
+            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
+            "value": "!!!!!"
+        }
+      }]
+      """
+    Then the response status code is 400
+    And the response is an OperationOutcome with 1 issue
+    And the OperationOutcome contains the issue:
+      """
+      {
+        "severity": "error",
+        "code": "value",
+        "details": {
+            "coding": [
+            {
+                "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
+                "code": "INVALID_RESOURCE",
+                "display": "Invalid validation of resource"
+            }
+            ]
+        },
+        "diagnostics": "Invalid author value: '!!!!!' Author value must be alphanumeric",
+        "expression": [
+            "author[0].identifier.value"
+        ]
+      }
+      """
+
+  Scenario: Invalid Author System
+    Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API
+    And the organisation 'TSTCUS' is authorised to access pointer types:
+      | system                 | value     |
+      | http://snomed.info/sct | 736253002 |
+    When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'author' is:
+      """
+      "author":[{
+        "identifier": {
+            "system": "ddddd",
+            "value": "123"
+        }
+      }]
+      """
+    Then the response status code is 400
+    And the response is an OperationOutcome with 1 issue
+    And the OperationOutcome contains the issue:
+      """
+      {
+        "severity": "error",
+        "code": "invalid",
+        "details": {
+            "coding": [
+            {
+                "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
+                "code": "INVALID_IDENTIFIER_SYSTEM",
+                "display": "Invalid identifier system"
+            }
+            ]
+        },
+        "diagnostics": "Invalid author system: 'ddddd' Author system must be 'https://fhir.nhs.uk/Id/ods-organization-code'",
+        "expression": [
+            "author[0].identifier.system"
+        ]
+      }
+      """
+
   # Invalid document reference - invalid custodian ID
   # Invalid document reference - invalid relatesTo target
   # Invalid document reference - invalid producer ID in relatesTo target
