Hi @product1,
When raising a request in the future please try to provide as much information as you can to allow us to trace your request. For example: Application ID, X-Correlation-ID, X-Request-ID, Date/Time of the request.
I think I have managed to identify a request you made that returned this error. The request was from Application ID ffa2bdd7-e46a-453b-afa1-9001a6a9812c at 04/06/2025 11:58:45.782 with X-Correlation-ID 92f6b75e-bd45-4f33-b269-6e5ae1bed60e.
This error occurs when the response payload generated by the e-RS exceeds the maximum allowed size for the NHS API Management platform.
There is a warning related to this error in the e-RS integration process overview here.
There are the following related requirements in the SCAL which provide more detail and your obligations as a connecting party:
| A008-01 | Payload Filtering | The solutions API calls MUST be filtered where possible. Filters include Location, Specialty, Service and Clinician | The API call MUST filter on specialty and/or location where possible to avoid large payloads. Provider worklists can be large and the maximum payload is set to 10mb. |
|---|---|---|---|
| A008-02 | Payload Size | The solution MUST monitor payload size. Calls over 10MB will not be returned. | The solution MUST monitor payload size to avoid breaching set limits that will lead to the information being inaccessible. The limit is 10mb (which equivalates to approximately 7500 rows). Clinical Consideration: The supplier should work with the end user to understand local worklist management and ensure contingencies are in place should the API call exceed or be close to breaching the allowed limit. |
Note that 7500 is just an estimate/guide as the number of rows that will fit into 10MBs varies per worklist (as they return different amounts of data).
As per A008-02 your solution should be monitoring response payload sizes in order to warn your users and be able to avoid hitting the limit.
The request with X-Correlation-ID 92f6b75e-bd45-4f33-b269-6e5ae1bed60e was attempting to return the Referral for Review worklist which had 19581 items on it. This resulted in a response payload of around 17.3MB.
@zubeir.tai Do you have anything to add from a business process point of view?
Regards,
Adam.
1 Like
Hi @product1 - As a general rule, it is essential that organisations monitor worklists to support effective management of referrals.
There is support available here or via our Digital Partnering team. Please reach out to us if this would be of benefit for the organisation.
Thanks,
Z.
Thanks for the response @adam.oldfield
1 Like