Written by Technical Team | Last updated 13.02.2026 | 9 minute read
The NHS e-Referral Service (e-RS) FHIR API enables seamless, paperless referrals between primary and secondary care providers across England. By leveraging the global standards of FHIR (Fast Healthcare Interoperability Resources), this API empowers healthcare systems to streamline the referral process, reduce administrative burdens, and enhance patient care through improved coordination and structured data exchange. As healthcare continues to shift toward digital-first, interoperable models, the NHS e-RS FHIR API represents a cornerstone capability for modern clinical systems.
This article explores the key features, core functionalities, technical architecture, and practical steps required to integrate with the NHS e-RS FHIR API. It also examines implementation considerations, common challenges, and the long-term benefits of adopting this nationally critical service.
Designed as a RESTful API, the e-RS FHIR API supports two versions of the FHIR standard: FHIR STU3, tailored to CareConnect profiles, and FHIR R4, aligned with the NHS England FHIR Implementation Guide. This dual-version approach allows legacy systems and newer platforms to coexist while the NHS transitions toward a unified R4-based ecosystem.
The API facilitates a wide range of referral-related operations, including the creation and management of referrals, booking and deferring appointments, exchanging advice and guidance, and retrieving referral worklists. These capabilities replace historically manual, paper-based workflows with structured, machine-readable interactions that can be automated and audited.
A key architectural principle of the e-RS API is separation of concerns. The service focuses solely on referral workflows and clinical correspondence, while other NHS services are responsible for patient demographics, identity, and broader care records. This modular approach reduces duplication, improves security, and ensures systems integrate only with the services they genuinely require.
The API supports two distinct access modes. The application-restricted mode allows unattended, read-only operations authenticated via a signed JSON Web Token (JWT). This is ideal for background services, dashboards, and reporting tools that do not require user interaction. In contrast, the healthcare worker mode provides full read-write access to all endpoints but requires the presence and strong authentication of a healthcare professional via NHS Care Identity Service 2 (CIS2).
The NHS e-Referral Service FHIR API is not just a technical integration — it is a core enabler of digital transformation across primary and secondary care. By using NHS-approved FHIR standards, CIS2 authentication, and structured referral workflows, supplier systems can deliver faster referrals, improved interoperability, and measurable reductions in administrative workload while remaining fully compliant with NHS England interoperability and information governance requirements.
The e-RS FHIR API offers a comprehensive set of features designed to support both primary and secondary care workflows, ensuring continuity of care throughout the referral lifecycle.
Primary care systems can use the API to create new referrals using structured FHIR resources, upload and manage referral letters and supporting documents, and search for appropriate services based on clinical requirements and patient needs. Service search and shortlisting capabilities allow clinicians to identify the most suitable provider quickly, improving referral quality and reducing rejections.
When appointment slots are unavailable, the API supports deferred booking, allowing referrals to be created without an immediate appointment while maintaining visibility and traceability. This flexibility is critical in managing capacity constraints across the NHS. Additionally, primary care clinicians can initiate advice and guidance requests, enabling them to seek specialist input without committing the patient to a full referral when it may not be necessary.
Secondary care providers benefit from robust referral management capabilities. Using the API, provider systems can retrieve referral worklists, access clinical information and attachments, and track referral statuses in near real time. Providers can accept, reject, or return referrals with structured feedback, reducing ambiguity and speeding up resolution times.
Advice and guidance conversations can be managed entirely through the API, supporting asynchronous communication between clinicians. This not only improves decision-making but also reduces unnecessary outpatient appointments, freeing up capacity for patients who need face-to-face care.
Importantly, the e-RS API does not provide access to patient demographic details such as name, address, or NHS number validation. These details must be retrieved via the Personal Demographic Service (PDS), ensuring that demographic data remains authoritative and centrally managed.
Access to the NHS e-RS FHIR API is tightly controlled to meet the NHS’s stringent information governance and security requirements. e-RS integration begins with selecting the appropriate access mode based on the intended use case.
The application-restricted mode is designed for scenarios where human user authentication is not feasible or necessary. Typical use cases include automated reporting, analytics, monitoring referral backlogs, or synchronising referral metadata into downstream systems. In this mode, access is limited to read-only operations such as retrieving referral worklists, appointment slot availability, and advice and guidance summaries. Authentication is performed using a signed JWT issued by the consuming application, which must be registered and approved by the NHS.
The healthcare worker mode enables full access to all API endpoints, including those that create, update, or cancel referrals and appointments. This mode requires authentication and authorisation via CIS2, ensuring that only verified healthcare professionals can perform sensitive actions. Users must authenticate at Identity Assurance Level (IAL3) and Authenticator Assurance Level (AAL2 or AAL3), reflecting the high level of trust required for clinical decision-making.
Role-based access control further restricts what individual users can do, ensuring that actions align with their professional role and organisational context. This layered security model protects patient data while enabling legitimate clinical workflows.
To support safe and effective integration, the e-RS FHIR API provides multiple environments, each serving a distinct purpose in the development lifecycle.
The sandbox environment is open-access and ideal for early exploration and proof-of-concept development. It supports a limited set of scenarios and mock data, allowing developers to familiarise themselves with endpoint behaviour, authentication flows, and FHIR resource structures without risk.
The integration environment offers a more realistic testing experience, including data persistence and end-to-end workflows. This environment is used for formal testing, including witness testing, where NHS teams observe and validate that the application behaves correctly against defined scenarios. Successful completion of integration testing is a prerequisite for progressing toward production.
An alpha environment is also available for early access to new or experimental features. While this environment allows developers to prepare for upcoming changes, it may be subject to downtime, incomplete functionality, or breaking changes and should not be used for production readiness.
Before accessing the live production environment, suppliers must complete a comprehensive onboarding process. This includes registering with the NHS e-RS Partners Service, submitting a Supplier Conformance Assessment List (SCAL), and demonstrating compliance with functional, technical, and security requirements. Witness testing confirms that the solution meets NHS standards, after which a Connection Agreement is issued and live credentials are provided.
Robust error handling is a critical aspect of any clinical integration, and the e-RS FHIR API adheres to standard HTTP semantics to communicate success and failure states clearly.
Responses in the 200 range indicate successful operations, while 400-level responses highlight client-side issues such as validation errors, missing parameters, or unauthorised access. Server-side issues are indicated by 500-level responses. Where possible, error responses include detailed diagnostics to help developers identify and resolve issues quickly.
FHIR OperationOutcome resources are commonly used to convey structured error information, aligning with international interoperability best practices. Developers are encouraged to implement comprehensive logging and monitoring to capture these responses and support rapid troubleshooting.
The NHS e-RS Partners Service provides ongoing support to developers and organisations throughout the integration journey. This includes detailed technical documentation, onboarding guidance, access to test environments, and dedicated support channels for resolving issues. Regular updates and change notifications help suppliers stay aligned with evolving requirements.
Successful integration with the e-RS FHIR API requires more than technical connectivity. Organisations should consider clinical workflow alignment, user experience, and operational resilience from the outset.
Mapping existing referral workflows to e-RS processes is essential to avoid duplicating effort or introducing inefficiencies. Systems should guide users through referral creation intuitively, ensuring that mandatory data is captured accurately and consistently.
Performance and resilience are also critical. Applications should handle intermittent failures gracefully, implement retry logic where appropriate, and ensure that referral data is not lost or duplicated. Given the clinical importance of referrals, robust audit trails and reconciliation processes are strongly recommended.
Integrating with the NHS e-RS FHIR API delivers substantial benefits across the healthcare ecosystem. For providers, it enables faster, more accurate referrals, reduces administrative overhead, and improves visibility into referral status and capacity. Clinicians benefit from better decision support and streamlined communication with colleagues across care settings.
Patients experience improved access to care, reduced delays, and greater confidence that their referral is being actively managed. Enhanced coordination between primary and secondary care ultimately leads to better outcomes and a more efficient healthcare system.
For software developers and suppliers, adherence to FHIR standards simplifies integration and future-proofs solutions against evolving NHS interoperability initiatives. Alignment with national services also enhances credibility and market readiness.
The NHS e-RS FHIR API is a vital enabler of digital transformation within the NHS, providing a robust, secure, and interoperable framework for managing referrals at scale. By supporting modern standards, flexible access modes, and comprehensive testing pathways, the API ensures that suppliers can integrate safely and effectively.
As healthcare continues to evolve toward connected, data-driven models, services like the e-RS FHIR API will play an increasingly central role in improving patient outcomes and operational efficiency. For organisations ready to invest in high-quality e-RS integration, the onboarding process offers a clear and structured path to unlocking the full potential of this nationally critical service.
Is your team looking for help with NHS e-RS integration? Click the button below.
Get in touch