Get organisation details

Overview

Use this endpoint to get details for a single organisation based on its ODS code. Site codes which are supported for certain organisations can also be accessed here, there is not a separate endpoint for sites. A FHIR Organization resource will be provided when a valid id has been provided.

What is included

This API returns the following details for an organisation:

• organisation - ODS code, name, last change date, status if active or inactive , record class (organisation or site), record use type; A complete record or a reduced record included solely for referential integrity.
• address - house or flat number, line 1, line 2, line 3, town, postcode, Unique Property Reference Number (UPRN) and country
• contacts - website and telephone (where available)
• roles - primary and non-primary roles including legal and operational start and end dates

To access a richer Organisation dataset, use the ods-organization-code CodeSystem, when searching the CodeSystem resource with an ODS Code, in addition to the above, the following will also be returned:

• organisation –Assigning Authority
• related entities, the current related entity of any supported relationships
• succession - any predecessors and/or successors and a flag to indicate the successor has also been succeeded
• geographic - the appropriate mapping from the postcode dataset including Local Authority, Integrated Care Board or Lower Super Output Area (LSOA)