Skip to content

Commit ed6aa3e

Browse files
committed
amend error codes and outcome
1 parent a75df20 commit ed6aa3e

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

  • specification/components/r4/schemas/responses/retrieveAttachment

specification/components/r4/schemas/responses/retrieveAttachment/422Response.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
description: |
2-
Where status code 422 (Unprocessable Entity) is returned then an [NHSDigital-OperationOutcome](https://fhir.nhs.uk/StructureDefinition/NHSDigital-OperationOutcome) will be included in the body, as detailed below.
2+
Where status code 422 (Unprocessable Entity) is returned then an [OperationOutcome](https://www.hl7.org/fhir/R4/operationoutcome.html) will be included in the body, as detailed below.
33
Check diagnostics property for specific information regarding the error.
44
55
| issue.details.coding.code | issue.code | Coding System | Description |
66
| ------------------------- | ---------- | ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7-
| PENDING | invalid | [BaRS Error Code](https://fhir.nhs.uk/CodeSystem/http-error-codes) | The file is being scanned and cannot be retrieved. Wait at least 5 minutes before checking its availability again. |
8-
| THREATS_FOUND | invalid | [BaRS Error Code](https://fhir.nhs.uk/CodeSystem/http-error-codes) | The file has been quarantined after detecting a threat and cannot be retrieved. Contact the organisation that uploaded the file to resolve the issue and get the information you need. Details of who uploaded the file can be retrieved via any endpoint that provides details of an attachment in the success response (via the [[HYPERLINK_A005]] or [[HYPERLINK_A024]] endpoints, for example)|
9-
| VALIDATION_FAILED | invalid | [BaRS Error Code](https://fhir.nhs.uk/CodeSystem/http-error-codes) | The file has failed validation and cannot be retrieved. Contact the organisation that uploaded the file to resolve the issue and get the information you need. Details of who uploaded a file can be retrieved via any endpoint that provides details of an attachment in the success response (via the [[HYPERLINK_A005]] or [[HYPERLINK_A024]] endpoints, for example)<br>Validation can fail because the:<ul><li>content type of the file is not supported</li><li>content type of the file does not correlate with the file extension</li><li>file provided is too large and is not supported by e-RS. Note, this indicates that the file size is larger than the system supports as a whole, not the 5MB limit associated with this endpoint</ul> |
7+
| PENDING | invalid | [eRS Error Code](https://fhir.nhs.uk/CodeSystem/ers-error-codes) | The file is being scanned and cannot be retrieved. Wait at least 5 minutes before checking its availability again. |
8+
| THREATS_FOUND | invalid | [eRS Error Code](https://fhir.nhs.uk/CodeSystem/ers-error-codes) | The file has been quarantined after detecting a threat and cannot be retrieved. Contact the organisation that uploaded the file to resolve the issue and get the information you need. Details of who uploaded the file can be retrieved via any endpoint that provides details of an attachment in the success response (via the [[HYPERLINK_A005]] or [[HYPERLINK_A024]] endpoints, for example)|
9+
| VALIDATION_FAILED | invalid | [eRS Error Code](https://fhir.nhs.uk/CodeSystem/ers-error-codes) | The file has failed validation and cannot be retrieved. Contact the organisation that uploaded the file to resolve the issue and get the information you need. Details of who uploaded a file can be retrieved via any endpoint that provides details of an attachment in the success response (via the [[HYPERLINK_A005]] or [[HYPERLINK_A024]] endpoints, for example)<br>Validation can fail because the:<ul><li>content type of the file is not supported</li><li>content type of the file does not correlate with the file extension</li><li>file provided is too large and is not supported by e-RS. Note, this indicates that the file size is larger than the system supports as a whole, not the 5MB limit associated with this endpoint</ul> |
1010
headers:
1111
x-correlation-id:
1212
$ref: '../../headers/response/CorrelationID.yaml'

0 commit comments

Comments
 (0)