We have detected that you are using Internet Explorer to visit this website. Internet Explorer is now being phased out by Microsoft. As a result, NHS Digital no longer supports any version of Internet Explorer for our web-based products, as it involves considerable extra effort and expense, which cannot be justified from public funds. Some features on this site will not work. You should use a modern browser such as Edge, Chrome, Firefox, or Safari. If you have difficulty installing or accessing a different browser, contact your IT support team.
Demographics Batch Service API
Submit a file of patient information to the Spine for tracing against the Personal Demographics Service (PDS).
Use this API to submit a file of patient information to the Spine for tracing against the Personal Demographics Service (PDS) for direct care purposes.
The service is provided for organisations that do not want to write their own software - typically NHS trusts or local authorities.
It returns a limited set of PDS data items, as for PDS SMSP.
- install a DBS client in a secure location, for example in a server room not a desktop PC
- complete the DBS End Point Registration form (XLS, 67.5kB) and submit it to the DBS Implementation Team at firstname.lastname@example.org. You should receive endpoint information within 7 days.
- submit a test file to DBS to confirm connectivity over Secure FTP
- use the DBS client to submit batch trace requests and receive batch responses to them
DBS requires a secure network connection. It is an offline service so does not require smartcards.
This API is stable.
DBS accepts fixed length text files or comma separated variable (CSV) files via the DBS client.
The DBS client is a Secure File Transfer Protocol (SFTP) client that sends a specifically formatted file to the Spine which is then used to interrogate PDS. DBS notifies the DBS client user when a response is available, who can then receive the response file.
For a full list of interactions for this API, see the DBS User Guide under Additional guidance.
DBS User Guide
This is a Portable Document Format file. To request a different format, contact us.