+ "description": "Below are examples of potential HTTP status codes and their associated error codes, which could be returned in the event of a fault.\n\n| HTTP status | Error code | Description | Example |\n| ----------- | -------------------------- | --------------------------------------------- |--------------------------------------------------------------------------------------|\n| 400 | Bad Request | Invalid resourceType in body | {\"resourceType\": \"OperationOutcome\", \"id\": \"a7dc58e7-4033-43e6-b34e-cf7ee7bbc567\", \"meta\": {\"profile\": [\"https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome\"]}, \"issue\": [{\"severity\": \"error\", \"code\": \"invariant\", \"details\": {\"coding\": [{\"system\": \"https://fhir.nhs.uk/Codesystem/http-error-codes\", \"code\": \"INVARIANT\"}]}, \"diagnostics\": \"Validation errors: This service only accepts FHIR Immunization Resources (i.e. resourceType must equal 'Immunization')\"}]} |\n| 400 | Bad Request | Invalid resourceType within contained | {\"resourceType\": \"OperationOutcome\", \"id\": \"ffda54b5-21a7-4e4c-9ca5-0a4e510d7467\", \"meta\": {\"profile\": [\"https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome\"]}, \"issue\": [{\"severity\": \"error\", \"code\": \"invariant\", \"details\": {\"coding\": [{\"system\": \"https://fhir.nhs.uk/Codesystem/http-error-codes\", \"code\": \"INVARIANT\"}]}, \"diagnostics\": \"Validation errors: contained must contain only Patient and Practitioner resources\"}]} |\n| 400 | Bad Request | Invalid status value | {\"resourceType\": \"OperationOutcome\", \"id\": \"12a9f94c-df00-4e87-aefa-2c76f9065367\", \"meta\": {\"profile\": [\"https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome\"]}, \"issue\": [{\"severity\": \"error\", \"code\": \"invariant\", \"details\": {\"coding\": [{\"system\": \"https://fhir.nhs.uk/Codesystem/http-error-codes\", \"code\": \"INVARIANT\"}]}, \"diagnostics\": \"Validation errors: status must be one of the following: completed\"}]} |\n| 400 | Bad Request | Invalid value against a (string in datetime) field e.g. occurrenceDateTime.<br>Note : The error format will remain same for any DateTime (string) field; only the field name will change under diagnostics. | {\"resourceType\": \"OperationOutcome\", \"id\": \"e02e3254-c1b3-4afd-a8ca-84091d7d272c\", \"meta\": {\"profile\": [\"https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome\"]}, \"issue\": [{\"severity\": \"error\", \"code\": \"invariant\", \"details\": {\"coding\": [{\"system\": \"https://fhir.nhs.uk/Codesystem/http-error-codes\", \"code\": \"INVARIANT\"}]}, \"diagnostics\": \"Validation errors: occurrenceDateTime must be a valid datetime in the format 'YYYY-MM-DDThh:mm:ss+zz:zz' (where time element is optional, timezone must be given if and only if time is given, and milliseconds can be optionally included after the seconds). Note that partial dates are not allowed for occurrenceDateTime for this service.\"}]} |\n| 400 | Bad Request | Invalid value against a (string) field e.g. postalCode<br>Note : The error format will remain same for any string field; only the field location will change under diagnostics. | {\"resourceType\": \"OperationOutcome\", \"id\": \"0df23485-4690-41ab-8b24-8b28584ec2eb\", \"meta\": {\"profile\": [\"https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome\"]}, \"issue\": [{\"severity\": \"error\", \"code\": \"invariant\", \"details\": {\"coding\": [{\"system\": \"https://fhir.nhs.uk/Codesystem/http-error-codes\", \"code\": \"INVARIANT\"}]}, \"diagnostics\": \"Validation errors: contained[?(@.resourceType=='Patient')].address[0].postalCode must be a non-empty string\"}]} |\n| 400 | Bad Request | Invalid value against an (integer) field e.g. doseNumberPositiveInt<br>Note : The error format will remain same for any integer field; only the field location will change under diagnostics. | {\"resourceType\": \"OperationOutcome\", \"id\": \"dda6b6cd-af06-47ea-a4d4-f0f8cdf83085\", \"meta\": {\"profile\": [\"https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome\"]}, \"issue\": [{\"severity\": \"error\", \"code\": \"invariant\", \"details\": {\"coding\": [{\"system\": \"https://fhir.nhs.uk/Codesystem/http-error-codes\", \"code\": \"INVARIANT\"}]}, \"diagnostics\": \"Validation errors: protocolApplied[0].doseNumberPositiveInt must be a positive integer\"}]} |\n| 400 | Bad Request | Invalid top level element e.g. test | {\"resourceType\": \"OperationOutcome\", \"id\": \"fd60f75c-d2cb-4c77-b3e9-ba8c3e0379e6\", \"meta\": {\"profile\": [\"https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome\"]}, \"issue\": [{\"severity\": \"error\", \"code\": \"invariant\", \"details\": {\"coding\": [{\"system\": \"https://fhir.nhs.uk/Codesystem/http-error-codes\", \"code\": \"INVARIANT\"}]}, \"diagnostics\": \"Validation errors: \"test\" is not an allowed element of the Immunization resource for this service\"}]} |\n| 400 | Bad Request | Missing mandatory field e.g. contained<br>Note : The error format will remain same for any mandatory field; only the field name will change under diagnostics. | {\"resourceType\": \"OperationOutcome\", \"id\": \"72eee803-c8bf-4728-a15b-5d9a10bb645c\", \"meta\": {\"profile\": [\"https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome\"]}, \"issue\": [{\"severity\": \"error\", \"code\": \"invariant\", \"details\": {\"coding\": [{\"system\": \"https://fhir.nhs.uk/Codesystem/http-error-codes\", \"code\": \"INVARIANT\"}]}, \"diagnostics\": \"contained is a mandatory field\"}]} |\n| 400 | Bad Request | Missing mandatory field e.g. identifier | {\"resourceType\": \"OperationOutcome\", \"id\": \"edbaf8b1-6fd1-4338-beb1-15beff084549\", \"meta\": {\"profile\": [\"https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome\"]}, \"issue\": [{\"severity\": \"error\", \"code\": \"invariant\", \"details\": {\"coding\": [{\"system\": \"https://fhir.nhs.uk/Codesystem/http-error-codes\", \"code\": \"INVARIANT\"}]}, \"diagnostics\": \"identifier is a mandatory field\"}]} |\n| 401 | Unauthorized | Authorization is required for the interaction that was attempted | {\"resourceType\":\"OperationOutcome\",\"id\":\"a5abca2a-4eda-41da-b2cc-95d48c6b791d\",\"meta\":{\"profile\":[\"https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome\"]},\"issue\":[{\"severity\":\"error\",\"code\":\"expired\",\"details\":{\"coding\":[{\"system\":\"https://fhir.nhs.uk/Codesystem/http-error-codes\",\"code\":\"SEND_UNAUTHORIZED\"}]},\"diagnostics\":\"The sender has not provided a token or it has expired or is otherwise invalid.\"}]} |\n| 403 | Forbidden | The sender does not have permissions to access this resource | {\"resourceType\":\"OperationOutcome\",\"id\":\"a5abca2a-4eda-41da-b2cc-95d48c6b791d\",\"meta\":{\"profile\":[\"https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome\"]},\"issue\":[{\"severity\":\"error\",\"code\":\"forbidden\",\"details\":{\"coding\":[{\"system\":\"https://fhir.nhs.uk/Codesystem/http-error-codes\",\"code\":\"SEND_UNAUTHORIZED\"}]},\"diagnostics\":\"The sender does not have permissions to access this resource. Please check your credentials and permissions.\"}]} |\n| 403 | Forbidden | The sender does not have permission for the specific operation or vaccine type | {\"resourceType\": \"OperationOutcome\", \"id\": \"1b7eec0a-316f-4f6e-a342-4b37f6705050\", \"meta\": {\"profile\": [\"https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome\"]}, \"issue\": [{\"severity\": \"error\", \"code\": \"forbidden\", \"details\": {\"coding\": [{\"system\": \"https://fhir.nhs.uk/Codesystem/http-error-codes\", \"code\": \"FORBIDDEN\"}]}, \"diagnostics\": \"Unauthorized request for vaccine type\"}]} |\n| 422 | Unprocessable Entity | Duplicate Identifier value | {\"resourceType\": \"OperationOutcome\", \"id\": \"b82adf54-1844-4354-a5dd-09bfc34dd569\", \"meta\": {\"profile\": [\"https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome\"]}, \"issue\": [{\"severity\": \"error\", \"code\": \"duplicate\", \"details\": {\"coding\": [{\"system\": \"https://fhir.nhs.uk/Codesystem/http-error-codes\", \"code\": \"DUPLICATE\"}]}, \"diagnostics\": \"The provided identifier: https://supplierABC/identifiers/vacc#a7437179-e86e-4855-b68e-xxxxx is duplicated\"}]} |\n",
0 commit comments