Personal Demographics Service - HL7 V3 API

Use this API to access the Personal Demographics Service (PDS), the national electronic database of NHS patient details such as name, address, date of birth, related people, registered GP and NHS number.

You can:

• search for patients
• check that you have the correct NHS number for a patient
• get patient details
• create a new record for a birth
• receive birth notifications - although another option is PDS Notifications FHIR API
• create a record for a new patient (except for GPs - see below)

You should not use this API to create a new record when registering a new patient at a GP Practice. Instead, use National Health Application and Infrastructure Services (NHAIS).

You can retrieve current and historical demographic information for a patient including:

• NHS number
• name
• gender
• birth information
• address
• contact details
• registered GP
• preferred pharmacy
• consent information
• related people, such as next of kin
• death information

A healthcare worker must be present and authenticated with an NHS smartcard or a modern alternative to use this API.

Spine Mini Service Provider (SMSP) options

There are also commercially available products which give easier access to PDS, known as Spine Mini Service Providers (SMSPs).

These and other conforming software products are listed in our Conformance Catalogue.

If you are interested in becoming a provider of one of these products, see Personal Demographics Service - SMSP API standards.

This API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development.  To do this, make a PDS access request. 

You must do this before you can go live (see ‘Onboarding’ below). 

The following APIs also give access to the Personal Demographics Service:

• Personal Demographics Service - FHIR API - use this new API to search for patients, retrieve patients by NHS number and update patients

• Personal Demographics Service - SMSP API - this API is now deprecated

The following APIs are also related to this API:

• Personal Demographics Service Notifications - FHIR API - use this to subscribe to be notified of a limited set of patient record changes, such as birth, death, change of address and change of GP. If you would like to see this list expanded, tell us about your use case and vote here

• Organisation Data Service - FHIR API - use this to get full details for the organisations related to the patient, such as their registered GP or nominated pharmacy

This API is in production, but under review for deprecation. We will contact you before agreeing to a retirement date.

This API is a platinum service, meaning it is operational and supported 24 x 7 x 365.

For more details, see service levels.

This API is an HL7 V3 API. It is a mixture of:

• synchronous interactions, using HL7 V3 SOAP web services
• asynchronous interactions, using HL7 V3 ebXML messaging

The synchronous pattern is used for interactions which need an immediate response and run quickly, for example:

• PDS simple trace query
• PDS retrieval query

The asynchronous pattern is used for interactions which either do not require an immediate response or might take longer, for example:

• PDS advanced trace query (search)
• PDS general update
• PDS birth notification (outbound from PDS)

Asynchronous messages are of two types:

• unreliable - where it is OK to lose a message, such as in advanced trace (search)
• reliable - where it's not OK to lose a message, such as in updates, NHS number allocations and birth registrations

For more details, see HL7 V3.

Message Handling System (MHS) adaptor

To remove the complexity of building your own Message Handling System, we offer a pre-assured, client side MHS adaptor that you can integrate into your own infrastructure.

It makes it easier to connect to the NHS Spine and perform business operations by exposing a RESTful API that conforms to the HL7 V3 standard. 

You need a Health and Social Care Network (HSCN) connection to use this API.

For more details, see Network access for APIs.

Authentication

This API is user-restricted, meaning an end user must be present and authenticated to use it.

The end user must be:

• a healthcare worker
• strongly authenticated, using either an NHS smartcard or a modern alternative

We support the following security patterns:

• user-restricted HL7 V3 API, using NHS Care Identity Service 2 (NHS CIS2)
• user-restricted HL7 V3 API, using CIS

For more details see user-restricted APIs.

Authorisation

For some activities, the end user must be authorised to perform that activity.

The API itself does not perform any authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database.

For more details see:

• the PDS Integration Requirements document in the 'additional guidance' section below
• the RBAC guidance document in the 'additional guidance' section below
• our national Role Based Access Control (RBAC) database on the registration authorities and smartcards page

You can test this API using our Path to Live environments.

The live environments are as follows:

You must get your software onboarded before it can go live.

This API uses the Common Assurance Process (CAP) which is tailored for each NHS service.

For more details, see the PDS Common Assurance Process which explains how to get started with onboarding.

For a full list of interactions for this API, see the PDS section in the Spine Message Implementation Manual (MIM).

For details on the general structure of the interactions, see HL7 V3.