Merge pull request #722 from NHSDigital/feature/ERSSUP-64419

[ERSSUP-64419]-[]-[APIM Documentation - Extension-eRS-ReferralState i…

Author: nhsd-david-wass

sandbox/src/mocks/stu3/retrieveReferralRequest/responses/WithAdditionalRequirements.json

@@ -37,6 +37,19 @@
                 "value": "R69"
             }
         },
+        {
+            "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralState-1",
+            "extension": [
+                {
+                    "url": "state",
+                    "valueCoding": {
+                    "system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-ReferralState-1",
+                    "code": "BOOKED",
+                    "display": "Booked"
+                    }
+                }
+            ]
+        },
         {
             "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-PatientAdditionalRequirement-1",
             "valueCoding": {

specification/components/stu3/schemas/eRS-ReferralRequest.yaml

@@ -60,6 +60,7 @@ properties:
       | `Extension-eRS-ReferralShortlist`          | `1..1`      |                                                                         |
       | `Extension-eRS-Commissioning-Rule-Org`     | `1..1`      |                                                                         |
       | `Extension-eRS-ReferralPriority`           | `1..1`      |                                                                         |
+      | `Extension-eRS-ReferralState`              | `1..1`      |                                                                         |
       | `Extension-eRS-Appointment`                | `0..1`      |                                                                         |
       | `Extension-eRS-ClinicalInfoFirstSubmitted` | `0..1`      |                                                                         |
       | `Extension-eRS-ClinicalInfoLastUpdated`    | `0..1`      |                                                                         |

specification/components/stu3/schemas/endpoints/a014-reject-referral.yaml

@@ -3,7 +3,7 @@ security:
 description: |
   ## Overview
   Use this endpoint, as a service provider, to reject a referral that is booked into your bookable service and awaiting review. 
-  This returns the referral to the referrer with a mandatory user comment to explain why it has been rejected.
+  This returns the referral to the referrer with a mandatory rejection reason and optional user comment to explain why it has been rejected.
 
   Consider using [[HYPERLINK_A022]] instead if you wish to ask your admin team to get the patient into the most appropriate service.
 
@@ -92,4 +92,4 @@ responses:
   '500':
     $ref: '../responses/InternalServerError.yaml' 
   '504':
-    $ref: '../responses/rejectReferral/504Response.yaml'
+    $ref: '../responses/rejectReferral/504Response.yaml'

specification/e-referrals-service-api.yaml

@@ -88,6 +88,17 @@ info:
 
     See the [[HYPERLINK_ONBOARDING]] section below for more information.
 
+    <section class="nhsd-m-emphasis-box nhsd-m-emphasis-box--important nhsd-!t-margin-bottom-6" aria-label="Important Information">
+        <div class="nhsd-a-box nhsd-a-box--border-yellow">                <div class="nhsd-m-emphasis-box__image-box">
+                    <figure class="nhsd-a-image">
+                        <picture class="nhsd-a-image__picture">
+                                    <img src="data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAyNS4xLjAsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT48c3ZnIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIGlkPSJMYXllcl8xIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCAxNDAgMTQwOyIgdmVyc2lvbj0iMS4xIiB2aWV3Qm94PSIwIDAgMTQwIDE0MCIgeD0iMHB4IiB4bWw6c3BhY2U9InByZXNlcnZlIiB5PSIwcHgiPgo8c3R5bGUgdHlwZT0idGV4dC9jc3MiPgoJLnN0MHtkaXNwbGF5Om5vbmU7fQoJLnN0MXtkaXNwbGF5OmlubGluZTtmaWxsOiMyMzFmMjA7fQoJLnN0MntmaWxsOiMyMzFmMjA7fQoJLnN0M3tmaWxsOm5vbmU7c3Ryb2tlOiMyMzFmMjA7c3Ryb2tlLXdpZHRoOjEuOTI7c3Ryb2tlLWxpbmVjYXA6cm91bmQ7c3Ryb2tlLWxpbmVqb2luOnJvdW5kO3N0cm9rZS1taXRlcmxpbWl0OjEwO30KCS5zdDR7ZmlsbDojMjMxZjIwO30KCS5zdDV7ZmlsbDojMjMxZjIwO30KCS5zdDZ7ZmlsbDpub25lO3N0cm9rZTojMjMxZjIwO3N0cm9rZS13aWR0aDo1O3N0cm9rZS1taXRlcmxpbWl0OjEwO30KPC9zdHlsZT4KPGcgY2xhc3M9InN0MCI+Cgk8cGF0aCBjbGFzcz0ic3QxIiBkPSJNNzAsNi45NWw1NCwzMS41djYzLjExbC01NCwzMS41bC01NC0zMS41VjM4LjQ1TDcwLDYuOTUgTTcwLDBMMTAsMzV2NzBsNjAsMzVsNjAtMzVWMzVMNzAsMEw3MCwweiIvPgo8L2c+CjxnPgoJPHBhdGggY2xhc3M9InN0MiIgZD0iTTEwOS44NiwzOS44NXY1NUg4NS43Yy0zLjA2LDAtNS4xNCwzLjA2LTcuMDgsNWgtMTcuNWMtMS45NC0xLjk0LTQuMDMtNS03LjA4LTVIMjkuODd2LTU1aDI1ICAgYzUuMjgsMCwxMC44MywxLjMyLDE1LDQuNzljNC4xNy0zLjQ3LDkuNzItNC43OSwxNS00Ljc5SDEwOS44NnogTTY0Ljg2LDU0Ljg1YzAtMy44OS03LjIyLTUtMTAtNWgtMTV2MzVoMTMuNzUgICBjNS42MiwwLDcuNTcsMC42OSwxMS4yNSw1VjU0Ljg1eiBNOTkuODYsNDkuODVoLTE1Yy0yLjc4LDAtMTAsMS4xMS0xMCw1djM1YzMuNjgtNC4zMSw1LjYyLTUsMTEuMjUtNWgxMy43NVY0OS44NXoiLz4KPC9nPgo8L3N2Zz4K" alt="" style="object-fit:fill">
+                        </picture>
+                    </figure>
+                </div>            <div class="nhsd-m-emphasis-box__content-box">
+                    <div data-uipath="website.contentblock.emphasis.content" class="nhsd-t-word-break"><p class="nhsd-t-body">For a non-technical overview of how to build software that deals with referrals and bookings, see&nbsp;<a onclick="logGoogleAnalyticsEvent('Link click','General','/developer/guides-and-documentation/building-healthcare-software/referrals-and-bookings');" href="https://digital.nhs.uk/developer/guides-and-documentation/building-healthcare-software/referrals-and-bookings" onkeyup="return vjsu.onKeyUp(event)" class="nhsd-a-link">Building healthcare software - referrals and bookings</a>.</p></div>            </div>
+        </div>
+    </section>
 
     ## Related APIs