Referral version added to provider worklist

From 16 December 2025 (subject to testing), we will start to return the referral version as part of the 'Referrals for Review' worklist.

Normally, partners find out about new referrals in their organisation by using the Retrieve referral worklist (A008) API endpoint. For existing referrals, partners need to keep their referral data up to date. To do this, they currently have to make extra calls to Retrieve referral request (A005) to check whether the version has changed.

Constantly checking versions through additional API calls can be costly for partner systems, especially when there are many referrals. This results in unnecessary system load and network traffic.

The Retrieve referral worklist (A008) endpoint response will now include the referral version.

This:

• is an additive change — no existing functionality is being removed or altered

• only applies to the providers’ 'Referrals for Review' worklist

The referral version (referralRequestVersion) will be added to the existing worklist item extension.

With the referral version now included in the worklist, partner systems can easily identify changes to referrals without making extra API calls.

This helps your solution stay faster, more efficient, and reduces unnecessary system load.

This is not a breaking change. However, we recommend that partners:

• ensure your software is able to accommodate the additional information
• update your processes to improve efficiency
• test your software to make sure you are not impacted

The change will be available in the INT environment from 8 December 2025 and will be released to production on 16 December 2025, subject to successful testing.

If you foresee any issues with this change, please notify us as soon as possible and no later than 26 November 2025.

For any queries or concerns, please contact us at [email protected]