NPA-5629: OperationOutcome IOPS update

lelliott-hippo · lelliott-hippo · commit e8f2e7ff65d2 · 2025-09-17T12:42:14.000+01:00
diff --git a/specification/examples/responses/GET_Consent/ID/errors/invalid-id.yaml b/specification/examples/responses/GET_Consent/ID/errors/invalid-id.yaml
@@ -4,12 +4,12 @@ ConsentInvalidIDError:
   value:
     issue:
       - code: invalid
-        diagnostics: "Invalid request with error - ID must be a valid UUID."
         details:
           coding:
             - code: "INVALID_ID_VALUE"
               display: "Required parameter(s) are invalid."
               system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
               version: "1"
+        diagnostics: "Invalid request with error - ID must be a valid UUID."
         severity: error
     resourceType: "OperationOutcome"
diff --git a/specification/examples/responses/GET_Consent/errors/gp-practice-not-found.yaml b/specification/examples/responses/GET_Consent/errors/gp-practice-not-found.yaml
@@ -10,5 +10,6 @@ GPPracticeNotFoundError:
               version: "1"
               code: "GP_PRACTICE_NOT_FOUND"
               display: "GP Practice could not be found - invalid resources cannot be retrieved"
+        diagnostics: "GP Practice could not be found"
         severity: error
     resourceType: "OperationOutcome"
diff --git a/specification/examples/responses/GET_Consent/errors/invalid-identifier-system.yaml b/specification/examples/responses/GET_Consent/errors/invalid-identifier-system.yaml
@@ -4,12 +4,12 @@ ConsentInvalidIdentifierSystemError:
   value:
     issue:
       - code: invalid
-        diagnostics: "Invalid request with error - performer:identifier or patient:identifier system parameter is invalid."
         details:
           coding:
             - code: "INVALID_IDENTIFIER_SYSTEM"
               display: "Required parameter(s) are invalid."
               system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
               version: '1'
+        diagnostics: "Invalid request with error - performer:identifier or patient:identifier system parameter is invalid."
         severity: error
     resourceType: "OperationOutcome"
diff --git a/specification/examples/responses/GET_Consent/errors/invalid-identifier.yaml b/specification/examples/responses/GET_Consent/errors/invalid-identifier.yaml
@@ -4,13 +4,13 @@ ConsentInvalidIdentifierError:
   value:
     issue:
       - code: invalid
-        diagnostics: 'Invalid request with error - performer:identifier or patient:identifier parameter is invalid.'
         details:
           coding:
             - code: "INVALID_IDENTIFIER_VALUE"
               display: "Required parameter(s) are invalid."
               system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
               version: '1'
+        diagnostics: 'Invalid request with error - performer:identifier or patient:identifier parameter is invalid.'
         severity: error
     resourceType: "OperationOutcome"
 
diff --git a/specification/examples/responses/GET_Consent/errors/invalid-status-parameter.yaml b/specification/examples/responses/GET_Consent/errors/invalid-status-parameter.yaml
@@ -4,12 +4,12 @@ ConsentInvalidStatusParameterError:
   value:
     issue:
       - code: invalid
-        diagnostics: "Invalid request with error - status parameter is invalid."
         details:
           coding:
             - code: "INVALID_PARAMETER"
               display: "Required parameter(s) are invalid."
               system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
               version: "1"
+        diagnostics: "Invalid request with error - status parameter is invalid."
         severity: error
     resourceType: "OperationOutcome"
diff --git a/specification/examples/responses/GET_Consent/errors/missing-identifier.yaml b/specification/examples/responses/GET_Consent/errors/missing-identifier.yaml
@@ -4,12 +4,12 @@ ConsentIdentifierMissingError:
   value:
     issue:
       - code: invalid
-        diagnostics: "Invalid request with error - performer:identifier or patient:identifier parameter not found."
         details:
           coding:
             - code: "MISSING_IDENTIFIER_VALUE"
               display: "Required parameter(s) are missing."
               system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
               version: "1"
+        diagnostics: "Invalid request with error - performer:identifier or patient:identifier parameter not found."
         severity: error
     resourceType: "OperationOutcome"
diff --git a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-patient.yaml b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-patient.yaml
@@ -4,12 +4,12 @@ InvalidIdentifierPatientError:
   value:
     issue:
       - code: invalid
-        diagnostics: "Not a valid NHS Number provided for the 'patient:identifier' parameter"
         details:
           coding:
             - "system": "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
               version: "1"
               code: "INVALID_PATIENT_IDENTIFIER_VALUE"
               display: "Provided value is invalid"
+        diagnostics: "Not a valid NHS Number provided for the 'patient:identifier' parameter"
         severity: error
     resourceType: "OperationOutcome"
diff --git a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-system.yaml b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier-system.yaml
@@ -4,12 +4,12 @@ RelatedPersonInvalidIdentifierSystem:
   value:
     issue:
       - code: invalid
-        diagnostics: The identifier system is not valid.
-        severity: error
         details:
           coding:
             - code: INVALID_IDENTIFIER_SYSTEM
               display: Invalid identifier system.
               system: https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode
               version: '1'
+        diagnostics: The identifier system is not valid.
+        severity: error
     resourceType: OperationOutcome
diff --git a/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier.yaml b/specification/examples/responses/GET_RelatedPerson/errors/invalid-identifier.yaml
@@ -4,13 +4,13 @@ RelatedPersonInvalidIdentifierError:
   value:
     issue:
       - code: invalid
-        diagnostics: "Not a valid NHS Number provided for the 'identifier' parameter"
-        expression: "RelatedPerson.identifier"
         details:
           coding:
             - "system": "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
               version: "1"
               code: "INVALID_IDENTIFIER_VALUE"
               display: "Provided value is invalid"
+        diagnostics: "Not a valid NHS Number provided for the 'identifier' parameter"
+        expression: ["RelatedPerson.identifier"]
         severity: error
     resourceType: "OperationOutcome"
diff --git a/specification/examples/responses/errors/access-denied.yaml b/specification/examples/responses/errors/access-denied.yaml
@@ -3,12 +3,13 @@ AccessDeniedError:
   description: The request was unsuccessful due to invalid authentication credentials being provided.
   value:
     issue:
-      - code: invalid
+      - code: forbidden
         details:
           coding:
             - code: "ACCESS_DENIED"
               display: "Missing or invalid OAuth 2.0 bearer token in request."
               "system": "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
               version: "1"
+        diagnostics: "Missing or invalid OAuth 2.0 bearer token in request"
         severity: error
     resourceType: "OperationOutcome"
diff --git a/specification/examples/responses/errors/downstream-service-error.yaml b/specification/examples/responses/errors/downstream-service-error.yaml
@@ -4,12 +4,12 @@ DownstreamServiceError:
   value:
     issue:
       - code: processing
-        diagnostics: "Downstream Service Error - Failed to generate response is present in the response"
         details:
           coding:
             - code: "DOWNSTREAM_SERVICE_ERROR"
               display: "Failed to generate response"
               system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
               version: "1"
+        diagnostics: "Downstream Service Error - Failed to generate response is present in the response"
         severity: error
     resourceType: "OperationOutcome"
diff --git a/specification/examples/responses/errors/internal-server-error.yaml b/specification/examples/responses/errors/internal-server-error.yaml
@@ -3,13 +3,13 @@ InternalServerError:
   description: An unexpected condition was encountered preventing the server from fulfilling the request.
   value:
     issue:
-      - code: invalid
-        diagnostics: "Internal Server Error - Failed to generate response is present in the response"
+      - code: exception
         details:
           coding:
             - code: "SERVER_ERROR"
               display: "Failed to generate response"
               system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
               version: "1"
+        diagnostics: "Internal Server Error - Failed to generate response is present in the response"
         severity: error
     resourceType: "OperationOutcome"
diff --git a/specification/examples/responses/errors/invalid-include-parameter.yaml b/specification/examples/responses/errors/invalid-include-parameter.yaml
@@ -2,7 +2,6 @@ InvalidIncludeParameterError:
   summary: Bad request include param invalid
   description: 400 error response bundle for an invalid include parameter
   value:
-    resourceType: "OperationOutcome"
     issue:
       - code: invalid
         details:
@@ -11,5 +10,6 @@ InvalidIncludeParameterError:
               version: "1"
               code: "INVALID_PARAMETER"
               display: "Required parameter(s) are invalid."
+        diagnostics: "Invalid request with error - _include parameter is invalid."
         severity: error
-    diagnostics: "Invalid request with error - _include parameter is invalid."
+    resourceType: "OperationOutcome"    
diff --git a/specification/examples/responses/errors/invalidated-resource.yaml b/specification/examples/responses/errors/invalidated-resource.yaml
@@ -10,5 +10,6 @@ InvalidatedResourceError:
               version: "1"
               code: "INVALIDATED_RESOURCE"
               display: "Resource that has been marked as invalid was requested - invalid resources cannot be retrieved"
+        diagnostics: "Resource that has been marked as invalid was requested - invalid resources cannot be retrieved"
         severity: error
     resourceType: "OperationOutcome"
