[ERSSUP-69334]-[AM]-[ERSSUP-67504 - Book Defer Changes]-[DMW]

Author: nhsd-david-wass

sandbox/src/mocks/stu3/bookOrDeferAppointment/requests/TriageDeferral.json

@@ -0,0 +1,48 @@
+{
+  "id": "appointment",
+  "meta": {
+    "profile": [
+      "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-Appointment-1",
+      "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Appointment-1"
+    ]
+  },
+  "language": "en",
+  "resourceType": "Appointment",
+  "status": "proposed",
+  "reason": [
+    {
+      "coding": [
+        {
+          "system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-ReviewReason-1",
+          "code": "TRIAGE"
+        }
+      ]
+    }
+  ],
+  "description": "e-Referral Appointment",
+  "incomingReferral": [
+    {
+      "reference": "ReferralRequest/000000070000/_history/6"
+    }
+  ],
+  "participant": [
+    {
+      "actor": {
+        "identifier": {
+          "system": "http://fhir.nhs.net/Id/ers-service",
+          "value": "50001"
+        }
+      },
+      "status": "accepted"
+    },
+    {
+      "actor": {
+        "identifier": {
+          "system": "http://fhir.nhs.net/Id/nhs-number",
+          "value": "9912003888"
+        }
+      },
+      "status": "accepted"
+    }
+  ]
+}

sandbox/src/mocks/stu3/bookOrDeferAppointment/responses/TriageDeferral.json

@@ -0,0 +1,51 @@
+{
+  "id": "70000",
+  "meta": {
+    "versionId": "1",
+    "profile": [
+      "https://fhir.nhs.uk/STU3/StructureDefinition/eRS-Appointment-1",
+      "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Appointment-1"
+    ]
+  },
+  "language": "en",
+  "resourceType": "Appointment",
+  "status": "proposed",
+  "reason": [
+    {
+      "coding": [
+        {
+          "system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-ReviewReason-1",
+          "code": "TRIAGE"
+        }
+      ]
+    }
+  ],
+  "description": "e-Referral Appointment",
+  "created": "2021-06-30T13:58:47.940+00:00",
+  "incomingReferral": [
+    {
+      "reference": "ReferralRequest/000000070000/_history/8"
+    }
+  ],
+  "participant": [
+    {
+      "actor": {
+        "identifier": {
+          "system": "http://fhir.nhs.net/Id/ers-service",
+          "value": "50001"
+        },
+        "display": "Cardiology Triage Service"
+      },
+      "status": "accepted"
+    },
+    {
+      "actor": {
+        "identifier": {
+          "system": "http://fhir.nhs.net/Id/nhs-number",
+          "value": "9912003888"
+        }
+      },
+      "status": "accepted"
+    }
+  ]
+}

sandbox/src/routes/stu3/services/mockResponseProvider.js

@@ -238,6 +238,7 @@ module.exports = {
     var responseMap = {
       'src/mocks/stu3/bookOrDeferAppointment/requests/MinimalBooking.json': 'stu3/bookOrDeferAppointment/responses/MinimalBooking.json',
       'src/mocks/stu3/bookOrDeferAppointment/requests/MinimalDeferral.json': 'stu3/bookOrDeferAppointment/responses/MinimalDeferral.json',
+      'src/mocks/stu3/bookOrDeferAppointment/requests/TriageDeferral.json': 'stu3/bookOrDeferAppointment/responses/TriageDeferral.json',
       'src/mocks/stu3/bookOrDeferAppointment/requests/BookingWithNamedClinician.json': 'stu3/bookOrDeferAppointment/responses/BookingWithNamedClinician.json',
       'src/mocks/stu3/bookOrDeferAppointment/requests/DeferralWithSlotReference.json': 'stu3/bookOrDeferAppointment/responses/DeferralWithSlotReference.json',
       'src/mocks/stu3/bookOrDeferAppointment/requests/DeferralBookingAttemptProblem.json': 'stu3/bookOrDeferAppointment/responses/DeferralBookingAttemptProblem.json'

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

@@ -29,7 +29,7 @@ description: |
   ## Related endpoints
   Reference data may be needed for other endpoints, for example when including Specialty and Clinic Type reference data to:
   - find services that meet the referral needs of a patient using [[HYPERLINK_A010]], and
-  - create a referral using [[HYPERLINK_A011]] or [[HYPERLINK_A021]]
+  - create a referral using [[HYPERLINK_A011]]
 
   You can use the Priority reference data to calculate when a patient can expect to be contacted by the service. 
 

specification/components/stu3/schemas/endpoints/a010-patient-service-search.yaml

@@ -22,9 +22,8 @@ description: |
   So that I can offer the patient appropriate services that meet their referral needs
 
   ## Related endpoints
-  Once you have identified appropriate services for the patient you can either:
-    - create a referral by choosing a shortlist of bookable services using [[HYPERLINK_A011]], or
-    - refer the patient directly to a triage service using [[HYPERLINK_A021]]
+  Once you have identified appropriate services for the patient you can create a referral by choosing a shortlist of bookable and/or triage services using [[HYPERLINK_A011]]. You may then subsequently be able to use [[HYPERLINK_A016]] to book an appointment to 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, or refer a patient into a triage service.
+
 summary: A010 - Patient service search
 operationId: a010-patient-service-search
 parameters:

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

@@ -2,8 +2,10 @@ security:
   - bearerAuth: []
 description: |
   ## Overview
-  Use this endpoint to book an appointment to a service if an appointment slot is available or defer booking if no appointment slot is available.
+  Use this endpoint to book an appointment to 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, or refer a patient into a triage service. 
 
+  It is not possible to book into an indirectly bookable service using this endpoint. The patient will need to contact the service provider on the telephone number provided on [[HYPERLINK_A019]].
+  
   ## Supported security patterns
   - Healthcare worker, user-restricted access
 
@@ -12,8 +14,8 @@ description: |
     - `REFERRING_CLINICIAN`
     - `REFERRING_CLINICIAN_ADMIN`
 
-  You need to check if the service is directly bookable by either using [[HYPERLINK_A033]] or [[HYPERLINK_A035]]. You can only book/defer into shortlisted services that are directly bookable currently. Note: In the future it will be possible to use this endpoint to defer into a shortlisted 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 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.
+  
   If the service is directly bookable, you need to retrieve available appointment slots for the service using [[HYPERLINK_A015]].
 
   You need to use the Unique Booking Reference Number (UBRN) of a referral request in order to use this endpoint. 
@@ -28,17 +30,18 @@ description: |
   ## Use case
   As an authenticated user
 
-  I need to either:
-    - book an appointment to an available appointment slot for a service *or*
-    - defer booking responsibility for the service to the service provider if a booking is not possible
+  I need to ba able to:
+    - Book an appointment to an available appointment slot for a 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
 
   So I can progress my patient's care at that service.
 
   ## Related endpoints
   You can generate a letter for the patient, summarising the current state of their referral and any steps 
   the patient may need to follow using [[HYPERLINK_A019]].
 
-  You can calculate the date when the patient will need to be contacted (by the service) using reference data from [[HYPERLINK_A004]].
+  Where deferring the booking responsibility to a directly bookable service, or referring the patient into a triage service, you can calculate the date when the patient can expect to be contacted (by the receiving service) using reference data from [[HYPERLINK_A004]].
 
 summary: A016 - Book or defer appointment
 operationId: a016-book-or-defer-appointment
@@ -62,6 +65,10 @@ requestBody:
           summary: Minimum deferral
           value:
             $ref: '../../examples/bookOrDeferAppointment/requests/MinimalDeferral.json'
+        triage-deferral:
+          summary: Triage deferral
+          value:
+            $ref: '../../examples/bookOrDeferAppointment/requests/TriageDeferral.json'
         booking-with-named-clinician:
           summary: Booking with named clinician
           value:
@@ -98,4 +105,4 @@ responses:
   '502':
     $ref: '../responses/bookOrDeferAppointment/502Response.yaml'      
   '504':
-    $ref: '../responses/bookOrDeferAppointment/504Response.yaml'
+    $ref: '../responses/bookOrDeferAppointment/504Response.yaml'

specification/components/stu3/schemas/endpoints/a021-create-referral-request-and-send-for-triage.yaml

@@ -1,7 +1,10 @@
+deprecated: true
 security:
   - bearerAuth: []
 description: |
   ## Overview
+  **This endpoint has now been deprecated please use [[HYPERLINK_A011]] instead.**
+  
   Use this endpoint to refer the patient directly to a triage service.
 
   Please note: this endpoint cannot be used to shortlist bookable services. In order to shortlist bookable services please use [[HYPERLINK_A011]].
@@ -36,7 +39,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: A021 - Create referral and send for triage
+summary: A021 - Create referral and send for triage (deprecated)
 operationId: a021-create-referral-request-and-send-for-triage
 parameters:
   - $ref: '../headers/request/BearerAuthorization.yaml'

specification/components/stu3/schemas/endpoints/a029-available-actions-for-user-list.yaml

@@ -41,9 +41,8 @@ description: |
 
   Below is a list of actions that could be returned by calling [[HYPERLINK_A029]]
     - Use [[HYPERLINK_A028]] to record a review outcome based on the available clinical information and attachments.
-    - Use [[HYPERLINK_A016]] to Book, or if unable, Defer, an appointment to a specific service on the current shortlist.
+    - Use [[HYPERLINK_A016]] to Book, or if unable, Defer, an appointment to a specific service on the current shortlist, or to make a triage deferral by sending an appointment to a triage service.
     - Use [[HYPERLINK_A031]] to change the shortlist of bookable services on an existing referral.
-    - Use [[HYPERLINK_A032]] to change the shortlist to a single triage service and refer the patient directly to that triage service.
 
   ## Sandbox test scenarios
 

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

@@ -1,7 +1,10 @@
+deprecated: true
 security:
   - bearerAuth: []
 description: |
   ## Overview
+  **This endpoint has now been deprecated please use [[HYPERLINK_A031]] instead.**
+  
   Use this endpoint to change the shortlist to a single triage service and refer the patient directly to that triage service.
 
   Please note: this endpoint cannot be used to shortlist bookable services. In order to shortlist bookable services on an existing referral please use [[HYPERLINK_A031]].

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

@@ -54,10 +54,10 @@ description: |
 
   When booking or deferring an appointment, the appointment is returned via [[HYPERLINK_A016]].
 
-  When sending an appointment to a service to review, an appointment is returned via [[HYPERLINK_A021]]. In this case the "appointment" is to review a referral.
-
-  When changing a shortlist and sending an instruction to a service to review, an appointment is returned via [[HYPERLINK_A032]] indicating an "appointment" to review a referral.
-
+  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]].