[ERSSUP-79314]-[]-[Update missing changes for Pathway start date - ERSSUP-76409]-[DMW]

Author: nhsd-david-wass

scripts/populate_placeholders.py

@@ -57,6 +57,8 @@ def main():
         "[[HYPERLINK_CIS_AUTH_SHORT]]": "[CIS2](https://digital.nhs.uk/services/identity-and-access-management/nhs-care-identity-service-2/care-identity-authentication)",
         "[[HYPERLINK_CIS_AUTH_LONG]]": "[NHS Care Identity Service 2 (CIS2)](https://digital.nhs.uk/services/identity-and-access-management/nhs-care-identity-service-2/care-identity-authentication)",
         "[[HYPERLINK_SIGNED_JWT]]": "[Signed JWT](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication)",
+        "[[HYPERLINK_PATHWAY_START]]": "[here](https://digital.nhs.uk/services/e-referral-service/document-library/pathway-start)",
+        "[[HYPERLINK_RTT_RULES]]": "[national RTT rules](https://www.gov.uk/government/publications/right-to-start-consultant-led-treatment-within-18-weeks)",
     }
 
     data = sys.stdin.read()

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

@@ -9,6 +9,13 @@ description: |
   - Application-restricted access
   - Healthcare worker, user-restricted access
 
+  ## Important notes when receiving an e-Referral Pathway Start Date
+  The e-Referral Pathway Start Date is a derived value of when the Referral To Treatment (RTT) clock starts. Find out how e-RS derives the pathway start date [[HYPERLINK_PATHWAY_START]].
+  
+  If a referral was created with an alternate pathway start date, then this will be available in the referral request response.
+  
+  Service providers must always ensure the correct start date is recorded in line with [[HYPERLINK_RTT_RULES]].
+
   ## Pre-requisites
 
   The pre-requisites for this endpoint are the same as for endpoint [[HYPERLINK_A005]].

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

@@ -35,6 +35,13 @@ description: |
   ## Supported security patterns
   - Application-restricted access
   - Healthcare worker, user-restricted access
+  
+  ## Important notes when receiving an e-Referral Pathway Start Date
+  The e-Referral Pathway Start Date is a derived value of when the Referral To Treatment (RTT) clock starts. Find out how e-RS derives the pathway start date [[HYPERLINK_PATHWAY_START]].
+  
+  If a referral was created with an alternate pathway start date, then this will be available in the referral request response.
+  
+  Service providers must always ensure the correct start date is recorded in line with [[HYPERLINK_RTT_RULES]].
 
   ## Pre-requisites
   ### Application-restricted access

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

@@ -13,6 +13,21 @@ description: |
   The act of shortlisting alone will not result in a referral being sent/booked to any of the shortlisted services (even if only one service is shortlisted). 
   Use [[HYPERLINK_A016]] if there is a need to support the sending/booking of the referral into a shortlisted service.
 
+  ## Important notes when sending an e-Referral Pathway Start Date
+  The e-Referral Pathway Start Date is a derived value of when the Referral To Treatment (RTT) clock starts. Find out how e-RS derives the pathway start date [[HYPERLINK_PATHWAY_START]].
+  
+  You can supply an optional, alternate pathway start date when creating a referral.
+  
+  This may be because steps, such as reviews, take place early in your business process. Which means the clock started earlier than when the e-RS referral is created. 
+  Providing an alternate pathway start date ensures the correct date is recorded and used in other systems.
+
+  When provided, the pathway start date must be:
+    - in the past
+    - no longer than 365 days ago
+    - calculated in line with [[HYPERLINK_RTT_RULES]]
+  
+  This also overrides any e-RS derived date.
+  
   ## Pre-requisites
   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`