diff --git a/specification/immunisation-fhir-api.yaml b/specification/immunisation-fhir-api.yaml index 2f70e685e..dd8ab74e8 100644 --- a/specification/immunisation-fhir-api.yaml +++ b/specification/immunisation-fhir-api.yaml @@ -3987,140 +3987,45 @@ components: error codes, which could be returned in the event of a fault. - | HTTP status | Error code | Description | Example + | HTTP status | Error code | Description | | | ----------- | -------------------------- | --------------------------------------------- |--------------------------------------------------------------------------------------| - | 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')"}]} | - - | 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"}]} | + | 400 | Bad Request | Invalid resourceType in body | + + | 400 | Bad Request | Invalid resourceType within contained | | 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"}]} | | 400 | Bad Request | Invalid value for a datetime (string) field e.g. occurrenceDateTime.
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."}]} | + change under diagnostics. | | 400 | Bad Request | Invalid value for a string field e.g. postalCode
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"}]} | + any string field; only the field location will change under diagnostics. | | 400 | Bad Request | Invalid value for an integer field e.g. doseNumberPositiveInt
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"}]} - | + diagnostics. | - | 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"}]} | + | 400 | Bad Request | Invalid top level element e.g. test | | 400 | Bad Request | Missing mandatory field e.g. - contained
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"}]} | - - | 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."}]} | - - | 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."}]} | - - | 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"}]} | - - | 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"}]} | + contained
Note : The error format will remain same for any mandatory field; only the field name will change under diagnostics. | + + | 401 | Unauthorized | Authorization is required for the interaction that was attempted | + + | 403 | Forbidden | The sender does not have permissions to access this resource | + + | 403 | Forbidden | The sender does not have permission for the specific operation or vaccine type | + + | 422 | Unprocessable Entity | Duplicate Identifier value | content: application/fhir+json: schema: @@ -4148,71 +4053,28 @@ components: error codes, which could be returned in the event of a fault. - | HTTP status | Error code | Description | Example + | HTTP status | Error code | Description | | | ----------- | -------------------------- | --------------------------------------------- |--------------------------------------------------------------------------------------| - | 400 | Bad Request | Search parameter - immunization.target is either missing or not in the expected format. | - {"resourceType":"OperationOutcome","id":"0f985bbd-a25e-4644-bcab-e11ac9f1cf3a","meta":{"profile":["https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome"]},"issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/Codesystem/http-error-codes","code":"INVALID"}]},"diagnostics":"Search - parameter -immunization.target must have one or more values."}]} | - - | 400 | Bad Request | Search parameter - patient.identifier is either missing or not in the expected format. | - {"resourceType":"OperationOutcome","id":"ee3ce747-95dc-40e9-be2e-404edf203444","meta":{"profile":["https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome"]},"issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/Codesystem/http-error-codes","code":"INVALID"}]},"diagnostics":"Search - parameter patient.identifier must have one value."}]} | - - | 400 | Bad Request | Invalid value for - patient.identifier | - {"resourceType":"OperationOutcome","id":"ec7f1d44-6658-42cc-bffb-af790beba382","meta":{"profile":["https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome"]},"issue":[{"severity":"error","code":"invalid","details":{"coding":[{"system":"https://fhir.nhs.uk/Codesystem/http-error-codes","code":"INVALID"}]},"diagnostics":"patient.identifier - must be in the format of \"https://fhir.nhs.uk/Id/nhs-number|{NHS - number}\" e.g. \"https://fhir.nhs.uk/Id/nhs-number|9000000009\""}]} - | + | 400 | Bad Request | Search parameter immunization.target is either missing or not in the expected format. | + + | 400 | Bad Request | Search parameterpatient.identifier is either missing or not in the expected format. | + + | 400 | Bad Request | Invalid value for patient.identifier | - | 400 | Bad Request | Invalid date.to/date.from - format | {"resourceType": "OperationOutcome", "id": - "ad3d7881-6f2e-418f-ae13-75a07d7269d7", "meta": {"profile": - ["https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome"]}, - "issue": [{"severity": "error", "code": "invalid", "details": {"coding": - [{"system": "https://fhir.nhs.uk/Codesystem/http-error-codes", "code": - "INVALID"}]}, "diagnostics": "Search parameter -date.to must be in - format: YYYY-MM-DD"}]} | - - | 400 | Bad Request | Invalid value for - "-immunization.target" | {"resourceType": "OperationOutcome", "id": - "f1753822-5667-4562-a288-1544a0b66d00", "meta": {"profile": - ["https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome"]}, - "issue": [{"severity": "error", "code": "invalid", "details": {"coding": - [{"system": "https://fhir.nhs.uk/Codesystem/http-error-codes", "code": - "INVALID"}]}, "diagnostics": "immunization-target must be one or more of - the following: 3IN1, COVID, FLU, HPV, MENACWY, MMR, MMRV, PNEUMOCOCCAL, - PERTUSSIS, RSV, SHINGLES"}]} | - - | 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."}]} | - - | 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."}]} | - - | 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"}]} | + | 400 | Bad Request | Invalid date.to/date.from format | + + | 400 | Bad Request | Invalid value for "-immunization.target" | + + | 401 | Unauthorized | Authorization is required for the interaction that was attempted | + + | 403 | Forbidden | The sender does not have permissions to access this resource | + + | 403 | Forbidden | The sender does not have permission for the specific operation or vaccine type | content: application/fhir+json: schema: @@ -4240,54 +4102,22 @@ components: error codes, which could be returned in the event of a fault. - | HTTP status | Error code | Description | Example + | HTTP status | Error code | Description | | | ----------- | -------------------------- | --------------------------------------------- |--------------------------------------------------------------------------------------| - | 400 | Bad Request | Missing immunization event - identifier (id) | {"resourceType": "OperationOutcome", "id": - "438f5c0d-f89d-46ec-b4ba-c08dc5a44ff3", "meta": {"profile": - ["https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome"]}, - "issue": [{"severity": "error", "code": "invalid", "details": {"coding": - [{"system": "https://fhir.nhs.uk/Codesystem/http-error-codes", "code": - "INVALID"}]}, "diagnostics": "the provided event ID is either missing or - not in the expected format."}]} | - - | 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."}]} | - - | 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."}]} | - - | 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"}]} | - - | 404 | Not Found | Unrecognized immunization - event identifier (id) | {"resourceType": "OperationOutcome", "id": - "5b51e331-5f9c-442f-a4c3-b5f52a1ba83e", "meta": {"profile": - ["https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome"]}, - "issue": [{"severity": "error", "code": "not-found", "details": - {"coding": [{"system": - "https://fhir.nhs.uk/Codesystem/http-error-codes", "code": - "NOT-FOUND"}]}, "diagnostics": "The requested resource was not - found."}]} | + | 400 | Bad Request | Missing immunization event identifier (id) | + + | 401 | Unauthorized | Authorization is required for the interaction that was attempted | + + | 403 | Forbidden | The sender does not have permissions to access this resource | + + | 403 | Forbidden | The sender does not have permission for the specific operation or vaccine type | + + | 404 | Not Found | Unrecognized immunization event identifier (id) | content: application/fhir+json: schema: @@ -4315,124 +4145,40 @@ components: error codes, which could be returned in the event of a fault. - | HTTP status | Error code | Description | Example + | HTTP status | Error code | Description | | | ----------- | -------------------------- | --------------------------------------------- |--------------------------------------------------------------------------------------| - | 400 | Bad Request | All validation errors & - mandatory field errors from the Record scenario | All validation errors + | 400 | Bad Request | All validation errors & mandatory field errors from the Record scenario | All validation errors & mandatory field errors from POST /Immunization | - | 400 | Bad Request | Missing id in request - parameter | {"resourceType": "OperationOutcome", "id": - "05ef00c0-18ae-4a88-93ca-9dc1b0532ea1", "meta": {"profile": - ["https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome"]}, - "issue": [{"severity": "error", "code": "invalid", "details": {"coding": - [{"system": "https://fhir.nhs.uk/Codesystem/http-error-codes", "code": - "INVALID"}]}, "diagnostics": "the provided event ID is either missing or - not in the expected format."}]} | - - | 400 | Bad Request | Missing id parameter in - request body
or
mismatch between id provided within request body - and request parameter | {"resourceType": "OperationOutcome", "id": - "ddf659ac-1a34-4ca2-b11a-77b9a8febeec", "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: The provided - immunization id:16ec10f2-afef-4c0b-9467-xxxx doesn't match with the - content of the request body"}]} | - - | 400 | Bad Request | Mismatch between identifier - value and stored event | {"resourceType": "OperationOutcome", "id": - "ac43b4a6-7ceb-4ff8-a246-d7ceacdab058", "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: identifier[0].value - doesn't match with the stored content"}]} | - - | 400 | Bad Request | Missing E-Tag (version) - header | {"resourceType": "OperationOutcome", "id": - "715d5e23-4621-4719-8902-e80faf6539fd", "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: Immunization resource - version not specified in the request headers"}]} | - - | 400 | Bad Request | Wrong version number passed - in E-Tag header
e.g. passing version no. > 1 in case of first-time - update | {"resourceType": "OperationOutcome", "id": - "7cf8b2e1-f069-4cce-9b48-5201f64a50a9", "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: The requested - immunization resource 5a64fa79-9114-49bb-97c9-d455b0276475 version is - inconsistent with the existing version."}]} | - - | 400 | Bad Request | Empty value for E-Tag header - | {"resourceType": "OperationOutcome", "id": - "6eda36fc-777a-472a-b3a3-3e1627eca980", "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: Immunization resource - version: in the request headers is invalid."}]} | - - | 400 | Bad Request | E-Tag value <= current - stored value | {"resourceType": "OperationOutcome", "id": - "06e3086a-61b5-4dfc-b0ff-10e2658268f5", "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: The requested - immunization resource 5a64fa79-9114-49bb-97c9-d455b0276475 has changed - since the last retrieve."}]} | - - | 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."}]} | - - | 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."}]} | - - | 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"}]} | - - | 404 | Not Found | Provided id not available | - {"resourceType": "OperationOutcome", "id": - "c86be3de-bcbb-4ba5-902e-9acf55187dc5", "meta": {"profile": - ["https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome"]}, - "issue": [{"severity": "error", "code": "not-found", "details": - {"coding": [{"system": - "https://fhir.nhs.uk/Codesystem/http-error-codes", "code": - "NOT-FOUND"}]}, "diagnostics": "Validation errors: The requested - immunization resource with id:16ec10f2-afef-4c0b-9467-80434a7a0e26 was - not found."}]} | + | 400 | Bad Request | Missing id in request parameter | + + | 400 | Bad Request | Missing id parameter in request body
or
mismatch between id provided within request body and request parameter | + + | 400 | Bad Request | Mismatch between identifier + value and stored event | + + | 400 | Bad Request | Missing E-Tag (version)header | + + | 400 | Bad Request | Wrong version number passed in E-Tag header
e.g. passing version no. > 1 in case of first-time update | + + | 400 | Bad Request | Empty value for E-Tag header + | + + | 400 | Bad Request | E-Tag value <= current stored value | + + | 401 | Unauthorized | Authorization is required for the interaction that was attempted | + + | 403 | Forbidden | The sender does not have permissions to access this resource | + + | 403 | Forbidden | The sender does not have permission for the specific operation or vaccine type | + + | 404 | Not Found | Provided id not available | + content: application/fhir+json: schema: @@ -4460,7 +4206,7 @@ components: error codes, which could be returned in the event of a fault. - | HTTP status | Error code | Description | Example + | HTTP status | Error code | Description | | | ----------- | -------------------------- | @@ -4468,47 +4214,15 @@ components: |--------------------------------------------------------------------------------------| | 400 | Bad Request | Missing or invalid id | - {"resourceType": "OperationOutcome", "id": - "f400ad2c-62d9-4f98-bc35-a146caf14dee", "meta": {"profile": - ["https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome"]}, - "issue": [{"severity": "error", "code": "invalid", "details": {"coding": - [{"system": "https://fhir.nhs.uk/Codesystem/http-error-codes", "code": - "INVALID"}]}, "diagnostics": "the provided event ID is either missing or - not in the expected format."}]} | - - | 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."}]} | - - | 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."}]} | - - | 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"}]} | - - | 404 | Not Found | Non existing id in query - parameter
or
Trying to deleted an already deleted record | - {"resourceType": "OperationOutcome", "id": - "f772ee3e-3baf-4934-a07a-a13f70b1a50e", "meta": {"profile": - ["https://simplifier.net/guide/UKCoreDevelopment2/ProfileUKCore-OperationOutcome"]}, - "issue": [{"severity": "error", "code": "not-found", "details": - {"coding": [{"system": - "https://fhir.nhs.uk/Codesystem/http-error-codes", "code": - "NOT-FOUND"}]}, "diagnostics": "Immunization resource does not exist. - ID: 5a64fa79-9114-49bb-97c9-xxxxxxxx"}]} | + + | 401 | Unauthorized | Authorization is required for the interaction that was attempted | + + | 403 | Forbidden | The sender does not have permissions to access this resource | + + | 403 | Forbidden | The sender does not have permission for the specific operation or vaccine type | + + | 404 | Not Found | Non existing id in query parameter
or
Trying to deleted an already deleted record | + content: application/fhir+json: schema: