Directory of Services - Urgent and Emergency Care - SOAP API

Use this API to access Directory of Services (DoS) information on a wide range of health and care services across England. 

You can search for services based on a combination of parameters: 

• find an appropriate list of services for a specific clinical need
• get technical endpoint information for a given service, using a service ID or ODS code
• obtain capacity information for specified hospitals or wards, using a service ID or ODS code

This service is widely used in an Urgent and Emergency Care context using NHS Pathways outcomes. For example, NHS 111 use it to find a service in real-time with the capacity to help a patient with given symptoms, within range of a given location.

You need a valid DoS account to use this API.

This API can only be used where there is a legal basis to do so. Make sure you complete an access request form before you go too far with your development. See our acceptable use policy for more details.

You must have made this request before you can go live (see 'Onboarding' below).

The following APIs are related to this one:

• Directory of Services - Urgent and Emergency Care - REST API - use this REST API to access information on a wide range of health and care services across England
• EPS Directory of Services - REST API - use this to access information about dispensing services, including searching for dispensers who can provide services for a patient with a given location and urgency
• Electronic Transmission of Prescriptions Web Services - SOAP API - use this to access EPS dispenser (and dispensing appliance contractor) information for a patient via NHS UK Web Services
• e-Referral Services - A010 Patient service search endpoint - use this endpoint to find services that meet the referral needs of a patient
• NHS UK service search - use this to search for services by organisation, or organisation type

This API is in production.

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

For more details, see service levels.

This API is a SOAP API. 

For more details, see Basic SOAP.

We also have a Directory of Services - Urgent and Emergency Care - REST API available.

This API is available on the internet and, indirectly, on the Health and Social Care Network (HSCN).

For more details, see Network access for APIs.

You need a valid DoS account to use this API.

This API uses HTTP basic authentication. We use authentication to track API usage and to control which information is returned to a search.

HTTP basic authentication is built in to all HTTP clients and requires the Authorization request header with the DoS username and password colon delimited and base64 encoded.

For details of testing and production (live) environments, see Environments Overview.

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

As part of onboarding, you must submit an access request and email it to the DoS live service team, see Request for access to NHS Digital urgent and emergency Care DoS.

Requests are subject to an application process including review by the DoS Steering Group.

For a full list of interactions, see the DoS SOAP API version 1.5.