Release APIM-R-1.36 - 13 September 2024
Find out about the NHS e-Referral Service (e-RS) API release.
These features went live in APIM Release 1.36 (13 September 2024).
The information below was correct at the time of release.
1.0 Updated OpenAPI Specification (OAS)
The e-RS API specification is being updated to provide better information and context.
This change will:
- rename the current endpoint names for improved clarity. For example, "A005 - Retrieve referral request" will change to "Retrieve referral request (A005, FHIR STU3)"
- provide OPERATION groupings to understand how endpoints relate to each other. This will help you determine which endpoints are useful and which use cases they support
2.0 Retrieve referral worklist
This update makes a change to the referrer worklist endpoint: Retrieve referral worklist (A008).
The change will allow partners to retrieve the 'Referrals for Review' worklist via the application-restricted access mode.
There are some caveats with this security pattern. The service filter is mandatory, and you must restrict worklist retrieval to two times a day.
If this does not meet your requirements, please contact us to discuss your use case.
3.0 Retrieve healthcare service information
This update makes changes to the healthcare service endpoints. This includes:
- Retrieve healthcare service (A033)
- Search for healthcare services (A035)
- Retrieve healthcare service version (A037)
The change will allow partners to search and retrieve healthcare service information via the application-restricted access mode.
This functionality will allow partner systems to retrieve information without user intervention. Allowing users to view service information they need to carry out their roles.
4.0 Correct pathway start date when creating a referral
This feature makes changes to the create referral endpoint: Create referral (A011)
The change will allow partners to provide an optional, alternative pathway start date. This means that where a referral pathway started before the creation of an e-RS referral, an accurate pathway start date can now be recorded.
The new functionality is in direct response to users’ needs. With an aim to reduce the manual burden on admin teams to correct Referral To Treatment (RTT) information.
If you intend to use this function, you must seek approval from the NHS England National Elective Care team. They will ensure the RTT date is being calculated in line with National RTT rules.
You can contact the Elective Care team on [email protected].
Please note, the Elective Care team have an SLA of 20 days for these requests.
Last edited: 3 October 2024 10:25 am