fix: updated examples

ClarksonAdam · ClarksonAdam · commit 732d85f613fc · 2025-01-17T16:01:35.000Z
diff --git a/specification/examples/responses/GET_Consent/errors/invalid-identifier-system.yaml b/specification/examples/responses/GET_Consent/errors/invalid-identifier-system.yaml
@@ -0,0 +1,15 @@
+ConsentInvalidIdentifierSystemErrorBundle:
+  summary: Bad request identifier system invalid
+  description: 400 error response bundle for an invalid system of the identifier
+  value:
+    issue:
+      - code: invalid
+        diagnostics: "Invalid request with error - performer: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'
+        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
@@ -0,0 +1,16 @@
+ConsentInvalidIdentifierErrorBundle:
+  summary: Bad request invalid identifier
+  description: Error raised due to an invalid identifier request parameter being specified.
+  value:
+    issue:
+      - code: invalid
+        diagnostics: 'Invalid request with error - performer: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'
+        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
@@ -1,15 +1,15 @@
-ConsentInvalidStatusParameterBundle:
+ConsentInvalidStatusParameterErrorBundle:
   summary: Bad request status param invalid
   description: 400 error response bundle for an invalid status parameter
   value:
-    resourceType: "OperationOutcome"
     issue:
-      - severity: error
-        code: invalid
+      - code: invalid
         diagnostics: "Invalid request with error - status parameter is invalid."
         details:
           coding:
-            - system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
-              version: "1"
-              code: "INVALID_VALUE"
+            - code: "INVALID_VALUE"
               display: "Required parameter(s) are invalid."
+              system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
+              version: "1"
+        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
@@ -0,0 +1,15 @@
+ConsentIdentifierMissingErrorBundle:
+  summary: Bad request identifier missing
+  description: 400 error response bundle for a missing identifier
+  value:
+    issue:
+      - code: invalid
+        diagnostics: "Invalid request with error - performer: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"
+        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
@@ -1,11 +1,9 @@
-RelatedPersonInvalidIdentifierError:
+RelatedPersonInvalidIdentifierErrorBundle:
   summary: Invalid RelatedPerson identifier
   description: Error raised due to an invalid RelatedPerson identifier request parameter being specified.
   value:
-    resourceType: "OperationOutcome"
     issue:
-      - severity: error
-        code: invalid
+      - code: invalid
         diagnostics: "Not a valid NHS Number provided for the 'identifier' parameter"
         expression: "RelatedPerson.identifier"
         details:
@@ -14,3 +12,5 @@ RelatedPersonInvalidIdentifierError:
               version: "1"
               code: "INVALID_IDENTIFIER_VALUE"
               display: "Provided value is invalid"
+        severity: error
+    resourceType: "OperationOutcome"
diff --git a/specification/examples/responses/errors/access-denied.yaml b/specification/examples/responses/errors/access-denied.yaml
@@ -1,14 +1,14 @@
-AccessDeniedError:
+AccessDeniedErrorBundle:
   summary: Access Denied
-  description: THe request was unsuccessful due to invalid authentication credentials being provided.
+  description: The request was unsuccessful due to invalid authentication credentials being provided.
   value:
-    resourceType: "OperationOutcome"
     issue:
-      - severity: error
-        code: invalid
+      - code: invalid
         details:
           coding:
-            - "system": "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
-              version: "1"
-              code: "ACCESS_DENIED"
+            - 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"
+        severity: error
+    resourceType: "OperationOutcome"
diff --git a/specification/examples/responses/errors/internal-server-error.yaml b/specification/examples/responses/errors/internal-server-error.yaml
@@ -1,15 +1,15 @@
-InternalServerError:
+InternalServerErrorBundle:
   summary: Internal Server Error
   description: An unexpected condition was encountered preventing the server from fulfilling the request.
   value:
-    resourceType: "OperationOutcome"
     issue:
-      - severity: error
-        code: invalid
+      - code: invalid
         diagnostics: "Internal Server Error - Failed to generate response is present in the response"
         details:
           coding:
-            - system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
-              version: "1"
-              code: "SERVER_ERROR"
+            - code: "SERVER_ERROR"
               display: "Failed to generate response"
+              system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
+              version: "1"
+        severity: error
+    resourceType: "OperationOutcome"
diff --git a/specification/examples/responses/errors/invalid-identifier-system.yaml b/specification/examples/responses/errors/invalid-identifier-system.yaml
diff --git a/specification/examples/responses/errors/invalid-identifier.yaml b/specification/examples/responses/errors/invalid-identifier.yaml
diff --git a/specification/examples/responses/errors/invalid-include-parameter.yaml b/specification/examples/responses/errors/invalid-include-parameter.yaml
@@ -1,16 +1,15 @@
-InvalidIncludeParameterBundle:
+InvalidIncludeParameterErrorBundle:
   summary: Bad request include param invalid
   description: 400 error response bundle for an invalid include parameter
   value:
     resourceType: "OperationOutcome"
     issue:
-      - severity: error
-        code: invalid
-        diagnostics: "Invalid request with error - _include parameter is invalid."
+      - code: invalid
         details:
           coding:
             - system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
               version: "1"
               code: "INVALID_VALUE"
               display: "Required parameter(s) are invalid."
-
+        severity: error
+    diagnostics: "Invalid request with error - _include parameter is invalid."
diff --git a/specification/examples/responses/errors/invalidated-resource.yaml b/specification/examples/responses/errors/invalidated-resource.yaml
@@ -1,14 +1,14 @@
-NotFoundBundle:
-  summary: Bad request not found
-  description: 400 error response bundle for record not found
+InvalidatedResourceErrorBundle:
+  summary:  Invalidated resource
+  description: 404 error response bundle for invalidated resource
   value:
-    resourceType: "OperationOutcome"
     issue:
-      - severity: error
-        code: processing
+      - code: processing
         details:
           coding:
             - system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
               version: "1"
               code: "INVALIDATED_RESOURCE"
               display: "Resource that has been marked as invalid was requested - invalid resources cannot be retrieved"
+        severity: error
+    resourceType: "OperationOutcome"
diff --git a/specification/examples/responses/errors/missing-identifier.yaml b/specification/examples/responses/errors/missing-identifier.yaml
diff --git a/specification/validated-relationships-service-api.yaml b/specification/validated-relationships-service-api.yaml
@@ -325,10 +325,10 @@ paths:
               schema:
                 $ref: '#/components/schemas/OperationOutcome'
               examples:
-                accessDeniedError:
-                  $ref: './examples/responses/errors/access-denied.yaml#/AccessDeniedError'
-                relatedPersonInvalidIdentifierError:
-                  $ref: './examples/responses/GET_RelatedPerson/errors/invalid-identifier.yaml#/RelatedPersonInvalidIdentifierError'
+                AccessDeniedErrorBundle:
+                  $ref: './examples/responses/errors/access-denied.yaml#/AccessDeniedErrorBundle'
+                RelatedPersonInvalidIdentifierErrorBundle:
+                  $ref: './examples/responses/GET_RelatedPerson/errors/invalid-identifier.yaml#/RelatedPersonInvalidIdentifierErrorBundle'
 
         "500":
           description: Internal server error
@@ -337,8 +337,8 @@ paths:
               schema:
                 $ref: '#/components/schemas/OperationOutcome'
               examples:
-                internalServerError:
-                  $ref: './examples/responses/errors/internal-server-error.yaml#/InternalServerError'
+                InternalServerErrorBundle:
+                  $ref: './examples/responses/errors/internal-server-error.yaml#/InternalServerErrorBundle'
 
   /Consent:
     get:
@@ -443,19 +443,19 @@ paths:
                   $ref: '#/components/schemas/OperationOutcome'
                 examples:
                   accessDeniedError:
-                    $ref: './examples/responses/errors/access-denied.yaml#/AccessDeniedError'
+                    $ref: './examples/responses/errors/access-denied.yaml#/AccessDeniedErrorBundle'
                   InvalidIdentifierError:
-                    $ref: './examples/responses/errors/invalid-identifier.yaml#/InvalidIdentifierError'
+                    $ref: './examples/responses/GET_Consent/errors/invalid-identifier.yaml#/ConsentInvalidIdentifierErrorBundle'
                   InvalidIdentifierSystemBundle:
-                    $ref: './examples/responses/errors/invalid-identifier-system.yaml#/InvalidIdentifierSystemBundle'
+                    $ref: './examples/responses/GET_Consent/errors/invalid-identifier-system.yaml#/ConsentInvalidIdentifierSystemErrorBundle'
                   IdentifierMissingBundle:
-                    $ref: './examples/responses/errors/missing-identifier.yaml#/IdentifierMissingBundle'
+                    $ref: './examples/responses/GET_Consent/errors/missing-identifier.yaml#/ConsentIdentifierMissingErrorBundle'
                   NotFoundBundle:
-                    $ref: './examples/responses/errors/not-found.yaml#/NotFoundBundle'
+                    $ref: './examples/responses/errors/invalidated-resource.yaml#/InvalidatedResourceErrorBundle'
                   ConsentInvalidStatusParameterBundle:
-                    $ref: './examples/responses/GET_Consent/errors/invalid-status-parameter.yaml#/ConsentInvalidStatusParameterBundle'
+                    $ref: './examples/responses/GET_Consent/errors/invalid-status-parameter.yaml#/ConsentInvalidStatusParameterErrorBundle'
                   InvalidIncludeParameterBundle:
-                    $ref: './examples/responses/errors/invalid-include-parameter.yaml#/InvalidIncludeParameterBundle'
+                    $ref: './examples/responses/errors/invalid-include-parameter.yaml#/InvalidIncludeParameterErrorBundle'
           "500":
             description: Internal server error
             content:
@@ -464,7 +464,7 @@ paths:
                   $ref: '#/components/schemas/OperationOutcome'
                 examples:
                   internalServerError:
-                    $ref: './examples/responses/errors/internal-server-error.yaml#/InternalServerError'
+                    $ref: './examples/responses/errors/internal-server-error.yaml#/InternalServerErrorBundle'
 
 
 components:
