How to use your credentials
Please see the following link for some further information about the supported operations and examples of how to use the system-to-system credentials to get a token and make an API request:
Using account credentials
How to use FHIR®
The terminology server is FHIR R4 compliant and the API parameters and operations are as specified in the FHIR R4 standard:
The key Resources you will likely be interested in are
Where the standard indicates implementation discretion you will find more specifics here: Ontoserver – (csiro.au)
This postman collection contains examples that you may find helpful in understanding the basics of the interactions.
To run the examples against the Terminology Server you’ll need to replace the root url in the examples with the Production Server equivalent.
If the content you are trying to access requires authentication then you will also need to pass the Authorisation Header as described in “Example of using a token” on Using account credentials.
Using the environments
An explanation of the various environments is provided here: NHS Digital Terminology Server environments - NHS Digital
To use/consume existing content for exploration and analysis then you should use Production 1.
Testing should also be carried out on Production 1.
The Authoring Server is restricted for the internal validation and release of national code systems. If you feel you need to use the Authoring Server specifically then please explain the need
For runtime use in a clinical system there is a dedicated Production Server (Production 2) but you will need to explain your intended use in order to gain access.