Skip to main content
Table of contents

Personal Demographics Service - HL7 V3 API

Documentation

Personal Demographics Service - HL7 V3 API documentation

Description

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 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
  • 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

Legal use: this API can only be used where there is a legal basis to do so. You should make a PDS access request before you go too far with your development. You must have made this request before you can go live (see Onboarding).