Library

Browse and search developer information

Get Connected

Getting Connected is simple, but there are 3 important things to know

  1. You organisation needs to be using a secure Health and Social Care Network (HSCN) Connection (this was previously N3)
  2. APIs can only be accessed using a smartcard
  3. You will need to apply for a unique End Point and some test data

If you do not have a HSCN Connection, please go to the following site to request one:

https://digital.nhs.uk/health-social-care-network/new-to-hscn/connecting-to-HSCN

If you require a smartcard, please go to the following site to find out more:

https://digital.nhs.uk/Registration-Authorities-and-Smartcards

Once you have a smartcard and a HSCN connection, you are now ready to request access to our Development Environment in order to integrate with the e-Referral Service APIs. The first thing to do is request a new End Point, unique to your organisation. You can do so by filling in the following form:

End Point Registration Form

Once you have downloaded the form, please enter the following information and return to (sa.servicedesk@nhs.net)

  1. Enter your name and contact details.
  2. In section 1, enter the FQDN (must not be the same as an existing FQDN on the organisation code) and IP.
  3. In section 2, enter the ODS code and name of your allocated testing organisation (i.e. the pack allocated by the test data team).
  4. Enter the Source IP

You will also need to generate and submit a Certificate Signing Request (CSR) to obtain an endpoint certificate for the requested FQDN, the csr must have a key length of 2048 and have the common name set to the FQDN value.

Please do specify alongside the request to the SA Service Desk the need to be allocated a ‘NHS e-RS-API Testing Pack’.

Suppliers with existing smartcards in Spine Development can have these remotely updated with the relevant Registration Authority (RA), enabling the allocated UUIDs to be issued locally, please include your Spine Development UUID in your initial request to the SA Service Desk (sa.servicedesk@nhs.net) if this is required.

Those suppliers without existing smartcards in Spine Development can be posted an RA Card for the required organisation(s) so that they can issue their allocated UUIDs locally . Please specify the requirement in your initial request to the SA Service Desk (sa.servicedesk@nhs.net) and include your Name and Postal Address.

If you have any queries about connecting to Spine Development (smartcards, endpoints, certificates, connectivity, CSRs), please contact (sa.servicedesk@nhs.net)

Once you have received a certificate from our Solutions Assurance Desk you will need to follow a few simple steps that will allow you to begin your e-Referral Service Integration journey

First, you’ll need to install ROOT and SUBCA certificates. Here’s a handy guide to get you started

Certificate Installation Guide.pdf