Skip to main content

Query Accredited System Information - SOAP API

Access details of accredited systems in the Spine Directory Service (SDS) using this SOAP API.

Overview

Use this API to search for details about accredited systems and the processes they support, known as interactions, in the Spine Directory Service (SDS). 

This API provides the correct system and process identifiers, enabling systems to send and respond to messages across the Spine. For example, to update a patient's demographic information or to request transfer of a patient's record when they have registered with a new GP practice.

Use this API to:

  • search for and obtain information on accredited systems such as their accredited system identifier (ASID)
  • search for information about processes such as the process identifier

For more details, see the Spine External Interface Specification (EIS) Part 5 - Spine Directory Services (SDS).

Legal use

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.

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

Related APIs

The following APIs are related to this one:

API Status

This API is stable.

Technology

This API is accessed via a SOAP web service. 

For more details, see Basic SOAP.

Network access

You can access this API via:

For more details, see Network access for APIs.

Security and authorisation

For details, see part 5 of the Spine External Interface Specification.

Testing

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

Onboarding

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

As part of onboarding, this API uses the Common Assurance Process (CAP), which is tailored for each NHS service. For more details, contact us.

Interactions

For details of interactions for this API, see part 5 of the Spine External Interface Specification.

Last edited: 9 March 2021 9:35 am