Skip to main content

Format of the binary file ID

Find out about upcoming changes to the binary file ID and its impact to the NHS e-Referral Service API.

This feature went live in e-RS Release 14.2 (Friday 14 June 2024).

The information below was correct at the time of release.


Background

We are changing the way we represent the binary ID for uploaded and maintained attachments in eRS.

This new approach will create a more secure reference for the ID of clinical referral attachments.

This change was previously communicated as part of the file attachments work. No issues were raised as part of the engagement we carried out with partners.


Format of the binary file ID

What we are doing and why

New files uploaded to e-RS (using A020 - Upload file to document store) will be assigned an ID in the form of a UUID.

The binary IDs of existing files, those created before the changes go live, will not be affected.

Binary files will continue to be retrievable using A006 - Retrieve attachment using the ID assigned when created.

Other e-RS resources that refer to binary files, such as DocumentReference, will continue to reference them using the ID assigned when created. Their ID will not change.

What this means for your solution

Binary IDs may now be up to 36 characters. Partner systems must ensure this will not impact them.

The ID format is private to e-RS and partners should not make any assumptions about how it is generated or its internal form.

The existing requirement to link uploaded files to a request within 24 hours of upload will still exist.

What this means for your end users

As this is an internal ID it is not expected to have any impact to end users, assuming that partner products can accommodate this change.

Examples

Action URL returned when uploaded URL when referenced URL for retrieval
EXISTING Binary/att-70000-70000 Binary/att-70000-70000 Binary/att-70000-70000
NEW Binary/2512de67-9169-46fa-b794-07dc15ad9aa7 Binary/2512de67-9169-46fa-b794-07dc15ad9aa7 Binary/2512de67-9169-46fa-b794-07dc15ad9aa7

What you need to do

In readiness for delivery of these changes, partners should:

Checklist
  • Ensure the change to the binary file ID won’t be an issue with your software solution

Contact us

If you need further information, please contact us at [email protected]

Last edited: 8 July 2024 11:41 am