Organisation Data Service (ODS) Implementation Guide

Design overview

The Organisational Data Service (ODS) FHIR API, using the FHIR R4 standard, allows connecting systems to request and receive organisational related data. The FHIR API is read-only and so connecting systems can not update or delete data but only request data.

Design

Connecting systems will interact with the ODS FHIR API using the following environments:

Integration environment
https://int.api.service.nhs.uk/

Sandbox environment
https://sandbox.api.service.nhs.uk/

Production environment
https://api.service.nhs.uk/

Modelling

The ODS FHIR API has been modelled in such a way as to ensure all previously used data fields within the ODS domain are mappable to the modelled FHIR assets. Click [here] to view the data mapping.

Interactions

Based on the use cases stated within the NHS England IG Clinical and Technical Assurance Sprint 2 Documentation Pack for the ODS FHIR API, previously named as Organisation Reference Data (ORD), the design of the ODS FHIR API is intended to support the following interactions:

A Data Manager requests data for reporting requirements
A Clinical Systems Developer requests data for integration with downstream systems
A Commissioner requests data for payment requirements
A Head Clinician requests data for research and forecasting
A Data Consumer requests data for data source updates
A National Payments System requests data for payment requirements