Official FHIR API Documentation Here: https://ontoserver.csiro.au/docs/4.1/api-fhir.html
Request access to FHIR API: Click here
FHIR APIs on the Ontoserver platform are designed to facilitate seamless interaction with healthcare terminology resources. Ontoserver implements the Fast Healthcare Interoperability Resources (FHIR) standard, which is widely used for exchanging healthcare information electronically.
Key Features of FHIR APIs on Ontoserver:
- Terminology Resources: Ontoserver supports core FHIR terminology resources such as:
- CodeSystem: A collection of codes with meanings (e.g., SNOMED CT CA, pCLOCD, CCDD etc).
- ValueSet: A subset of codes from one or more CodeSystems, tailored for specific contexts.
- ConceptMap: Defines relationships between codes in different ValueSets.
- Operations: Ontoserver provides advanced operations like:
- $lookup: Retrieve details about a specific code within a CodeSystem.
- $expand: Generate a list of codes in a ValueSet.
- $validate-code: Check if a code is valid within a ValueSet.
- Automation and Integration: Developers can use Ontoserver's FHIR APIs to automate tasks such as:
- Fetching terminology updates.
- Validating codes against standards.
- Mapping concepts between different terminologies.
Ontoserver's FHIR APIs are particularly useful for ensuring interoperability and standardization in healthcare applications. In order to access the new Terminology Server using its integrated FHIR APIs, developers will need credentials in the form of a Client ID and Client Secret in order to authenticate and retrieve an authorization token. Every application and/or developer will require their own separate credentials.
API Endpoints
Obtaining an Authorization Token:
If you need to request a Client ID/Secret, you can do so here
curl --location --request POST 'https://terminologystandardsservice.ca/authorisation/auth/realms/terminology/protocol/openid-connect/token' \ --data-urlencode 'grant_type=client_credentials' \ --data-urlencode 'client_id=YOUR_CLIENT_ID' \ --data-urlencode 'client_secret=YOUR_CLIENT_SECRET'
Example API Request:
curl --location --request GET 'https://terminologystandardsservice.ca/fhir/ValueSet/' \ --header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'If you require more details on what operations and functionality that is supported, please review the official documentation for OntoServer. The link is provided at the top of this page. A Postman collection is also available with some samples to help you get started with our FHIR API.
Postman
We’re excited to share that our GitHub repository includes Postman collection tests, making it easier for users to explore and interact with our APIs. These collections are designed to simplify testing and integration, saving you valuable time and effort. Feel free to browse, download, and use these collections to streamline your development process. We encourage you to dive in, experiment, and leverage these resources to make the most out of our offerings!