Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: organisation-data-terminology-api Organization API
version: 1.0.1-alpha
contact:
name: ODS FHIR API Support
url: https://digital.nhs.uk/developer/help-and-support
email: api.management@nhs.net
description: "\n\n## Overview\nUse this API to access a dataset of health and social care organisations, such as trusts or GP practices, using the [Organisation Data Service (ODS)](https://digital.nhs.uk/services/organisation-data-service). \n\nThe FHIR API contains the majority of ODS Content, including Organisations, practitioners and geographic information. It contains all the content found within the [ODS ORD API](http://digital.nhs.uk/developer/api-catalogue/organisation-data-service-ord) and the [ODS STU3 API](https://digital.nhs.uk/developer/api-catalogue/organisation-data-service-fhir)\n\nODS holds information for many different types of organisation related to health and social care – mostly in England but also other countries depending on the type of Organisation. For the full scope of data coverage of the ODS APIs, see [Organisation Data Service - data coverage](https://digital.nhs.uk/services/organisation-data-service/ods-data-coverage). \n\nEvery organisation in ODS has a unique identifier called an ODS code. \n\nUsing this API, you can:\n\n - search for an organisation to find its ODS code \n - get organisation details for a given ODS code\n - get details of related organisations\n - search for a practitioner to find their ODS code \n - get practitioner details for a given ODS code \n - get geographic boundaries for a postcode \n - get details of recently deleted or partially deleted records \n\nYou can also limit the number of results returned, or just request a count of the number of search results.\n\nThis FHIR API makes use of the Organization and OrganizationAffiliation FHIR resources plus range of CodeSystems to deliver the full suite of data, which you will use will depend on your need. \n\n\n### Organisation Data\n\nWe have been able to align the majority of data we hold for an organisation into the FHIR resources Organization and OrganizationAffiliation, through the limited use of extensions, however some previously available information could not be included.\n\nTo access the Organisation attributes which are not included in the Organization resource use the ods-organization-code CodeSystem. The CodeSystem resource returns the following additional information:\n\n - organisation – Assigning Authority \n - related entities, the current related entity of any supported relationships \n - succession - any predecessors and/or successors and a flag to indicate the successor has also been succeeded \n - geographic - the appropriate mapping from the postcode dataset including Local Authority, Integrated Care Board or Lower Super Output Area (LSOA) \n\n### Practitioner Data\nODS publishes a limited set of prescribers held by the Business Services Authority, which includes General Practitioners and Nurse Prescribers, alongside Hospital and Dental Consultants provided by the workforce census returns.\n\nThese codes have not been made available within the Pracitioner Resource as it is felt thet they do not accurately represent an indindiual, but rather reflect their prescribing activities.\n\nTo access the Practitioner data you will need to use the practitioner CodeSystem in conjunction with the practitioner-relationship-instance CodeSystem which contians the relationship between a practitioner and the organisation at which they work. \n\n### Postcodes and geographic boundaries available\n\nFor every postcode within the NHS Postcode Directory, we have compiled a CodeSystem which contains the postcode along with its key Health and Social Care boundaries, including, Primary Care Organisations, Integrated Care Boards, Local Authority 2011 Lower Super Output Areas (LSOA11), Cancer Alliances and NHS England Regions \n\n### CodeSystems to support the full range of ODS Content\n\nIn Addition to the ods-organisation-code CodeSystem mentioned above, there are also CodeSystems for:\n\n- practitioner - includes details about related organisation (where a practitioner is based/works) and type of practitioner\n- postcode - contains various geographic values/boundaries for a postcode including which Lower Super Output Area, Parliamentary Constituency, Local Authority and Integrated Care Board boundary a postcode falls within\n- organization-relationship-instance – contains historic and current relationships\n- organization-role-instance – contains historic and current role instances \n- practitioner-role – contains the role a practitioner performs (currently limited to prescriber types/roles and consultants)\n- practitioner-relationship-instance – contains the associations between Prescribers (GPs) and GP Practices only \n- ODSOrganisationRole – reference Data for Primary and Non Primary Roles (Role ID, Role Name, and Primary/Non Primary indicator)\n- ODSRelationship – reference data for Relationships (Relationship Type ID and Relationship Name) \n- ODSRecordClass – reference data for record classes ie org or site \n- ODSRecordUseType – reference data for the type of use – Full for current records, refOnly for minimal records included for referential integrity\n- geography-name – reference data for ONS identifiers used within the Postcode CodeSystem \n\n\n<section class=\"nhsd-m-emphasis-box nhsd-m-emphasis-box--important nhsd-!t-margin-bottom-6\" aria-label=\"Important Information\">\n <div class=\"nhsd-a-box nhsd-a-box--border-yellow\">\n <div class=\"nhsd-m-emphasis-box__image-box\">\n <figure class=\"nhsd-a-image\">\n <picture class=\"nhsd-a-image__picture\">\n <img src=\"http://digital.nhs.uk/binaries/content/gallery/icons/book-open.svg?colour=231f20\" alt=\"\" style=\"object-fit:fill\" />\n </picture>\n </figure>\n </div>\n <div class=\"nhsd-m-emphasis-box__content-box\">\n <div data-uipath=\"website.contentblock.emphasis.content\" class=\"nhsd-t-word-break\"><p class=\"nhsd-t-body\">For a non-technical overview of how to build software that deals with organisations and healthcare services, see <a href=\"https://digital.nhs.uk/developer/guides-and-documentation/building-healthcare-software/organisations-and-services\">Building healthcare software - organisations and healthcare services</a>.</p></div>\n </div>\n </div>\n</section>\n\n\n## Who can use this API\nThere are no particular restrictions on what this API can be used for. \n\nIt can be used free of charge by public sector organisations in England, Scotland and Wales, including the NHS. This includes use by software developers building software for the public sector.\n\n## Related APIs\nThe following APIs also gives access to the Organisation Data Service:\n- [ODS Organisation Reference Data (ORD) API](https://digital.nhs.uk/developer/api-catalogue/organisation-data-service-ord) - a richer version conforming to DCB000090 Standard, soon to be deprecated.\n- [ODS Organisation Reference Data (FHIR - STU3) API](https://digital.nhs.uk/developer/api-catalogue/organisation-data-service-fhir) - STU3 version contains a minimal organization record, soon to be deprecated.\n\n\n## API status and roadmap\nThis API is [in development](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#statuses).\n\nTo see our roadmap, or to suggest, comment or vote on features for this API, see our [interactive product backlog](https://nhs-digital-api-management.featureupvote.com/?order=popular&filter=allexceptdone&tag=ods-api#controls).\n\nIf you have any other queries, [contact us](https://digital.nhs.uk/developer/help-and-support).\n\n## Service level\nThis API is a bronze service, meaning it is operational and supported only during business hours (8am to 6pm), Monday to Friday excluding bank holidays.\n\nFor more details, see [service levels](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#service-levels).\n\n## Technology\nThis API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-rest).\n\nIt also conforms to the [FHIR](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#fhir) global standard for health care data exchange. Specifically to FHIR R4 (v4.0.1), we have been working closely with the Interoperability team to develop and publish [Implementation guidance](https://simplifier.net/guide/organisation-data-services).\n\nYou do not need to know much about FHIR to use this API - FHIR APIs are just RESTful APIs that follow specific rules. In particular:\n- resource names are capitalised, singular and in American English, for example `/Organization` not `/organisations`\n- array names are singular, for example `line` not `lines` for address lines\n- data items that are country-specific and thus not included in the FHIR global base resources are usually wrapped in an `extension` object\n\nThere are [libraries and SDKs available](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir-libraries-and-sdks) to help with FHIR API integration.\n\n## Network access\nThis API is available on the internet and, indirectly, on the [Health and Social Care Network (HSCN)](https://digital.nhs.uk/services/health-and-social-care-network).\n\nFor more details see [Network access for APIs](https://digital.nhs.uk/developer/guides-and-documentation/network-access-for-apis).\n\n## Security and authorisation\n### Application-restricted access\n#### still to be decided\nThis API is [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis), meaning we authenticate the calling application but not the end user.\n\n## Errors\nWe use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:\n- 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action\n- 400 to 499 if it failed because of a client error by your application\n- 500 to 599 if it failed because of an error on our server\n\nErrors specific to each API are shown in the Endpoints section, under Response. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes) for more on errors.\n\n\n## Environments and testing\n\n| Environments | Base URLs |\n| ----------------- | ---------------------------------------------------------------------- |\n| User acceptance test (UAT) |TBC |\n| Production |TBC |\n\nFor example:\n`TBC/fhir/Organization/RJY`\nreturns the dataset for the organisation whose ODS code is RJY.\n\n### Integration testing\nYou can use the UAT environment to perform your integration testing.\n\n## Onboarding\n\n\n#### still to be decided if we use the Term server\nIndividual users can access content on the NHS England Terminology Server(ODS Instance) with a registered account.\n\nShrimp is a terminology browser that is freely available on the internet, but it is only for browsing the content. The Terminology Server does not come with a built-in browser, so Shrimp is given as an example of a browsing tool, freely accessible on the internet. Other browsers can be used.\n\nIf you are interested in integrating a software application with the Terminology Server, or if you want to [syndicate content to your own Terminology Server](https://digital.nhs.uk/services/terminology-server#syndication), you will need to complete a [system-to-system request form]https://digital.nhs.uk/services/terminology-server/system-to-system-account-request-form.\n"
servers:
- url: https://beta.ods.dc4h.link/fhir/
description: User acceptance test (UAT) environment.
- url: https://jenkins.ods.dc4h.link/fhir/
description: Production environment.
tags:
- name: Organization
paths:
/Organization:
get:
summary: Search for an organisation
operationId: get-organization-resources
description: "## Overview\nUse this endpoint to search for organisations or sites. Site codes which are supported for certain organisations can also be accessed here, there is no separate endpoint for sites. \n\nA FHIR Organization resource will be provided for each search result.\n\nYou can search for information about an organisation using one or more of their: \n\n * ODS code \n * last change date \n * name \n * active or inactive status \n * address, city or postcode \n * organisation's primary role using RoleID, such as RO197 (NHS Trust) or RO167 (Optical Site) \n * organisation's non-primary role using RoleID, such as RO7 (Hospice) or RO318 (Integrated Care Board) \n \nThis API returns the following details for an organisation: \n\n * 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.\n * address - house or flat number, line 1, line 2, line 3, town, postcode, Unique Property Reference Number (UPRN) and country\n * contacts - website and telephone (where available)\n * roles - primary and non-primary roles including legal and operational start and end dates \n\nYou can also request any related relations resources using the `_revinclude` parameter to return an OrganizationAffiliation Resource. \n\nYou can try out the sandbox using the 'Try this API' feature on this page. (Coming Soon!)\n\nAlternatively, you can try out the sandbox using our Postman collection (placeholder link):\n\n[](https://app.getpostman.com/run-collection/32547823-005ebee4-7510-44c3-bb0e-58f26b2ba747)\n"
parameters:
- in: query
name: _id
description: "The organisation’s ODS code. \n\nIf you already know the ODS code, use the `Get organisation details` endpoint instead.\n"
required: false
schema:
type: string
example: RR8
- in: query
name: identifier
description: "The organisation's ODS code. \n\nThis parameter is similar to `_id` but can also explicitly include the CodeSystem for the ID - which must be `ods-organization-code`. \n\nIt's included for FHIR compatibility. \n"
required: false
schema:
type: string
examples:
without-code-system:
summary: 'A search using just the ID:'
value: G81086
with-code-system:
summary: 'A search using the code system and ID:'
value: https://fhir.nhs.uk/Id/ods-organization-code|G81086
- in: query
name: lastChangeDate
description: The date that the organisation record was last modified by ODS. Supports greater than, less and equal to. Can be compounded.
required: false
schema:
type: string
examples:
greater-than:
summary: Search for changes made after a date
value: gt2017-04-01
less-than:
summary: Search for changes made before a date
value: lt2017-04-01
equal-to:
summary: Search for changes made on a single date
value: '2024-02-06'
- in: query
name: name
description: 'The start of the organisation''s name. For example, `Leeds` would match `Leeds Chest Clinic` but not `South Leeds Clinical Assessment Service`.
To search anywhere in the organisation''s name, use `name:contains`. To search for an exact match, use `name:exact`.
Not case sensitive.
Search expressions must:
- contain a minimum of 3 characters and a maximum of 100 characters
- only include the following characters: A-Z a-z 0-9 &()’+-_./:@ ''Space''
'
required: false
schema:
type: string
example: Leeds
- in: query
name: name:contains
description: 'Any part of the organisation''s name. For example, `Leeds` would match `Leeds Chest Clinic` and `South Leeds Clinical Assessment Service`.
Not case sensitive.
Search expressions must:
- contain a minimum of 3 characters and a maximum of 100 characters
- only include the following characters: A-Z a-z 0-9 &()’+-_./:@ ''Space''
'
required: false
schema:
type: string
example: Leeds
- in: query
name: name:exact
description: 'The exact organisation name.
Case sensitive.
Search expressions must:
- contain a minimum of 3 characters and a maximum of 100 characters
- only include the following characters: A-Z a-z 0-9 &()’+-_./:@ ''Space''
'
required: false
schema:
type: string
example: LEEDS TEACHING HOSPITALS NHS TRUST
- in: query
name: active
description: Whether the organisation's record is still in active use.
required: false
schema:
type: boolean
example: 'true'
- in: query
name: address-postalcode
description: 'The start of the organisation''s postcode.
To search anywhere in the postcode, use `address-postalcode:contains`. To search for an exact match, use `address-postalcode:exact`.
Not case sensitive.
Search expressions must:
- contain a minimum of 2 characters
- only include alphanumeric characters and spaces
'
required: false
schema:
type: string
example: LS1
- in: query
name: address-postalcode:contains
description: 'Any part of the organisation''s postcode.
Not case sensitive.
Search expressions must:
- contain a minimum of 2 characters
- only include alphanumeric characters and spaces
'
required: false
schema:
type: string
example: 4DZ
- in: query
name: address-postalcode:exact
description: 'The exact organisation postcode.
Case sensitive.
Search expressions must:
- contain a minimum of 2 characters
- only include alphanumeric characters and spaces
'
required: false
schema:
type: string
example: LS1 4DZ
- in: query
name: address-city
description: 'The start of the organisation''s city address.
To search anywhere in the city address, use `address-city:contains`. To search for an exact match, use `address-city:exact`.
Not case sensitive.
Search expressions must:
- contain a minimum of 2 characters
- only include alphanumeric characters and spaces
'
required: false
schema:
type: string
example: Derby
- in: query
name: address-city:contains
description: 'Any part of the organisation''s city address.
Not case sensitive.
Search expressions must:
- contain a minimum of 2 characters
- only include alphanumeric characters and spaces
'
required: false
schema:
type: string
example: Derby
- in: query
name: address-city:exact
description: 'The exact organisation city address.
Case sensitive.
Search expressions must:
- contain a minimum of 2 characters
- only include alphanumeric characters and spaces
'
required: false
schema:
type: string
example: DERBY
- in: query
name: address-country
description: 'The start of the organisation''s country.
Not case sensitive.
To search anywhere in the country address, use `address-country:contains`. To search for an exact match, use `address-country:exact`.
Search expressions must:
- contain a minimum of 2 characters
- only include alphanumeric characters and spaces
'
required: false
schema:
type: string
example: ENGLAND
- in: query
name: roleCode
description: "The organisation's role, based on the `ODSOrganisationRole` CodeSystem.\n\nAn organisation in ODS can have one or many roles.\n\nTo exclude organisations with a specific role use `roleCode:not` \n\nTo search for organisations that have multiple roles (like an 'AND' operator), include the `roleCode` query parameter multiple times. \n\nTo search for organisations that have one of several roles (like an 'OR' operator), use a comma separator. \n\nYou may combine 'AND' and 'OR' searches.\n\nTo discover whether a role is primary or non-primary, refer to the `ODSOrganisationRelationship` CodeSystem \n"
required: false
schema:
type: string
examples:
without-code-system:
summary: 'A search using just the role code (RO197 = NHS trust):'
value: RO197
with-code-system:
summary: 'A search using the code system and role code:'
value: https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole|RO197
multiple-roles:
summary: 'A search for multiple roles (like an ''OR'' operator):'
value: RO197,RO198
coumpound-roles:
summary: 'A search for combined roles (like an ''AND'' operator):'
value: roleCode=RO197&roleCode=RO7
- in: query
name: roleCode:not
description: "Exclude organisations from the search results based on their role \n"
required: false
schema:
type: string
examples:
compound:
summary: A search combining roleCode and roleCode:not
value: roleCode=RO177&roleCode:not=RO76
single:
summary: 'A search using the code system and role code:'
value: roleCode:not=https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole|RO197
- in: query
name: activeRoleCode
description: "Searches only active roles within the `ODSOrganisationRole` CodeSystem \n\nTo exclude organisations with a specific role use `activeRoleCode:not` \nTo search for organisations that have multiple roles (like an 'AND' operator), include the `activeRoleCode` query parameter multiple times. \n\nTo search for organisations that have one of several roles (like an 'OR' operator), use a comma separator. \n\nYou may combine 'AND' and 'OR' searches.\n\nTo discover whether a role is primary or non-primary, refer to the `ODSOrganisationRelationship` CodeSystem \n"
required: false
schema:
type: string
examples:
without-code-system:
summary: 'A search using just the role code (RO197 = NHS trust):'
value: RO197
with-code-system:
summary: 'A search using the code system and role code:'
value: https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole|RO197
multiple-roles:
summary: 'A search for multiple roles (like an ''OR'' operator):'
value: RO197,RO198
- in: query
name: _count
description: Number of results to return.
required: false
schema:
type: string
example: '1000'
- in: query
name: _summary
description: Return a count of the matching resources, without returning the actual matches.
required: false
schema:
type: string
enum:
- count
- in: query
name: _offset
description: When used with _count, enables paging through large result sets
required: false
schema:
type: string
example: 2000
responses:
'200':
description: Valid request that returns a FHIR Organization resource(s) that match the search criteria (which may be 0).
content:
application/fhir+json:
example:
resourceType: Bundle
id: d84a1a14-d90f-4dd7-a5bc-b5e56a81d1af
meta:
lastUpdated: '2024-03-14T11:03:31.163+00:00'
type: searchset
link:
- relation: self
url: https://jenkins.ods.dc4h.link/fhir/Organization?_count=2&lastChangeDate=lt2023-05-04&lastChangeDate=gt2023-05-02
- relation: next
url: https://jenkins.ods.dc4h.link/fhir/Organization?_count=2&_offset=2&lastChangeDate=lt2023-05-04&lastChangeDate=gt2023-05-02
entry:
- fullUrl: https://jenkins.ods.dc4h.link/fhir/Organization/AQN
resource:
resourceType: Organization
id: AQN
meta:
versionId: '3'
lastUpdated: '2024-01-23T12:56:03.130+00:00'
source: '#df0974983053aca7'
profile:
- https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization
- https://fhir.nhs.uk/England/StructureDefinition/England-Organization-ODS
extension:
- url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole
extension:
- url: instanceID
valueInteger: 233160
- url: roleCode
valueCodeableConcept:
coding:
- system: https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole
code: RO172
display: INDEPENDENT SECTOR HEALTHCARE PROVIDER
- url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod
extension:
- url: dateType
valueCoding:
system: https://fhir.nhs.uk/England/CodeSystem/England-PeriodType
code: Legal
display: Legal
- url: period
valuePeriod:
start: '2015-04-01'
- url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod
extension:
- url: dateType
valueCoding:
system: https://fhir.nhs.uk/England/CodeSystem/England-PeriodType
code: Operational
display: Operational
- url: period
valuePeriod:
start: '2015-04-01'
- url: active
valueBoolean: true
- url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedDateTime
extension:
- url: type
valueCoding:
system: https://fhir.nhs.uk/England/CodeSystem/England-ODSDateTime
code: LastChangeDate
display: Last Change Date
- url: dateTime
valueDateTime: '2023-05-03'
identifier:
- use: official
system: https://fhir.nhs.uk/Id/ods-organization-code
value: AQN
assigner:
display: HSCIC
active: true
type:
- coding:
- system: https://fhir.nhs.uk/England/CodeSystem/England-ODSRecordUseType
code: Full
display: Full
- coding:
- system: https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRecordClass
code: RC1
display: HSCOrg
name: PARTNERING HEALTH LIMITED
address:
- line:
- AILSA HOUSE 3 TURNBERRY HOUSE
- 4400 PARKWAY
- WHITELEY
city: FAREHAM
postalCode: PO15 7FJ
country: ENGLAND
search:
mode: match
- fullUrl: https://jenkins.ods.dc4h.link/fhir/Organization/C4O9I
resource:
resourceType: Organization
id: C4O9I
meta:
versionId: '3'
lastUpdated: '2024-01-23T13:00:38.788+00:00'
source: '#b71fdedd3d5fad9e'
profile:
- https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization
- https://fhir.nhs.uk/England/StructureDefinition/England-Organization-ODS
extension:
- url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole
extension:
- url: instanceID
valueInteger: 503768
- url: roleCode
valueCodeableConcept:
coding:
- system: https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole
code: RO181
display: PHARMACY HEADQUARTER
- url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod
extension:
- url: dateType
valueCoding:
system: https://fhir.nhs.uk/England/CodeSystem/England-PeriodType
code: Legal
display: Legal
- url: period
valuePeriod:
start: '2023-04-28'
- url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod
extension:
- url: dateType
valueCoding:
system: https://fhir.nhs.uk/England/CodeSystem/England-PeriodType
code: Operational
display: Operational
- url: period
valuePeriod:
start: '2023-04-28'
- url: active
valueBoolean: true
- url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedDateTime
extension:
- url: type
valueCoding:
system: https://fhir.nhs.uk/England/CodeSystem/England-ODSDateTime
code: LastChangeDate
display: Last Change Date
- url: dateTime
valueDateTime: '2023-05-03'
identifier:
- use: official
system: https://fhir.nhs.uk/Id/ods-organization-code
value: C4O9I
assigner:
display: NHS ENGLAND
active: true
type:
- coding:
- system: https://fhir.nhs.uk/England/CodeSystem/England-ODSRecordUseType
code: Full
display: Full
- coding:
- system: https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSRecordClass
code: RC1
display
# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nhs-england/refs/heads/main/openapi/nhs-england-organization-api-openapi.yml