NRL-1050 Add validation for types and type-category mappings

Author: axelkrastek1-nhs

layer/nrlf/core/constants.py

@@ -105,6 +105,51 @@ def coding_value(self):
     },
 }
 
+TYPE_ATTRIBUTES = {
+    PointerTypes.MENTAL_HEALTH_PLAN.value: {
+        "display": "Mental health crisis plan",
+    },
+    PointerTypes.EMERGENCY_HEALTHCARE_PLAN.value: {
+        "display": "Emergency health care plan",
+    },
+    PointerTypes.EOL_COORDINATION_SUMMARY.value: {
+        "display": "End of Life Care Coordination Summary",
+    },
+    PointerTypes.RESPECT_FORM.value: {
+        "display": "ReSPECT (Recommended Summary Plan for Emergency Care and Treatment) form",
+    },
+    PointerTypes.NEWS2_CHART.value: {
+        "display": "Royal College of Physicians NEWS2 (National Early Warning Score 2) chart",
+    },
+    PointerTypes.CONTINGENCY_PLAN.value: {
+        "display": "Contingency plan",
+    },
+    PointerTypes.EOL_CARE_PLAN.value: {
+        "display": "End of life care plan",
+    },
+    PointerTypes.LLOYD_GEORGE_FOLDER.value: {
+        "display": "Lloyd George record folder",
+    },
+    PointerTypes.ADVANCED_CARE_PLAN.value: {
+        "display": "Advanced care plan",
+    },
+    PointerTypes.TREATMENT_ESCALATION_PLAN.value: {
+        "display": "Treatment escalation plan",
+    },
+    PointerTypes.SUMMARY_RECORD.value: {
+        "display": "Summary record",
+    },
+    PointerTypes.PERSONALISED_CARE_AND_SUPPORT_PLAN.value: {
+        "display": "Personalised Care and Support Plan",
+    },
+    PointerTypes.MRA_UPPER_LIMB_ARTERY.value: {
+        "display": "MRA Upper Limb Artery",
+    },
+    PointerTypes.MRI_AXILLA_BOTH.value: {
+        "display": "MRI Axilla Both",
+    },
+}
+
 TYPE_CATEGORIES = {
     #
     # Care plans

layer/nrlf/core/validators.py

@@ -5,7 +5,12 @@
 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,
+    REQUIRED_CREATE_FIELDS,
+    TYPE_ATTRIBUTES,
+    TYPE_CATEGORIES,
+)
 from nrlf.core.errors import ParseError
 from nrlf.core.logger import LogReference, logger
 from nrlf.core.types import DocumentReference, OperationOutcomeIssue, RequestQueryType
@@ -117,7 +122,9 @@ def validate(self, data: Dict[str, Any] | DocumentReference):
             self._validate_identifiers(resource)
             self._validate_relates_to(resource)
             self._validate_ssp_asid(resource)
+            self._validate_type(resource)
             self._validate_category(resource)
+            self._validate_type_category_mapping(resource)
             if resource.content[0].extension:
                 self._validate_content_extension(resource)
 
@@ -336,6 +343,50 @@ def _validate_ssp_asid(self, model: DocumentReference):
             )
             return
 
+    def _validate_type(self, model: DocumentReference):
+        """
+        Validate the type field contains an appropriate coding system, code and display.
+        """
+        logger.log(LogReference.VALIDATOR001, step="type")
+
+        if len(model.type.coding) > 1:
+            self.result.add_error(
+                issue_code="invalid",
+                error_code="INVALID_RESOURCE",
+                diagnostics=f"Invalid type coding length: {len(model.type[0].coding)} Type Coding must only contain a single value",
+                field=f"type.coding",
+            )
+            return
+
+        coding = model.type.coding[0]
+        if coding.system not in ["http://snomed.info/sct", "https://nicip.nhs.uk"]:
+            self.result.add_error(
+                issue_code="value",
+                error_code="INVALID_RESOURCE",
+                diagnostics=f"Invalid type system: {coding.system} Type system must be either 'http://snomed.info/sct' or 'https://nicip.nhs.uk'",
+                field="type.coding[0].system",
+            )
+            return
+
+        type_id = f"{coding.system}|{coding.code}"
+        if type_id not in TYPE_ATTRIBUTES.keys():
+            self.result.add_error(
+                issue_code="value",
+                error_code="INVALID_RESOURCE",
+                diagnostics=f"Invalid type code: {coding.code} Type must be a member of the England-NRLRecordCategory value set (https://fhir.nhs.uk/England/CodeSystem/England-NRLRecordType)",
+                field="type.coding[0].code",
+            )
+            return
+
+        type_attributes = TYPE_ATTRIBUTES.get(type_id, {})
+        if coding.display != type_attributes.get("display"):
+            self.result.add_error(
+                issue_code="value",
+                error_code="INVALID_RESOURCE",
+                diagnostics=f"type code '{coding.code}' must have a display value of '{type_attributes.get('display')}'",
+                field="type.coding[0].display",
+            )
+
     def _validate_category(self, model: DocumentReference):
         """
         Validate the category field contains an appropriate coding system, code and display.
@@ -363,22 +414,22 @@ def _validate_category(self, model: DocumentReference):
             return
 
         coding = model.category[0].coding[0]
-        if coding.system != "http://snomed.info/sct":
+        if coding.system not in ["http://snomed.info/sct", "https://nicip.nhs.uk"]:
             self.result.add_error(
                 issue_code="value",
                 error_code="INVALID_RESOURCE",
-                diagnostics=f"Invalid category system: {coding.system} Category system must be 'http://snomed.info/sct'",
-                field=f"category[0].coding[{0}].system",
+                diagnostics=f"Invalid category system: {coding.system} Category system must be either 'http://snomed.info/sct' or 'https://nicip.nhs.uk'",
+                field="category[0].coding[0].system",
             )
             return
 
-        category_id = f"http://snomed.info/sct|{coding.code}"
+        category_id = f"{coding.system}|{coding.code}"
         if category_id not in CATEGORY_ATTRIBUTES.keys():
             self.result.add_error(
                 issue_code="value",
                 error_code="INVALID_RESOURCE",
                 diagnostics=f"Invalid category code: {coding.code} Category must be a member of the England-NRLRecordCategory value set (https://fhir.nhs.uk/England/CodeSystem/England-NRLRecordCategory)",
-                field=f"category[0].coding[{0}].code",
+                field="category[0].coding[0].code",
             )
             return
 
@@ -388,7 +439,26 @@ def _validate_category(self, model: DocumentReference):
                 issue_code="value",
                 error_code="INVALID_RESOURCE",
                 diagnostics=f"category code '{coding.code}' must have a display value of '{category_attributes.get('display')}'",
-                field=f"category[0].coding[{0}].display",
+                field="category[0].coding[0].display",
+            )
+
+    def _validate_type_category_mapping(self, model: DocumentReference):
+        """
+        Validate the type field contains an appropriate coding system, code and display.
+        """
+        logger.log(LogReference.VALIDATOR001, step="type_category_mapping")
+
+        type_coding = model.type.coding[0]
+        type_id = f"{type_coding.system}|{type_coding.code}"
+        category_coding = model.category[0].coding[0]
+        category_id = f"{category_coding.system}|{category_coding.code}"
+
+        if not TYPE_CATEGORIES.get(type_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].display",
             )
 
     def _validate_content_extension(self, model: DocumentReference):