Skip to main content

organization-relationship-instance

The organization-relationship-instance is a terminology CodeSystem that holds the history of which relationships are or have been held by an organisation or site.

Overview

The organization-relationship-instance is a CodeSystem held on the NHS England Terminology Server (ODS Instance) that holds the history of which relationships are or have been held by an organisation or site.

It is subject to change daily as new organisations are created, therefore we suggest that you retrieve the latest version via the API.

This API forms part of the strategic products provided by ODS and is intended to replace our two existing APIs.


CodeSystem usage

You can retrieve reference CodeSystems in full, as they are small enough to be returned in a single query.  

Larger CodeSystems which generally contain instance data cannot be retrieved in full due to their size. 

You can also search or validate individual concepts; codes stored within the CodeSystem.

Refer to our OAS specification for more information.


CodeSystem properties

Property code Property description
legEndDate Legal end date for an instance of a relationship
legStartDate Legal start date for an instance of a relationship
opEndDate Operational end date for an instance of a relationship
opStartDate Operational start date for an instance of a relationship
relationshipTypeCode The relationship type ID for the relationship, such as RE4
sourceOrgCode The ODS code of the source organisation for the relationship
sourceOrgRole Primary role of the source organisation in a relationship
status A Status is provided for each Relationship which indicates whether the Relationship is currently active or not. Inactive if both legal and operational end dates are present and the end dates are both equal to or before today’s date
targetOrgCode The ODS code of the target organisation for the relationship
targetOrgRole Primary role of the target organisation in a relationship

Other CodeSystems available

The CodeSystem names in the tables below are case sensitive.

Resolvable CodeSystems

The following CodeSystems are resolvable.

Non-resolvable CodeSystems

The following CodeSystems are non-resolvable.

If you try and navigate to the System URL the browser will display an error. For more details about these CodeSystems refer to our Simplifier pages

CodeSystem System URL
ods-organization-code https://fhir.nhs.uk/Id/ods-organization-code
England-ODSDateTime https://fhir.nhs.uk/England/CodeSystem/England-ODSDateTime
England-ODSRecordUseType https://fhir.nhs.uk/England/CodeSystem/England-ODSRecordUseType
England-PeriodType https://fhir.nhs.uk/England/CodeSystem/England-PeriodType

Companion product

We have also produced a user interface that allows access to the same information through our companion product: ODS Data Search and Export.


Further information

For more specific information about the data refer to our Reference Data Catalogue

Additional CodeSystems are referenced by the Implementation Guidance, and these can be found on our Simplifier pages.

Last edited: 27 October 2025 2:15 pm