Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Organisation Data Service (ODS) - FHIR API

Reference data on NHS and healthcare organisations, roles and terminology (the Organisation Data Service), exposed as an HL7 FHIR R4 API. OpenAPI harvested verbatim (8 paths).

Organisation Data Service (ODS) - FHIR API is one of 10 APIs that NHS England publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include FHIR, Reference Data, and Organisations. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 8 paths. It is described by OpenAPI 3.0.0, at version 1.0.1-alpha.

Requests are made against 2 base URLs: https://beta.ods.dc4h.link/fhir/, https://jenkins.ods.dc4h.link/fhir/.

8 operations 8 paths 0 schemas 7 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.1-alpha
Base URL
https://beta.ods.dc4h.link/fhir/
Resource Areas
1

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 7 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Operations 8
GET
/Organization
Search for an organisation
get-organization-resources 20 params → 2004XX
GET
/Organizationaffiliation
Search for a relationship
get-organizationaffiliation-resources 7 params → 2004XX
GET
/Organization/{id}
Get organisation details
get-single-organization 1 param → 200404
GET
/OrganizationAffiliation/{id}
Get relationship details
get-single-organizationaffiliation 1 param → 200404
GET
/List{id}
Get deletion notices
get-deletion-notices 1 param → 200
GET
/CodeSystem/
Search for additional instance and reference data
search-codesystem 4 params → 2004XX
POST
/ValueSet/
Perform a ValueSet expansion
search-ods-organization-code body → 2004XX
GET
/metadata
Get capability statement
get-capability-statement → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nhs-organisation-data-service-fhir-r4-openapi.yaml Raw ↑

Other APIs NHS England publishes across the network.

Personal Demographics Service (PDS) - FHIR API
GP Connect Access Record - Structured - FHIR API
Electronic Prescription Service (EPS) - FHIR API
e-Referral Service (e-RS) - FHIR API
Booking and Referral Standard (BaRS) - FHIR API
Immunisation History - FHIR API
NHS App API
NHS Notify (Communications Manager) API
Service Search (Directory of Healthcare Services) API