Library

Browse and search developer information

ODS ORD API Implementation Guide

Notifications

NEW Dec18:  ODS ORD API Synchroniser Demonstrator

Introduction

The Organisation Data Service (ODS) API Suite has been developed by NHS Digital. The ODS API Suite aims to better support the delivery of care by opening up Health and Social Care Organisation Reference Data stored by the ODS. 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.

This collection of web pages provides implementation guidance for the ODS ORD API hosted at the following location:

The API can be called using a REST client such as Postman (available from https://www.getpostman.com) or by building a custom REST client.

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.

Contents

  1. Creating a baseline of organisation data
  2. 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.
  3. Search Parameters
  4. HTTP Headers

Glossary and Links

A Glossary specific to the Health & Social Care Organisation Reference Data (HSCOrgRefData) XML schema can be found within Appendix 1 of the Data Item Catalogue.

All supporting products relating to XML Organisation Data (including the XML Schema, Interactive Object Model and Technical Specification) can be found on the ODS webpages.

For technical queries regarding the ODS API Suite, or general queries regarding ODS data please contact: Exeter.helpdesk@nhs.net