Choosing an Organisation Data Service API
Our APIs (Application Programming Interface) provide access to ODS codes and organisation information and support the delivery of healthcare.
NHS England has assumed responsibility for all activities previously undertaken by NHS Digital.
What our APIs are used for
- upload into systems
- inform reporting/analysis
Choosing an ODS API
The Organisation Data Terminology - FHIR API (R4) is a newly developed FHIR API using version 4.0.1. It contains the full range of data currently available from the ORD and STU3 APIs plus additional geographic boundary data and some practitioner data (GPs, nurses and consultants). This is intended to replace the APIs below.
The following APIs will be withdrawn over the next 2 years. Users of these APIs should prepare to migrate, and new users should use, the Organisation Data Terminology - FHIR API.
The ORD API has a bespoke schema and contains the full organisation data set.
The FHIR API (STU3) is interoperable with other FHIR APIs and contains a reduced data set with less attributes.
Compare ODS API attributes
FHIR STU3 | ORD | FHIR R4 | What this feature does | |
---|---|---|---|---|
Organisation name, ID and status | ✓ | ✓ | ✓ | To identify an organisation and whether it is currently open or closed |
Open/close dates | ✓ | ✓ | ✓ | To provide confirmation of when organisations opened or closed (legally and/or operationally) |
Last change date | ✓ | ✓ | ✓ | Find out when the organisation record was last updated |
Address | ✓ | ✓ | ✓ | To help map healthcare services by geography and reduce postcode disparity |
Succession | ✓ | ✓ | To provide a record for organisation mergers and acquisitions (where recorded) | |
Relationships | ✓ | ✓ | To provide information that describes the links between 2 entities. For example, if a GP practice is commissioned (financed/contracted) by a sub-ICB location. Types of relationship include:
|
|
Roles | ✓ | ✓ | ✓ | To provide a list of organisation types and sub types, for example a prescribing cost centre (primary role) and GP practice (non-primary role) |
Contacts | ✓ | ✓ | ✓ | To provide contact details for organisations, including telephone number and/or website address (if held by ODS) |
Practitioner | ✓ | A limited set of Practitioner/Prescriber data that has previously been published as .csv files by ODS | ||
Geography | ✓ | Key elements of the NHS Postcode Directory to provide enhanced geographical boundary data. |
Product updates and enhancement
Find an overview of the latest updates and enhancements to ODS APIs
Last edited: 15 January 2025 2:34 pm