[ERSSUP-73552]-[DW]-[Update doc around app-restricted for various endpoints]-[AST]

Author: adamtallentire-nhsd

specification/components/r4/schemas/endpoints/a033-retrieve-healthcare-service.yaml

@@ -9,9 +9,14 @@ description: |
   You can use this endpoint to obtain the current version and attributes of a single service.
 
   ## Supported security patterns
+  - Application-restricted, unattended access
   - Healthcare worker, user-restricted access
 
   ## Pre-requisites
+  ### Application-restricted access
+  In order to use this endpoint you must be an authenticated e-RS calling application, working in the context of a Referring Organisation.
+  
+  ### Healthcare worker, user-restricted access
   In order to use this endpoint you must be an authenticated e-RS user and use one of the following e-RS roles:
     - `REFERRING_CLINICIAN`
     - `REFERRING_CLINICIAN_ADMIN`
@@ -44,8 +49,8 @@ tags:
 parameters:
   - $ref: '../headers/request/BearerAuthorization.yaml'
   - $ref: '../pathParameters/ServiceId.yaml'
-  - $ref: '../headers/request/OdsCode.yaml'
-  - $ref: '../headers/request/BusinessFunction.yaml'
+  - $ref: '../headers/request/OdsCodeOnlyUserRestricted.yaml'
+  - $ref: '../headers/request/BusinessFunctionOnlyUserRestricted.yaml'
   - $ref: '../headers/request/CorrelationID.yaml'
 responses:
   '200':

specification/components/r4/schemas/endpoints/a035-search-for-healthcare-services.yaml

@@ -8,9 +8,14 @@ description: |
   You can use this endpoint to obtain a set of services (up to 20) and their associated attributes, in a single call. 
 
   ## Supported security patterns
+  - Application-restricted, unattended access
   - Healthcare worker, user-restricted access
 
   ## Pre-requisites
+  ### Application-restricted access
+  In order to use this endpoint you must be an authenticated e-RS calling application, working in the context of a Referring Organisation.
+  
+  ### Healthcare worker, user-restricted access
   In order to use this endpoint you must be an authenticated e-RS user and use one of the following e-RS roles:
     - `REFERRING_CLINICIAN`
     - `REFERRING_CLINICIAN_ADMIN`
@@ -44,8 +49,8 @@ tags:
   - Retrieve healthcare service information
 parameters:
   - $ref: '../headers/request/BearerAuthorization.yaml'
-  - $ref: '../headers/request/OdsCode.yaml'
-  - $ref: '../headers/request/BusinessFunction.yaml'
+  - $ref: '../headers/request/OdsCodeOnlyUserRestricted.yaml'
+  - $ref: '../headers/request/BusinessFunctionOnlyUserRestricted.yaml'
   - $ref: '../headers/request/CorrelationID.yaml'
   - in: query
     name: _id

specification/components/r4/schemas/endpoints/a037-retrieve-healthcare-service-version.yaml

@@ -8,9 +8,14 @@ description: |
   You can use this endpoint to obtain the current service's "version" held in e-RS, in order to compare to a locally cached version. 
 
   ## Supported security patterns
+  - Application-restricted, unattended access
   - Healthcare worker, user-restricted access
 
   ## Pre-requisites
+  ### Application-restricted access
+  In order to use this endpoint you must be an authenticated e-RS calling application, working in the context of a Referring Organisation.
+  
+  ### Healthcare worker, user-restricted access
   In order to use this endpoint you must be an authenticated e-RS user and use one of the following e-RS roles:
     - `REFERRING_CLINICIAN`
     - `REFERRING_CLINICIAN_ADMIN`
@@ -43,8 +48,8 @@ tags:
 parameters:
   - $ref: '../headers/request/BearerAuthorization.yaml'
   - $ref: '../pathParameters/ServiceId.yaml'
-  - $ref: '../headers/request/OdsCode.yaml'
-  - $ref: '../headers/request/BusinessFunction.yaml'
+  - $ref: '../headers/request/OdsCodeOnlyUserRestricted.yaml'
+  - $ref: '../headers/request/BusinessFunctionOnlyUserRestricted.yaml'
   - $ref: '../headers/request/CorrelationID.yaml'
 responses:
   '200':

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

@@ -0,0 +1,22 @@
+in: header
+name: NHSD-eRS-Business-Function
+description: | 
+  The e-RS Business Function of the caller.
+  
+  Not allowed for application-restricted access.
+  
+  Required for user-restricted access.
+schema:
+  type: string
+  enum:
+    - 'REFERRING_CLINICIAN'
+    - 'REFERRING_CLINICIAN_ADMIN'
+    - 'REFERRING_ADMIN'
+    - 'COMMISSIONER'
+    - 'SERVICE_PROVIDER_CLINICIAN_ADMIN'
+    - 'SERVICE_PROVIDER_CLINICIAN'
+    - 'SERVICE_PROVIDER_ADMIN'
+    - 'INFORMATION_ANALYST'
+    - 'BOOKING_MANAGER'
+    - 'ADDITIONAL_REQUIREMENTS_MANAGER'
+  example: 'SERVICE_PROVIDER_CLINICIAN_ADMIN'

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

@@ -0,0 +1,12 @@
+in: header
+name: NHSD-End-User-Organisation-ODS
+description: | 
+  The ODS code of the caller's Organisation.
+  
+  Not allowed for application-restricted access.
+  
+  Required for user-restricted access.
+schema:
+  type: string
+  example: 'R69'
+  

specification/components/stu3/schemas/endpoints/a004-retrieve-reference-data.yaml

@@ -10,7 +10,7 @@ description: |
 
   ## Pre-requisites
   ### Application-restricted access 
-  In order to use this endpoint you must be an authenticated e-RS calling application.
+  In order to use this endpoint you must be an authenticated e-RS calling application, working in the context of a Service Provider or Referring Organisation.
 
   ### Healthcare worker, user-restricted access
   In order to use this endpoint you must be an authenticated e-RS user and use one of the following e-RS roles:

specification/components/stu3/schemas/endpoints/a005-retrieve-referral-request.yaml

@@ -38,7 +38,7 @@ description: |
 
   ## Pre-requisites
   ### Application-restricted access
-  In order to use this endpoint you must be an authenticated e-RS calling application.
+  In order to use this endpoint you must be an authenticated e-RS calling application, working in the context of a Service Provider Organisation.
 
   ### Healthcare worker, user-restricted access
   In order to use this endpoint you must be an authenticated e-RS user or application and use one of the following e-RS roles:

specification/components/stu3/schemas/endpoints/a006-retrieve-attachment.yaml

@@ -12,7 +12,7 @@ description: |
 
   ## Pre-requisites
   ### Application-restricted access
-  In order to use this endpoint you must be an authenticated e-RS calling application.
+  In order to use this endpoint you must be an authenticated e-RS calling application, working in the context of a Service Provider Organisation.
 
   ### Healthcare worker, user-restricted access
   In order to use this endpoint you must be an authenticated e-RS user or application and use one of the following e-RS roles:

specification/components/stu3/schemas/endpoints/a007-retrieve-clinical-information.yaml

@@ -11,7 +11,7 @@ description: |
 
   ## Pre-requisites
   ### Application-restricted access 
-  In order to use this endpoint you must be an authenticated e-RS calling application.
+  In order to use this endpoint you must be an authenticated e-RS calling application, working in the context of a Service Provider Organisation.
 
   ### Healthcare worker, user-restricted access
   In order to use this endpoint you must be an authenticated e-RS user and use one of the following e-RS roles:

specification/components/stu3/schemas/endpoints/a024-retrieve-advice-and-guidance.yaml

@@ -19,7 +19,7 @@ description: |
    
   ## Application-restricted access
 
-  In order to use this endpoint you must be an authenticated e-RS calling application.
+  In order to use this endpoint you must be an authenticated e-RS calling application, working in the context of a Service Provider Organisation.
 
   ## Healthcare worker, user-restricted access