NRL-477 validate format code for attachment types

Author: eesa456

layer/nrlf/core/tests/test_validators.py

@@ -1522,3 +1522,63 @@ def test_validate_ssp_content_with_multiple_asids():
         "diagnostics": "Multiple ASID identifiers provided. Only a single valid ASID identifier can be provided in the context.related.",
         "expression": ["context.related"],
     }
+
+
+def test_validate_content_format_invalid_code_for_unstructured_document():
+    validator = DocumentReferenceValidator()
+    document_ref_data = load_document_reference_json("Y05868-736253002-Valid")
+
+    document_ref_data["content"][0]["format"] = {
+        "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
+        "code": "urn:nhs-ic:contact",
+        "display": "Contact details",
+    }
+
+    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": "Invalid content format code: urn:nhs-ic:contact format code must be 'urn:nhs-ic:unstructured' for Unstructured Document attachments.",
+        "expression": ["content[0].format.code"],
+    }
+
+
+def test_validate_content_format_invalid_code_for_contact_details():
+    validator = DocumentReferenceValidator()
+    document_ref_data = load_document_reference_json("Y05868-736253002-Valid")
+
+    document_ref_data["content"][0]["attachment"]["contentType"] = "text/html"
+
+    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": "Invalid content format code: urn:nhs-ic:unstructured format code must be 'urn:nhs-ic:record-contact' for Contact details attachments.",
+        "expression": ["content[0].format.code"],
+    }

layer/nrlf/core/validators.py

@@ -141,6 +141,7 @@ def validate(self, data: Dict[str, Any] | DocumentReference):
             self._validate_category(resource)
             self._validate_author(resource)
             self._validate_type_category_mapping(resource)
+            self._validate_content_format(resource)
             if resource.content[0].extension:
                 self._validate_content_extension(resource)
 
@@ -481,6 +482,35 @@ def _validate_type_category_mapping(self, model: DocumentReference):
                 field="category.coding[0].code",
             )
 
+    def _validate_content_format(self, model: DocumentReference):
+        """
+        Validate the content.format field contains an appropriate coding.
+        """
+        logger.log(LogReference.VALIDATOR001, step="content_format")
+
+        logger.debug("Validating format")
+        for i, content in enumerate(model.content):
+            if (
+                content.attachment.contentType == "text/html"
+                and content.format.code != "urn:nhs-ic:record-contact"
+            ):
+                self.result.add_error(
+                    issue_code="value",
+                    error_code="INVALID_RESOURCE",
+                    diagnostics=f"Invalid content format code: {content.format.code} format code must be 'urn:nhs-ic:record-contact' for Contact details attachments.",
+                    field=f"content[{i}].format.code",
+                )
+            elif (
+                content.attachment.contentType == "application/pdf"
+                and content.format.code != "urn:nhs-ic:unstructured"
+            ):
+                self.result.add_error(
+                    issue_code="value",
+                    error_code="INVALID_RESOURCE",
+                    diagnostics=f"Invalid content format code: {content.format.code} format code must be 'urn:nhs-ic:unstructured' for Unstructured Document attachments.",
+                    field=f"content[{i}].format.code",
+                )
+
     def _validate_content_extension(self, model: DocumentReference):
         """
         Validate the content.extension field contains an appropriate coding.

tests/features/producer/createDocumentReference-failure.feature

@@ -407,6 +407,52 @@ Feature: Producer - createDocumentReference - Failure Scenarios
       }
       """
 
+  Scenario: Invalid format code for attachment type
+    Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API
+    And the organisation 'X26' is authorised to access pointer types:
+      | system                 | value            |
+      | http://snomed.info/sct | 1363501000000100 |
+      | http://snomed.info/sct | 736253002        |
+    When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'content' is:
+      """
+      "content": [
+        {
+          "attachment": {
+            "contentType": "application/pdf",
+            "language": "en-US",
+            "url": "https://spine-proxy.national.ncrs.nhs.uk/https%3A%2F%2Fp1.nhs.uk%2FMentalhealthCrisisPlanReport.pdf",
+            "size": 3654,
+            "hash": "2jmj7l5rSw0yVb/vlWAYkK/YBwk=",
+            "title": "Mental health crisis plan report",
+            "creation": "2022-12-21T10:45:41+11:00"
+          },
+          "format": {
+            "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
+            "code": "urn:nhs-ic:record-contact",
+            "display": "Contact details"
+        }
+      """
+    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 content format code: urn:nhs-ic:unstructured format code must be 'urn:nhs-ic:record-contact' for Contact details attachments.",
+        "expression": ["content[0].format.code"]
+      }
+      """
+
   # Invalid document reference - invalid Type
   # NRL-769 Known issue: Type display is not validated
   # Scenario: Invalid type (valid code but wrong display value)