Hosting Organisation Reference Data via an API is a step increase in service for all ORD consumers. Consumers are able to access the data at their convenience rather than being tied in to fixed release schedules. The data hosted within the service is updated daily directly from the ODS team and is available to all users and is accessible to any browser or REST client via the internet. Users can baseline using XML products and read updates direct from the ORD API or use the service for Ad hoc queries using the search facility documented within these pages.
The API can be called using a REST client such as Postman or by building a custom REST client.
Please note that the IP address for the API is dynamic and it is advised that firewalls are configured using the FQDN (Fully Qualified Domain Name) of the service – directory.spineservices.nhs.uk.
This Implementation Guide details the ODS ORD API, which is designed to be compatible with the Organisation Reference Data information standard (DCB0090). This API contains the full record from ODS.
Creating a baseline of organisation data
ODS ORD API Endpoints
- Organisation endpoint – return the full organisational data of a single organisation via ODS code.
- Search endpoint – search the ODS database based on several parameters, and return a summary of multiple organisations.
- Sync endpoint – returns a list of organisations that have been modified since a specific date