Skip to main content

How to obtain organisation data via the ODS API suite

An Application Programming Interface (API) for organisation data has been developed to give data users direct access to health and social care organisation reference data. Find out how to get this data via the ODS API suite.

Published: 27 April 2018

Version: 1.1

The ODS API suite

The ODS API suite:

  • provides users with a simplified mechanism for updating organisation records
  • allows users to connect and retrieve updates at their convenience
  • gives users the choice as to whether to store the data locally or access it on demand
  • allows users to baseline the data using the XML products and connect to the service to retrieve updates via the ‘LastChangeDate’ mechanism

Current XML products will continue to be released monthly via TRUD. The ODS API Suite will be available from 1 May 2018 and will provide access to more frequent updates (weekly / daily) of organisation reference data.

The ODS API Suite includes two interfaces. The data returned by each interface is sourced from the same database which is populated from the XML HSCOrgRefData. The data returned by the different interfaces differs, as shown below.

Interface 1: ODS ORD API (Organisation Reference Data – Information Standard)

This interface:

  • is aligned to the 0090 Organisation Reference Data standard
  • allows consumers to synchronise changes into a local data store
  • allows users to baseline organisation reference data from the XML products and then connect to the API to retrieve updates on a frequency they can define

Interface 2: ODS lookup API (FHIR)

This interface:

  • allows Organisation Reference Data to be used directly by FHIR APIs
  • is based on the HL7 FHIR standard and will support transactional use cases, generally associated with clinical messaging

The data returned via this interface conforms to FHIR and does not conform with the ORD information standard.

ODS API Suite and associated implementation guidance is available.

Further information can also be found within the XML products guide, available on this website or on TRUD.

Last edited: 17 July 2019 9:30 am