Overview

Use this endpoint to retrieve a specific version of ReferralRequest.

Supported security patterns

• Application-restricted access
• Healthcare worker, user-restricted access

Pre-requisites

The pre-requisites for this endpoint are the same as for endpoint [[HYPERLINK_A005]].

Note: e-RS only supports the retrieval of the most recent version of ReferralRequest. You cannot retrieve earlier versions.

Important notes

Attachment availability

In order to retrieve an attachment using the [[HYPERLINK_A042]] (or deprecated [[HYPERLINK_A006]]) endpoint, the attachment must be available for download. Attachments are only made available once an uploaded file has been validated and successfully malware scanned. A request to retrieve an attachment that is not available for download will result in an error being returned. See [[HYPERLINK_A042]] for more information.

The availability status of an attachment can be retrieved via any endpoint that returns an eRS-AvailabilityStatus-1 code in the success response, including [[HYPERLINK_A005]]. The eRS-AvailabilityStatus-1 code can return one of four possible values, as detailed below.

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]].

Use case

See [[HYPERLINK_A005]].

Related endpoints

See [[HYPERLINK_A005]].

Sandbox test scenarios

You can test the following scenarios in our sandbox environment