[ERSSUP-80429]-[]-[Update documentation]-[AP]

Author: nhsd-angel-pastor

specification/components/stu3/schemas/endpoints/a012-maintain-referral-letter.yaml

@@ -17,7 +17,7 @@ description: |
   
   All new files to be associated with a referral must be uploaded first using [[HYPERLINK_A020]] and then linked to the referral using this endpoint.
 
-  ## Important information about using this endpoint
+  ## Important notes
   
   This endpoint can be used to associate attachments to a referral that has no existing referral letter attachments. 
   In this case you must upload the file first using [[HYPERLINK_A020]] and then associate it to the referral using this endpoint.
@@ -54,6 +54,11 @@ description: |
 
   Note: It is not permissible to remove *all* referral letter attachments leaving zero attachments associated. 
   There must be at least one referral letter attachment associated.
+  
+  In order to retrieve an attachment using the [[HYPERLINK_A042]] (or deprecated [[HYPERLINK_A006]]) endpoint, the attachment must be available for download. 
+  The availability status of attachments associated with a referral are returned via this endpoint as a eRS-AvailabilityStatus-1 code. 
+  
+  Further details on attachment availability status and eRS-AvailabilityStatus-1 codes can be found in the [[HYPERLINK_A005]] and [[HYPERLINK_A042]] specifications.
 
   ## Use case
   As an authenticated user

specification/components/stu3/schemas/endpoints/a013-accept-referral.yaml

@@ -12,6 +12,13 @@ description: |
     - `SERVICE_PROVIDER_CLINICIAN`
     - `SERVICE_PROVIDER_CLINICIAN_ADMIN`
   
+  ## Important notes
+  
+  In order to retrieve an attachment using the [[HYPERLINK_A042]] (or deprecated [[HYPERLINK_A006]]) endpoint, the attachment must be available for download. 
+  The availability status of attachments associated with a referral are returned via this endpoint as a eRS-AvailabilityStatus-1 code. 
+  
+  Further details on attachment availability status and eRS-AvailabilityStatus-1 codes can be found in the [[HYPERLINK_A005]] and [[HYPERLINK_A042]] specifications.  
+  
   You need to use [[HYPERLINK_A008]] to retrieve the contents of the 'Referrals For Review' worklist. [[HYPERLINK_A013]] can only be used for referrals 
   booked into bookable services, and not the referrals sent into triage services.
 

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

@@ -31,6 +31,13 @@ description: |
     - `effectiveFrom` must be in the past, and
     - `effectiveTo` must not be in the past
 
+  ## Important notes
+  
+  In order to retrieve an attachment using the [[HYPERLINK_A042]] (or deprecated [[HYPERLINK_A006]]) endpoint, the attachment must be available for download. 
+  The availability status of attachments associated with a referral are returned via this endpoint as a eRS-AvailabilityStatus-1 code. 
+  
+  Further details on attachment availability status and eRS-AvailabilityStatus-1 codes can be found in the [[HYPERLINK_A005]] and [[HYPERLINK_A042]] specifications.
+
   ## Use cases
   As an authenticated user
 

specification/components/stu3/schemas/endpoints/a022-cancel-appointment-action-later.yaml

@@ -47,6 +47,9 @@ description: |
     - When this endpoint is successfully used, an entry will be added to the service providers 'Appointments For Booking' 
       worklist for the admin team to action the task. The provider admin team will only be able to progress the referral 
       via the e-RS Professional Application user interface (e.g. shortlisting appropriate services for the patient).
+    - In order to retrieve an attachment using the [[HYPERLINK_A042]] (or deprecated [[HYPERLINK_A006]]) endpoint, the attachment must be available for download. 
+      The availability status of attachments associated with a referral are returned via this endpoint as a eRS-AvailabilityStatus-1 code.
+    - Further details on attachment availability status and eRS-AvailabilityStatus-1 codes can be found in the [[HYPERLINK_A005]] and [[HYPERLINK_A042]] specifications.
 
 summary: Cancel appointment, action later (A022, FHIR STU3)
 operationId: a022-cancel-appointment-action-later

specification/components/stu3/schemas/endpoints/a026-send-a&g-response.yaml

@@ -27,6 +27,13 @@ description: |
   You need to use [[HYPERLINK_A025]] to retrieve the conversation within an advice and guidance request.
 
   If you want to include attachments with the response, you need to use [[HYPERLINK_A020]] so they are ready to be associated with the response.
+  
+  ## Important notes
+               
+  In order to retrieve an attachment using the [[HYPERLINK_A042]] (or deprecated [[HYPERLINK_A006]]) endpoint, the attachment must be available for download.
+  The availability status of attachments associated with a referral are returned via this endpoint as a eRS-AvailabilityStatus-1 code.
+               
+  Further details on attachment availability status and eRS-AvailabilityStatus-1 codes can be found in the [[HYPERLINK_A005]] and [[HYPERLINK_A042]] specifications.
 
   ## Use case
   As an authenticated user

specification/components/stu3/schemas/endpoints/a027-convert-a&g-to-referral.yaml

@@ -44,6 +44,11 @@ description: |
   Appointments For Booking worklist for the admin team to action the task. The provider 
   admin team will currently only be able to progress the referral via the e-RS Professional 
   Application user interface (e.g. shortlisting appropriate services for the patient).
+  
+  In order to retrieve an attachment using the [[HYPERLINK_A042]] (or deprecated [[HYPERLINK_A006]]) endpoint, the attachment must be available for download. 
+  The availability status of attachments associated with a referral are returned via this endpoint as a eRS-AvailabilityStatus-1 code.
+  
+  Further details on attachment availability status and eRS-AvailabilityStatus-1 codes can be found in the [[HYPERLINK_A005]] and [[HYPERLINK_A042]] specifications.
 
   ## Related endpoints
 

specification/components/stu3/schemas/endpoints/a028-record-triage-outcome.yaml

@@ -64,6 +64,9 @@ description: |
     an entry will be added to the service providers Appointments For Booking worklist for the admin team to action the task. 
     The provider admin team will only be able to progress the referral via the e-RS Professional Application user 
     interface (e.g. shortlisting appropriate services for the patient).
+    - In order to retrieve an attachment using the [[HYPERLINK_A042]] (or deprecated [[HYPERLINK_A006]]) endpoint, the attachment must be available for download. 
+    The availability status of attachments associated with a referral are returned via this endpoint as a eRS-AvailabilityStatus-1 code.
+    - Further details on attachment availability status and eRS-AvailabilityStatus-1 codes can be found in the [[HYPERLINK_A005]] and [[HYPERLINK_A042]] specifications.
   
 summary: Record triage outcome (A028, FHIR STU3)
 operationId: a028-record-triage-outcome

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

@@ -25,6 +25,11 @@ description: |
   If you are changing services to send the patient to a triage service, the triaging service will not support additional requirements but will need to consider if the patient has any additional requirements as part of their decision for future care.
 
   You can view additional requirements on a referral via the e-RS web application or by fetching [[HYPERLINK_A005]].
+  
+  In order to retrieve an attachment using the [[HYPERLINK_A042]] (or deprecated [[HYPERLINK_A006]]) endpoint, the attachment must be available for download. 
+  The availability status of attachments associated with a referral are returned via this endpoint as a eRS-AvailabilityStatus-1 code.
+  
+  Further details on attachment availability status and eRS-AvailabilityStatus-1 codes can be found in the [[HYPERLINK_A005]] and [[HYPERLINK_A042]] specifications.
 
   ## 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:

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

@@ -32,6 +32,11 @@ description: |
   You need to use the `Unique Booking Reference Number` (UBRN) of a referral request in order to use this endpoint.
 
   You need to have found services that meet the referral needs of a patient using [[HYPERLINK_A010]].
+  
+  ## Important Notes
+  
+  In order to retrieve an attachment using the [[HYPERLINK_A042]] (or deprecated [[HYPERLINK_A006]]) endpoint, the attachment must be available for download. The availability status of attachments associated with a referral are returned via this endpoint as a eRS-AvailabilityStatus-1 code. 
+  Further details on attachment availability status and eRS-AvailabilityStatus-1 codes can be found in the [[HYPERLINK_A005]] and [[HYPERLINK_A042]] specifications.
 
   ## Use case
   As an authenticated user

specification/components/stu3/schemas/endpoints/a036-cancel-referral.yaml

@@ -57,6 +57,13 @@ description: |
 
   You need to use [[HYPERLINK_A005]] to retrieve details of the referral in order to make this clinical decision.
 
+  ## Important notes
+  
+  In order to retrieve an attachment using the [[HYPERLINK_A042]] (or deprecated [[HYPERLINK_A006]]) endpoint, the attachment must be available for download. 
+  The availability status of attachments associated with a referral are returned via this endpoint as a eRS-AvailabilityStatus-1 code.
+  
+  Further details on attachment availability status and eRS-AvailabilityStatus-1 codes can be found in the [[HYPERLINK_A005]] and [[HYPERLINK_A042]] specifications. 
+
   ## Use case
   As an authenticated user