Organisation Data Terminology - FHIR API: Onboarding

Organisation Data Service (ODS)
,
1

Hi,

We have recently completed the onboarding process for the Organisation Data Terminology - FHIR API and we have been approved to use the API. We filled in the questionnaires, added a Team and our Application. I emailed our application ID to the named people before getting approval, but I’m unclear on if I am now supposed to do something within our application to tie this all together. I am unclear how this process links to our application, and what exactly this process enabled us to do. Am I supposed to receive some credentials or something that we use to tie our application to this onboarding process? I’ve read and done what it says in https://digital.nhs.uk/developer/api-catalogue/organisation-data-terminology#overview--onboarding but am not sure what completing this process has given me.

Please can you advise more about the onboarding process for that specific API.

Thanks,

2

Completing the onboarding process provides you with an API Key that’s enabled for access to the API’s Production environment. Please see more information regarding available environments here.

You can generate your API Key in the ‘Environment Access’ tab of the Digital Onboarding Service - select the product name, and then ‘Edit’ against ‘Active API Keys’ (under ‘Security details’ heading). The Organisation Data Terminology FHIR R4 API uses API Key Authentication.

The API also has:

I hope this helps.

3

Thanks Laura, that’s helpful. I don’t think I’d seen the information on the “API Key Authentication” page that you linked, so that missing puzzle piece makes it make more sense now thank you.