Using ODS Data for Public Website Integration

Organisation Data Service (ODS)
1

Hi all,

I am looking to display details for the following NHS organisations on an external, user-facing website:

  • GP Practices

  • Pharmacies

  • Hospitals (Trusts and individual sites)

  • Dentists

  • Opticians

The information I need to display is the name, address, telephone number, website, and opening hours.

Data Sources I’ve Looked At:

I’ve explored the ODS data search and export tool and found the relevant organisation codes (epraccur, etrust, etc.). However, the CSV exports don’t seem to contain the website URL, which is a key requirement.

I also looked at the Organisation Data Service (ORD) API, but I see it’s under review for deprecation.

My Questions:

  1. What is the recommended, long-term API for this data? Given the ORD API is being deprecated, what is the new standard? Is there a FHIR API that I should be using instead?

  2. How can I retrieve website URLs and opening times? Are these fields available in the recommended API? Opening times in particular seem difficult to find a consistent source for.

  3. Do I need specific approval for this? The data appears to be under the Open Government Licence, but I want to confirm that using it on a public-facing website is an approved use case.

Thank you for your time and any guidance you can offer.

2

Hi

  1. What is the recommended, long-term API for this data? Organisation Data Terminology - FHIR API - NHS England Digital

  2. How can I retrieve website URLs and opening times? ODS do not hold or publish opening times for any organisation type. We do have some information re website URLs although coverage is not complete and we rely upon organisations informing us of changes. The ODS Reference Data Catalogue entry for ‘Contacts’ documents where the URL property can be found in the FHIR R4 API: Organisation Data Service : Contacts

  3. Do I need specific approval for this? You will need to onboard to the API but there is no restriction on use case/application of the data: Organisation Data Terminology - FHIR API - NHS England Digital

Many thanks

Laura

3

Hi Laura,

Many thanks for the information, that’s been very helpful.

Following your advice, I’m proceeding with the Organisation Data Terminology – FHIR API. I’ve created a developer account and have reached the “Organisation Details” stage of the onboarding process. I have a few follow-up questions to ensure I’m on the right track and to clarify data access:

1. Onboarding & ODS Code for Developers

The onboarding form requests an ODS code for my organisation. As an independent developer building an external, public-facing website, I’m not an NHS organisation, partner, or supplier. My understanding from the NHS Digital onboarding documentation is that all organisations (including external developers) may need to apply for an ODS code.

· Could you please confirm if that’s correct? Do I need to formally apply for and receive an ODS code for my own company before completing onboarding?

· If so, could you point me to the correct process or contact for obtaining one?

2. Confirmation of API Selection

I’ve added the Organisation Data Terminology – FHIR API as recommended. I also noticed another API called Organisation Data Service – FHIR API, which is described as “open-access” (no API key required) but provides a “reduced dataset.”

· For my intended use, creating a comprehensive, public-facing directory of GP practices, pharmacies, hospitals, dentists, and opticians, can you confirm that the Organisation Data Terminology – FHIR API is indeed the correct and long-term solution?

3. Usage & Attribution

Finally, are there any specific rate limits, attribution requirements (e.g., “Data from NHS England”), or other usage restrictions I should be aware of when displaying this data externally on a public website under the Open Government Licence?

Many thanks again for your time and clarification.

4

Hi Robbie

1. Onboarding & ODS Code for Developers

  • Please enter the name of the organisation you are developing on behalf of. If truly independent, enter a generic value that denotes you are an independent developer.
  • Having an ODS code to access the API is not mandatory. This may change in future based on DOS requirements but for now you can answer ‘No’ to ‘Does the organisation named above have an ODS code?’.

We have shared a similar use case to yours with APIM / DOS to illustrate that it’s not always organisations that need access to the API and are working with them to improve the onboarding experience.

2. Confirmation of API Selection

Yes, Organisation Data Terminology – FHIR R4 API is the correct and long-term solution. Organisation Data Service – FHIR API is a legacy STU3 API which will be retired on 31/12/2025.

3. Usage & Attribution

The Organisation Data Terminology FHIR R4 API has been configured with a custom rate limit based on expected traffic patterns, use case and consumer profiles, and technical constraints. To ensure a good level of service users should aim to keep usage below 5,000 requests per 5 minutes.

The API rate limit is greater than the default, baseline limit for APIM hosted APIs (5 calls per second).

If a user or their application exceeds this rate limit, an HTTP status of 429 (Too Many Requests) will be received. For strategies on handling error codes, refer to error handling guidance.

Hope that helps.

Thanks

Laura

5

Many thanks Laura for your reply.