Merge pull request #1432 from NHSDigital/release_1_30/ERSSUP-73795

[ERSSUP-73795]-[]-[RM35 MIxed Shortlist Fixes]-[DMW]

Author: nhsd-david-wass

specification/components/stu3/schemas/endpoints/a011-create-referral.yaml

@@ -31,7 +31,7 @@ description: |
 
   ## Related endpoints
 
-  To allow the patient to book their appointment in their own time, you can generate a letter for the patient by 
+  To allow the patient to progress their referral in their own time, you can generate a letter for the patient by 
   using [[HYPERLINK_A019]]. The letter summarises the current state of the referral and any steps the 
   patient may need to follow (e.g. appointment booking instructions).
 
@@ -93,4 +93,4 @@ responses:
   '429':
     $ref: '../responses/TooManyRequests.yaml'
   '500':
-    $ref: '../responses/InternalServerError.yaml'
+    $ref: '../responses/InternalServerError.yaml'

specification/components/stu3/schemas/endpoints/a016-book-or-defer-appointment.yaml

@@ -14,7 +14,7 @@ description: |
     - `REFERRING_CLINICIAN`
     - `REFERRING_CLINICIAN_ADMIN`
 
-  You need to check if the service is directly bookable, indirectly bookable, or triage by either using [[HYPERLINK_A033]] or [[HYPERLINK_A035]].You can then offer the appropriate actions to authenticated users, i.e. the ability to book an appointment into a directly bookable service if an appointment slot is available, defer the booking responsibility to a directly bookable service if no appointment slot is available, refer a patient into a triage service.
+  You need to check if the service is directly bookable, indirectly bookable, or triage by either using [[HYPERLINK_A033]] or [[HYPERLINK_A035]]. You can then offer appropriate actions to authenticated users, i.e. the ability to book an appointment into a directly bookable service if an appointment slot is available, defer the booking responsibility to a directly bookable service if no appointment slot is available, refer a patient into a triage service.
   
   If the service is directly bookable, you need to retrieve available appointment slots for the service using [[HYPERLINK_A015]].
 
@@ -30,10 +30,10 @@ description: |
   ## Use case
   As an authenticated user
 
-  I need to ba able to:
-    - Book an appointment to an available appointment slot for a a directly bookable service *or*
+  I need to be able to
+    - Book an appointment into an available appointment slot for a directly bookable service *or*
     - Defer the booking responsibility to a directly bookable service if no appointment slot is available *or*
-    - Refer the patient to a triage service
+    - Refer the patient into a triage service
 
   So I can progress my patient's care at that service.
 

specification/components/stu3/schemas/endpoints/a031-change-shortlist.yaml

@@ -47,7 +47,7 @@ description: |
 
   You can book an appointment for the patient into a shortlisted directly bookable service using [[HYPERLINK_A015]] and [[HYPERLINK_A016]].
 
-  You can send the referral into a shortlisted triage service using [[HYPERLINK_A016]]
+  You can send the referral into a shortlisted triage service using [[HYPERLINK_A016]].
   
   For the referral to be processed by the service provider, you must ensure appropriate referral letter information has been added to the referral. You can add/manage referrer letter information by using [[HYPERLINK_A012]].
 
@@ -107,4 +107,4 @@ responses:
   '429':
     $ref: '../responses/TooManyRequests.yaml'
   '500':
-    $ref: '../responses/InternalServerError.yaml'
+    $ref: '../responses/InternalServerError.yaml'

specification/components/stu3/schemas/endpoints/a032-change-shortlist-and-send-for-triage.yaml

@@ -47,7 +47,7 @@ description: |
 
   You can calculate the date when the patient will need to be contacted (by the triage service) using reference data from [[HYPERLINK_A004]].
 
-summary: A032 - Change shortlist and send for triage
+summary: A032 - Change shortlist and send for triage (deprecated)
 operationId: a032-change-shortlist-and-send-for-triage
 parameters:
   - $ref: '../headers/request/BearerAuthorization.yaml'
@@ -92,4 +92,4 @@ responses:
   '429':
     $ref: '../responses/TooManyRequests.yaml'
   '500':
-    $ref: '../responses/InternalServerError.yaml'
+    $ref: '../responses/InternalServerError.yaml'

specification/components/stu3/schemas/endpoints/a038-retrieve-appointment.yaml

@@ -52,12 +52,8 @@ description: |
 
   When successfully rejecting an appointment, the rejected appointment is returned via [[HYPERLINK_A014]].
 
-  When booking or deferring an appointment, the appointment is returned via [[HYPERLINK_A016]].
+  When booking an appointment to a directly bookable service, deferring the booking responsibility to a directly bookable service, or referring a patient into a triage service, an "appointment" is returned via [[HYPERLINK_A016]].
 
-  When sending an appointment to a service to review, an appointment is firstly created via [[HYPERLINK_A011]] and then [[HYPERLINK_A016]] is used to send the appointment to a triage service.
-  
-  When changing a shortlist, firstly this needs to be done via [[HYPERLINK_A31]] and then [[HYPERLINK_A016]] will need to be used to refer the patient to a triage service, which will send an instruction to a service to review.
-  
   When successfully cancelling an appointment, to action it later, the cancelled appointment is returned via [[HYPERLINK_A022]].
 
   When converting an advice and guidance to a referral, if the referral has an appointment, it will be returned via [[HYPERLINK_A027]].
@@ -110,4 +106,4 @@ responses:
   '429':
     $ref: '../responses/TooManyRequests.yaml'
   '500':
-    $ref: '../responses/InternalServerError.yaml'
+    $ref: '../responses/InternalServerError.yaml'