updates to initial modelling

Author: francisco-videira-nhs

sandbox/src/routes/r4/retrieveBinary.js

@@ -2,7 +2,7 @@ const businessFunctionValidator = require('../../services/businessFunctionValida
 
 module.exports = [
   /**
-   * Sandbox implementation for retrieveBinary A039 (R4) endpoint
+   * Sandbox implementation for retrieveBinary A042 (R4) endpoint
    */
   {
     method: 'GET',

specification/components/r4/schemas/endpoints/a042-request-pre-signed-url-for-file-download.yaml

@@ -2,14 +2,16 @@ security:
   - bearerAuth: []
 description: |
   ### TODO Add later
-summary: A042 - Request pre-signed URL to download file from document store
+summary: Request pre-signed URL to download file from document store (A042, FHIR R4)
 operationId: a042-request-pre-signed-url-for-file-download
+tags:
+  - Retrieve clinical information
 parameters:
   - $ref: '../headers/request/BearerAuthorization.yaml'
-  - $ref: '../headers/request/BusinessFunction.yaml'
   - $ref: '../headers/request/CorrelationID.yaml'
-  - $ref: '../headers/request/OdsCode.yaml'
-  - $ref: '../headers/request/OnBehalfOfUserID.yaml'
+  - $ref: '../headers/request/BusinessFunctionOnlyUserRestricted.yaml'
+  - $ref: '../headers/request/OdsCodeOnlyUserRestricted.yaml'
+  - $ref: '../headers/request/OnBehalfOfUserIDOnlyUserRestricted.yaml'
   - $ref: '../pathParameters/AttachmentUuid.yaml'
 responses:
   '307':
@@ -19,10 +21,10 @@ responses:
   '401':
     $ref: '../responses/Unauthorized.yaml'
   '403':
-    $ref: '../responses/Forbidden.yaml'
+    $ref: '../responses/ForbiddenOrNoLR.yaml'
   '404':
     $ref: '../responses/NotFound.yaml'
   '429':
     $ref: '../responses/TooManyRequests.yaml'
   '500':
-    $ref: '../responses/InternalServerError.yaml'
+    $ref: '../responses/InternalServerError.yaml'

specification/components/r4/schemas/headers/request/OnBehalfOfUserIDOnlyUserRestricted.yaml

@@ -0,0 +1,17 @@
+in: header
+name: NHSD-eRS-On-Behalf-Of-User-ID
+description: | 
+  The (SDS) user ID of the user that the authenticating user wishes to act on behalf of (OBO). 
+
+  "On behalf of" is only supported for a Service Provider Clinician Admin (SPCA) acting on behalf of a Service Provider Clinician (SPC). 
+
+  Where an OBO User ID is supplied the authenticating user must be an SPCA and the OBO User ID must be that of an appropriate SPC.
+
+  Not allowed for application-restricted access.
+
+  Required for user-restricted access where the Service Provider Clinician Admin Business Function is used for authentication.
+required: false
+schema:
+  type: string
+  example: '021600556514'
+  

specification/components/r4/schemas/pathParameters/AttachmentUuid.yaml

@@ -1,8 +1,14 @@
 in: path
 name: id
 description: | 
-  Reference for an attachment, as provided in the response from [[HYPERLINK_A039]].
+  The identifier for the attachment.
 required: true
 schema:
   type: string
-  example: '704c3791-0873-45e9-9a04-b51996f8d93f'
+examples:
+  uuid-format:
+    value: 'c5d2d200-7613-4a69-9c5f-1bb68e04b8d8'
+    summary: ID of an attachment utilising UUID ID format.
+  legacy-format:
+    value: 'att-70000-70001'
+    summary: ID of an attachment utilising the legacy ID format.

specification/components/r4/schemas/responses/retrieveBinary/307Response.yaml

@@ -5,8 +5,8 @@ headers:
   x-request-id:
     $ref: '../../headers/response/RequestID.yaml'
   Location:
-    description: The large file attachment location in the Object Store.
+    description: The attachment location in the object store.
     required: true
     schema:
       type: string
-      example: '<ObjectStoreURL>'
+      example: 'TODO Do we want to provide an example?'

specification/components/r4/schemas/responses/retrieveBinary/400Response.yaml

@@ -2,9 +2,9 @@ description: |
   Where status code 400 (Bad Request) is returned then an [NHSDigital-OperationOutcome](https://fhir.nhs.uk/StructureDefinition/NHSDigital-OperationOutcome) will be included in the body, as detailed below.
   Check diagnostics property for specific information regarding the error.
   
-  | issue.details.coding.code | issue.code   | Description                                           |
-  | ------------------------- | ------------ | ----------------------------------------------------- |
-  | REC_BAD_REQUEST           | required     | TODO:63315          |
+  | issue.details.coding.code | issue.code | Coding System                                                      | Description                                                                                                                                                                                          |
+  | ------------------------- | ---------- | ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+  | REC_BAD_REQUEST           | invalid    | [BaRS Error Code](https://fhir.nhs.uk/CodeSystem/http-error-codes) | The request could not be processed due to an error. This could be due to either an error with the request or the state of the resource requested. See the diagnostics field for further information. |
 headers:
   x-correlation-id:
     $ref: '../../headers/response/CorrelationID.yaml'