Stage 2 - Build

Find out how to gain access to our test environment in order to start development with the NHS e-Referral Service API.

You will need to register your application in the integration test (INT) environment.

You will already have had experience of our sandbox environment.

This step will introduce you to the INT environment. It provides a more realistic setting for testing than is possible in a sandbox, including authorisation, release and assurance testing.

2.21 Integration testing

The integration environment should be used to test and assure your software in an integrated manner.

This environment is:

• where the majority of your integration efforts will take place
• where we conduct witness testing for your application  
• stateful, so data will be persisted
• representative of the production estate

To get access, please complete the integration test environment form.

After completing the form, you will be notified when you are set up in the integration environment.

2.22 Performance testing

We do not provide an environment for performance testing, in line with other NHS APIs. The INT environment has low rate limits to protect them against overuse.

If you need to performance test your integration, we recommend you build stubs to simulate our API.

To test your software in our integration environment, you will need test data.

Upon completion of registration, the e-RS partners team will provide you with a test data pack.

This will include test:

• patients
• GP surgery
• NHS trust organisation
• NHS trust site 

The test data provided here will be required to set up test referrals as outlined in the later step of 'Configure e-RS'.

In this step, you will be required to familiarise yourself with the e-RS application.

Whether you are integrating as a referrer or a provider, you will have to play both roles to configure and set up test referral data in e-RS.

Additional guidance and implementation resources can be found in our document library.

2.41 Set up test services

To start setting up referrals in the e-Referral application, you will first require test services. A service in e-RS is where a primary care referrer would send a referral for a patient to be seen. All services are created and maintained on the e-RS Directory of Services.

Follow this detailed guide for creating services in the path to live environment.

If you are intending to use directly bookable services, you will require a PAS to supply appointment slots to e-RS. The ITOC team can create these for you with a test PAS, if you do not have your own.

2.42 Set up referrals

You will need to create test referrals in order to carry out your tests.

2.51 What is the SCAL?

The SCAL is a document that asks for technical information about your software. It helps ensure your software is safe, secure and meets information governance standards.

It is an Excel spreadsheet with several tabs.

Each SCAL is unique to:

• your software
• the NHS service you are integrating with

Many sections of the SCAL can be completed in parallel to your testing.

We recommended that you familiarise yourself with the SCAL as early in the process as possible. You can access the latest SCAL as part of the design stage.

2.52 Request and review the SCAL

The SCAL document is tailored to your integrated software if:

• your product uses several NHS England APIs or services - you’ll have a single SCAL that covers them all
• you have more than one product - you need a separate SCAL for each product

To get an appropriate SCAL template for your product, request the SCAL from the e-RS Solution Assurance team at [email protected]. 

The e-RS Solution Assurance team will either create a new SCAL template for you, or find your existing SCAL, and add new tabs for the API or services you want to onboard for.

The team will also send you an assurance stages checklist to help you complete the different stages.

Please review and complete the SCAL and send an email to [email protected]  indicating when you expect to be ready for witness testing.

You now have everything you need to start developing your software. Complete the module, system, and integration testing, then proceed to the assurance stage.

Get support on integrating with our API by checking out our developer community.

You can:

• search and find answers to your query
• post your own questions
• join a community of professionals with similar objectives