NHS App web integration

An NHS App web integration involves surfacing a responsive website in the NHS App. It must follow the NHS digital service manual.

We may also require you to make updates to your user interface to align with NHS accessibility and style guidelines.

You can review the NHS App developer documentation for further information on:

• web integration process flow
• NHS App JavaScript API capability
• specific changes, such as hiding your headers and footers 

Review our step by step guide below to understand the integration process. The criteria you will need to meet and the responsibilities you will have during each stage.

The NHS App team will communicate with you by email throughout the integration process. Including how your product can move into the next stage of the integration process.

In this step, you should check you meet the eligibility criteria. If you believe you do, submit an NHS App expression of interest form. The NHS App team will then review your information and respond in 10 working days. They will give you your next steps and tell you if you can move forward into step 2 of the integration process.

Expression of interest form

If you want to integrate with the NHS App and you meet the above eligibility criteria, submit an NHS App expression of interest form.

Submission of a completed form will enable the team to take your product or service into consideration. 

Review the questions in advance to prepare your responses.

We may ask you for more information about your product following your expression of interest. This will help our team verify you meet the eligibility criteria before inviting you to a product review call. In this call we will discuss your product in more detail and you can demo your product. If the NHS App team agree your product is suitable to integrate we can then prioritise your product.

We prioritise integrations every quarter based on team capacity and our integration strategy. Once we prioritise your product we will assign you an Integration manager. They will be your key point of contact throughout your integration process.

At this point you are ready to read and sign the NHS England NDA. 

The product assessment is an assessment by the NHS App team. They review if your product meets NHS App expectations and requirements. You will complete a Solution Design document with the NHS App technical team. It contains all the technical solution requirements. You need to meet these to complete your integration. You will then work with the NHS App team to commit to a delivery plan together.

Prepare and complete the product assessment

To proceed with your product assessment you must meet all design and technical requirements. You will receive an NHS App Product Guidance document when you start step 3. This contains guidance on how to meet the design and technical requirements.

The NHS App team will review your product assessment documentation based on your demo environment. They will propose actions for areas your service does not yet meet requirements. These recommendations will be prioritised by the NHS App team. If the actions are mandatory requirements you will have to update your product to progress with your integration.

Agree delivery and implementation timelines with NHS App team

The Service Management team will schedule a call with you. Here they will take you through the NHS Service Support Guidance.

Complete the implementation approach document. This includes who you are targeting to roll out to for a limited versus full release, and your decision behind this. 

Work with the NHS App team to agree a joint commitment to your NHS App integration delivery plan.

Commit to giving the NHS App team monthly data points once your product is live.

Development and testing

Develop your integration in the NHS App environments. Complete the following steps in the NHS App Sandpit environment. Once we sign your product off in the sandpit environment, you will then repeat these steps in the Assurance of Suppliers (AOS) environment.

1. Deploy and fully develop your product in the specific environment.
2. Test your product to ensure it meets all the requirements in the integration demo checklist.
3. Present your product in a demo call to the NHS App team.
4. Action any changes required by the NHS App team and NHS App SMEs (subject matter experts). 

You will complete an incident rehearsal with the service management team. This is a walkthrough of how we would handle incidents live with you. This can include clinical or major incident scenarios.

Agree implementation plan

You meet with the NHS App implementation team to agree a deployment plan. This plan includes what users you will release to in your limited release. It also includes the rest of your users you will release to in your full release. 

Complete assurance documentation

You must fill out the supplier conformance assessment list (SCAL). The SCAL is a self-assurance document. It is where you provide evidence that you meet the NHS App integration requirements. Upload all the required documentation into the SCAL. This includes uploading the clinical safety documentation you completed. The NHS App team will review the SCAL and ask for further information as needed. They will sign off your SCAL once they agree it meets all the requirements.

Read and sign the connection agreement. This is a contract which holds you to standards once your product is live. You need to make sure you can commit to carrying out the tasks in the Connection Agreement. If you have any questions before signing, ask your integration manager.

The NHS App team then decide if your product is ready to go live. 

Complete deployment to sample users

You will start your limited release. You will follow the deployment plan we agreed.

You will carry out the limited release to a small group of your users.

Complete full deployment

You will continue your limited release until full release. Again following the deployment plan as agreed.

You will carry out this full release to the rest of your users.

The NHS App team will carry out a full release at the same time. 

You will need to provide monthly data to the NHS App team. This is so the team can track the performance of your product. It also helps the team identify any areas of improvement.

You must be able to attend annual assurance reviews with the NHSE team. The NHS App and NHS login annual assurance reviews will happen within the same review.

The NHS App Service Management team will work with you according to the agreed protocol. This will be in line with the service level agreements (SLAs). This includes handling and reporting incidents and carrying out remediations to solve them.

If you want to make any changes to your user journey within the NHS App, you must inform your Integration Manager. For minor changes to your user journey e.g. jump-off content, allow a month to work with the NHS App to make this change.

Please allow more time for significant changes, such as new functionality and additional service journeys. For this type of change, the NHS App plan ahead for the next quarter. Please provide at least three months notice. You will need to complete a product assessment and work with NHS App team to deliver this.

Your integration manager will inform you of any changes on the app that may affect your service. If you want to integrate a new functionality into the NHS App let your Integration Manager know. Your Integration Manager will inform you of the next steps.