[ERSSUP-81432]-[]-[Fetch Appointments for booking worklist OAS changes]-[DMW]

Author: nhsd-david-wass

specification/components/stu3/schemas/eRS-FetchWorklist-List.yaml

@@ -144,6 +144,7 @@ properties:
             | `Extension-eRS-AssessmentReturnedCancelledDna-WorklistItem` | `0..1`      | Type of worklist items depends on the worklist type requested |
             | `Extension-eRS-AwaitingBooking-WorklistItem`                | `0..1`      | Type of worklist items depends on the worklist type requested |
             | `Extension-eRS-LettersOutstanding-WorklistItem`             | `0..1`      | Type of worklist items depends on the worklist type requested |
+            | `Extension-eRS-AppointmentsForBooking-WorklistItem`         | `0..1`      | Type of worklist items depends on the worklist type requested |
           items:
             anyOf:
               - $ref: 'extensions/Extension-eRS-ReferralsforReview-WorkListItem.yaml'
@@ -153,4 +154,5 @@ properties:
               - $ref: 'extensions/Extension-eRS-AssessmentReturnedCancelledDna-WorklistItem.yaml'
               - $ref: 'extensions/Extension-eRS-AwaitingBooking-WorklistItem.yaml'
               - $ref: 'extensions/Extension-eRS-LettersOutstanding-WorklistItem.yaml'
+              - $ref: 'extensions/Extension-eRS-AppointmentsForBooking-WorklistItem.yaml'
 

specification/components/stu3/schemas/eRS-FetchWorklist-Parameters.yaml

@@ -37,6 +37,8 @@ properties:
       | `location`                        | `0..1`      |                                            | 
       | `clinicianAssignedIndicator`      | `0..1`      |                                            | 
       | `clinician`                       | `0..1`      |                                            | 
+      | `reason`                          | `0..*`      |                                            | 
+
     items:
       anyOf:
         - $ref: 'parameters/ListType.yaml'
@@ -46,3 +48,4 @@ properties:
         - $ref: 'parameters/Location.yaml'
         - $ref: 'parameters/ClinicianAssignedIndicator.yaml'
         - $ref: 'parameters/Clinician.yaml'
+        - $ref: 'parameters/BookingReasons.yaml'

specification/components/stu3/schemas/extensions/Extension-eRS-AppointmentsForBooking-WorklistItem.yaml

@@ -0,0 +1,36 @@
+title: 'Extension-eRS-AppointmentsForBooking-WorklistItem'
+type: object
+required:
+  - url
+  - extension
+properties:
+  url:
+    type: string
+    enum:
+      - 'https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AppointmentsForBooking-WorkListItem-1'
+    example: 'https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-AppointmentsForBooking-WorkListItem-1'
+  extension:
+    description: |
+      | Field                          | Cardinality | Notes                                                                                                                      |
+      | ------------------------------ | ----------- | -------------------------------------------------------------------------------------------------------------------------- |
+      | `patient`                      | `1..1`      | The patient associated with the `ReferralRequest`                                                                          |
+      | `appointmentStart`             | `0..1`      | The current appointment start time                                          |
+      | `eReferralPathwayStart`        | `1..1`      | The start time of the referral pathway                                         |
+      | `referrer`                     | `1..1`      | The `Practitioner` who initially creates the `ReferralRequest`                                                             |
+      | `priority`                     | `1..1`      | The priority associated with the `ReferralRequest`                                                                         |
+      | `service`                      | `1..1`      | The Service Name of the deferred-to Service associated with the Appointment Request.                                      |
+      | `reason`                       | `1..1`      | Reason that Appointment requires booking |
+      | `specialty`                    | `1..1`      | The speciality of the current booking                                          |
+
+    type: array
+    items:
+      anyOf:
+        - $ref: './worklists/Extension-WorklistItem-Patient.yaml'
+        - $ref: './worklists/Extension-WorklistItem-AppointmentStart.yaml'
+        - $ref: './worklists/Extension-WorklistItem-ReferralPathwayStart.yaml'
+        - $ref: './worklists/Extension-WorklistItem-Referrer.yaml'
+        - $ref: './worklists/Extension-WorklistItem-Priority.yaml'
+        - $ref: './worklists/Extension-WorklistItem-Service.yaml'
+        - $ref: './worklists/Extension-WorklistItem-BookingReason.yaml'
+        - $ref: './worklists/Extension-WorklistItem-Specialty.yaml'
+          

specification/components/stu3/schemas/extensions/worklists/Extension-WorklistItem-BookingReason.yaml

@@ -0,0 +1,45 @@
+title: reason
+type: object
+required:
+  - url
+  - valueCodeableConcept
+properties:
+  url:
+    type: string
+    enum:
+      - reason
+    example: 'reason'
+  valueCodeableConcept:
+    type: object
+    required:
+      - coding
+    properties:
+      coding:
+        type: array
+        minItems: 1
+        maxItems: 1
+        items:
+          type: object
+          required:
+            - system
+            - code
+          properties:
+            system:
+              type: string
+              enum:
+                - https://fhir.nhs.uk/STU3/CodeSystem/eRS-BookingReason-1
+              example: 'https://fhir.nhs.uk/STU3/CodeSystem/eRS-BookingReason-1'
+            code:
+              type: string
+              enum:
+                - REBOOKING
+                - CANCELLED_APPOINTMENT_ADMIN_REBOOK
+                - CANCELLED_BY_PATIENT
+                - CANCELLED_BY_PROVIDER
+                - DEFERRED_TO_PROVIDER
+                - ONWARD_REFERRAL
+                - DNA
+                - TRIAGE_TO_BE_BOOKED
+                - TRIAGE_SEE_COMMENTS
+                - TRIAGE_ANG_CONVERTED_SEE_COMMENTS
+              example: 'TRIAGE_TO_BE_BOOKED'

specification/components/stu3/schemas/parameters/BookingReasons.yaml

@@ -1,37 +1,38 @@
-- title: bookingReason
-  description: Parameter to supply a booking reason
-  type: object
-  required:
-    - name
-    - valueCoding
-  properties:
-    name:
-      type: string
-      enum:
-        - bookingReason
-      example: 'bookingReason'
-    valueCoding:
-      type: object
-      required:
-        - system
-        - code
-      properties:
-        system:
-          type: string
-          enum:
-            - https://fhir.nhs.uk/STU3/CodeSystem/eRS-BookingReason-1
-          example: https://fhir.nhs.uk/STU3/CodeSystem/eRS-BookingReason-1
-        code:
-          type: string
-          enum:
-            - REBOOKING
-            - CANCELLED_APPOINTMENT_ADMIN_REBOOK
-            - CANCELLED_BY_PATIENT
-            - CANCELLED_BY_PROVIDER
-            - DEFERRED_TO_PROVIDER
-            - ONWARD_REFERRAL
-            - DNA
-            - TRIAGE_TO_BE_BOOKED
-            - TRIAGE_SEE_COMMENTS
-            - TRIAGE_ANG_CONVERTED_SEE_COMMENTS
-          example: TRIAGE_TO_BE_BOOKED
+title: bookingReason
+description: Parameter to supply a booking reason
+type: object
+required:
+  - name
+  - valueCoding
+properties:
+  name:
+    type: string
+    enum:
+      - bookingReason
+    
+    example: 'bookingReason'
+  valueCoding:
+    type: object
+    required:
+      - system
+      - code
+    properties:
+      system:
+        type: string
+        enum:
+          - https://fhir.nhs.uk/STU3/CodeSystem/eRS-BookingReason-1
+        example: https://fhir.nhs.uk/STU3/CodeSystem/eRS-BookingReason-1
+      code:
+        type: string
+        enum: 
+          - REBOOKING
+          - CANCELLED_APPOINTMENT_ADMIN_REBOOK
+          - CANCELLED_BY_PATIENT
+          - CANCELLED_BY_PROVIDER
+          - DEFERRED_TO_PROVIDER
+          - ONWARD_REFERRAL
+          - DNA
+          - TRIAGE_TO_BE_BOOKED
+          - TRIAGE_SEE_COMMENTS
+          - TRIAGE_ANG_CONVERTED_SEE_COMMENTS
+        example: TRIAGE_TO_BE_BOOKED