Skip to main content

Part of Integration process overview

Stage 4 - Release

Current Chapter

Current chapter – Stage 4 - Release


Find out how to request access to production and go live.

What you need to do
  • Register your application
  • Generate a key pair
  • Send your AppID
  • Go live

The e-RS Partners team will help manage set up in the production (PROD) environment for your go-live. They will send you a PROD form which you will need to complete.

The main steps in live deployment are:


4.1 Register your application

You will need to register your application in the production environment. This is a separate environment to where your previous application was registered.

4.11 Sign in to your developer account

Navigate to your developer account and sign in.

4.12 Register your application

On the developer account home page, select 'Environment access' and 'Add new application' to start the new application journey.

4.13 Select your environment

Select the production (PROD) environment and your application owner.

4.14 Name your application

When naming your application, please follow the preferred guidance:

[Supplier name] - [App name] - [Environment] - e-Referral Service, [Access mode]

For example:

Care Vista - Care Vista Link - PROD - e-Referral Service, User Restricted

Acme - Acme Medical System - PROD - e-Referral Service, Application-Restricted

4.15 Add the e-Referral Service API

This step enables access to the API you have been assured for.

Select one API per application.

You will require a separate application for each access mode you intend to use. The same application cannot be used for both user-restricted and application-restricted modes.

User-restricted

For user-restricted access, enable the API below:

e-Referral Service - Healthcare Worker

User restricted

Application-restricted

For application-restricted, unattended access, enable the API below:

e-Referral Service - Application Restricted

Application Restricted

4.16 Multiple ASIDs

Your application created in the previous step will be bound to an ASID (Accredited System Identifiers) - this is a one-to-one mapping.

You will need multiple ASIDs if you're working with many end user organisations (EUO) and using both access modes.

If your integrated software uses:

  • both access modes, you will need an ASID for each access mode
  • the application-restricted access mode for both referrer and provider capability, you will need an ASID for each capability

For example, your integrated software includes: user-restricted, application-restricted (referrer) and application-restricted (provider) access modes.

Your setup would require 3 ASIDs per EUO:

  1. [Organisation Name] - [Product Name] – Prod - User-Restricted (ASID 1)

  2. [Organisation Name] - [Product Name] – Prod - Application-Restricted - Referrer (ASID 2)

  3. [Organisation Name] - [Product Name] – Prod - Application-Restricted - Provider (ASID 3)

4.17 Sharing with other NHS services

The e-RS ASID model also restricts which NHS services the ASID can be shared with.

For those NHS services on the APIM platform, the ASID cannot be shared. For example: PDS (Personal Demographics Service), EPS (Electronic Prescription Service) or SCR (Summary Care Record). You will require a separate ASID for these collective services.

Other NHS services can be shared. Such as: NEMS (National Events Management Service), CP-IS (Child Protection - Information Sharing service) or GP Connect.


4.2 Generate a key pair

To access the production environment, you will need to generate a key pair for each application and access mode:


4.3 Send your AppID

The previous step will create a new AppID for your application. Please complete the PROD form, including the new IDs, and return it to [email protected].

There are some further technical requirements for us to complete on receipt of this form. 


4.4 Go live

Once all the above activities are complete, the e-RS Partners team will email you to confirm your status. 

This completes the live deployment process and you are now live!


Contact us

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

Last edited: 26 March 2025 3:57 pm