Handling e-RS A008 Worklist 10MB Payload Limits & Queue Threshold Warnings

e-Referral Service (e-RS) e-Referral Service FHIR API
1 
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). - A008 Requirement

Quick clarification on handling the 10MB (~7,500 rows) response limit on the A008 worklist API as an EPR Provider:

  1. Interactive UI Sessions - Near-limit (~8MB / 80%) - Should we display the retrieved list alongside a warning banner to filter, or block rendering until narrowed?

  2. Limit breached (>10MB gateway failure)Is prompting the user to refine their filters and retry enough?

  3. Unattended Background Sync - We a have an app restricted background job that queries the worklist, if that comes back with a response that’s nearing the limit, how would you like us to handled that given its a background job?

  4. Also do you have any recommended ways to to test this ? How do you recommend we simulate or test these oversized responses (>8MB / >10MB) in the Integration (INT) / Sandbox environment? Is there a test header, mock service ODS code, or large stub dataset available to trigger gateway size limits during validation?

TIA

Dan

2

Following this up, still looking for guidance.

3

Hi @Daniel_Shibu

Thank you for query on the NHSE API developer community and apologies for the delayed response.

The e-RS team will be the best placed to answer your query. I would suggest re-posting your query on the e-RS forum:
Latest e-Referral Service (e-RS) topics - NHS England Developer Community

Thanks,

NHS England API Platform team

Please note: The API Platform team can only address queries relevant to the NHS England API Platform, including security, rate limiting, logging, monitoring and alerting. For any API, CIS2, NHS Login specific queries, please reach out to the relevant API / Service teams.