DoHS API guide to search identifiers and service codes

Use this guide to understand search identifiers and service codes for the Directory of Healthcare Services (DoHS) API.

You can:

• see some example searches using cURL commands

• find out how to make searches using search identifiers, such as organisation types and sub-types, and service codes

This API was previously known as the Service Search API.

The examples below use cURL commands, so you can test them using a command line interface (CLI). For more information, see Use cURL with RESTful APIs.

The use of --data-urlencode allows us to show the text before URL encoding happens, when, for example, spaces are changed to %20.

Note that all $ characters at the start of field names have been changed to their encoded type, so %24 equals $. This is due to a quirk in cURL and is not a problem if you use Postman as your test application.

For any example that includes <Your API KEY > , you need to replace it with your API key, which you can create by following the instructions in Application-restricted RESTful APIs - API key authentication.

Find all organisations that include a specific service code

This example searches for all organisations, and returns the top 10 results filtered by organisations that include the ServiceCode of EPS0001.

It returns the top 10 organisations that are EPS-enabled.

This example searches for the text FMM65 in the field ODSCode.

It filters on the service code of EPS0001 so it only returns results that include the EPS0001 service code.

It limits the number of fields returned to the following ones, as  you can see in  %24select=ODSCode,OrganisationName,Contacts,Address1,Address2,Address3,City,Postcode,OrganisationType,OrganisationSubType.

It returns the top 10 results found, in case there are duplicates.

This example searches for all organisations that match the organisation name of pharmacy2u

It filters for all organisations that include the service code of EPS0001 and the type of PHA that is classed as a DistanceSelling (internet) Pharmacy

It limits the number of fields returned to the following ones, as you can see in %24select=ODSCode,OrganisationName,Contacts,Address1,Address2,Address3,City,Postcode,OrganisationType,OrganisationSubType.

It returns the top 10 results.

The following tables show the organisation type and sub-type identifiers as well as the service codes you can use to search.

Organisation type identifiers

You can use the following organisation type identifiers to search for organisations.

Organisation sub-types

You can use the following organisation sub-type identifiers to search for organisations.

Service Codes

You can use the following service codes to search for services.