NRL-518 Add value set for pydantic diagnostic messages

Author: axelkrastek1-nhs

layer/nrlf/core/errors.py

@@ -19,9 +19,25 @@ def format_error_location(loc: List) -> str:
     return formatted_loc
 
 
+def append_value_set_url(loc_string: str) -> str:
+    if loc_string.endswith(("url", "system")):
+        return ""
+
+    if "content" in loc_string:
+        if "extension" in loc_string:
+            return ". See ValueSet: https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability"
+        if "format" in loc_string:
+            return ". See ValueSet: https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode"
+
+    return ""
+
+
 def diag_for_error(error: ErrorDetails) -> str:
     loc_string = format_error_location(error["loc"])
-    return f"{loc_string or 'root'}: {error['msg']}"
+    print(f"Error location: {loc_string}")
+    msg = f"{loc_string or 'root'}: {error['msg']}"
+    msg += append_value_set_url(loc_string)
+    return msg
 
 
 def expression_for_error(error: ErrorDetails) -> Optional[str]:

layer/nrlf/core/tests/test_pydantic_errors.py

@@ -84,7 +84,7 @@ def test_validate_content_missing_format():
                 }
             ]
         },
-        "diagnostics": "Failed to parse DocumentReference resource (content[0].format: Field required)",
+        "diagnostics": "Failed to parse DocumentReference resource (content[0].format: Field required. See ValueSet: https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode)",
         "expression": ["content[0].format"],
     }
 
@@ -115,7 +115,7 @@ def test_validate_content_multiple_content_stability_extensions():
                 }
             ]
         },
-        "diagnostics": "Failed to parse DocumentReference resource (content[0].extension: List should have at most 1 item after validation, not 2)",
+        "diagnostics": "Failed to parse DocumentReference resource (content[0].extension: List should have at most 1 item after validation, not 2. See ValueSet: https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability)",
         "expression": ["content[0].extension"],
     }
 
@@ -145,7 +145,7 @@ def test_validate_content_invalid_content_stability_code():
                 }
             ]
         },
-        "diagnostics": "Failed to parse DocumentReference resource (content[0].extension[0].valueCodeableConcept.coding[0].code: Input should be 'static' or 'dynamic')",
+        "diagnostics": "Failed to parse DocumentReference resource (content[0].extension[0].valueCodeableConcept.coding[0].code: Input should be 'static' or 'dynamic'. See ValueSet: https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability)",
         "expression": ["content[0].extension[0].valueCodeableConcept.coding[0].code"],
     }
 
@@ -175,7 +175,7 @@ def test_validate_content_invalid_content_stability_display():
                 }
             ]
         },
-        "diagnostics": "Failed to parse DocumentReference resource (content[0].extension[0].valueCodeableConcept.coding[0].display: Input should be 'Static' or 'Dynamic')",
+        "diagnostics": "Failed to parse DocumentReference resource (content[0].extension[0].valueCodeableConcept.coding[0].display: Input should be 'Static' or 'Dynamic'. See ValueSet: https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability)",
         "expression": [
             "content[0].extension[0].valueCodeableConcept.coding[0].display"
         ],
@@ -267,7 +267,7 @@ def test_validate_content_empty_content_stability_coding():
                 }
             ]
         },
-        "diagnostics": "Failed to parse DocumentReference resource (content[0].extension[0].valueCodeableConcept.coding: List should have at least 1 item after validation, not 0)",
+        "diagnostics": "Failed to parse DocumentReference resource (content[0].extension[0].valueCodeableConcept.coding: List should have at least 1 item after validation, not 0. See ValueSet: https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability)",
         "expression": ["content[0].extension[0].valueCodeableConcept.coding"],
     }
 
@@ -298,6 +298,6 @@ def test_validate_content_missing_content_stability_coding():
                 }
             ]
         },
-        "diagnostics": "Failed to parse DocumentReference resource (content[0].extension[0].valueCodeableConcept.coding: Field required)",
+        "diagnostics": "Failed to parse DocumentReference resource (content[0].extension[0].valueCodeableConcept.coding: Field required. See ValueSet: https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability)",
         "expression": ["content[0].extension[0].valueCodeableConcept.coding"],
     }