Integrating services into the NHS App
Guidance for teams preparing a service for integration into the NHS App, covering web views, browser overlays and API-driven integrations
The NHS App is made up of over 60 services working together to provide a coherent experience for users. When a user navigates to an integrated service within the NHS App, these users stay inside the app experience. This connection that allows a service to exist inside the NHS App is called an integration.
This section covers the 3 integration types and the guidance you need to follow for each.
Before you start, read Integrating with the NHS App in the Get started section for an overview of how integrations work and how to get onboarded.
Integration types
| Integration type | When to use |
|---|---|
| Default browser integration | Unauthenticated, third-party information websites where you do not need to control the presentation or journey |
| Custom web view integration | Website-based NHS App journeys, NHS website journeys, and authenticated third-party journeys |
| API integration | Services that can expose structured data via a compliant API, allowing the NHS App to display it in native screens |
Work with the NHS App team to confirm the right integration type for your service before you begin adapting your content or build.
Help improve this pattern
The NHS App design system team would like to hear:
- how you have used this pattern in your service
- any feedback you have about its usage, for example accessibility or ideas for improvement
Add these comments to the 'Integrating services into the NHS App' discussion on GitHub.