HL7 International Tools
HL7 International Tools
The new terminology server integrates easily with the HL7 International FHIR tooling ecosystem, including the Implementation Guide (IG) Publisher and FHIR Validator, offering several key benefits:
- Direct access for users to Infoway-hosted CodeSystems and ValueSets within Implementation Guides (IGs) without the need for duplicating content or using “stub” ValueSets.
- Access to Infoway-hosted CodeSystems and ValueSets in the HL7 FHIR Validator, eliminating the need to manage content separately for validation.
- Canadian terminologies like SNOMED CT CA are automatically updated in the HL7 ecosystem, ensuring users always have access to the latest standards without delays or manual updates.
- Validation processes at events like the IHE Connectathon and Projectathons are streamlined, allowing users to validate directly against Infoway-hosted terminologies, saving time and simplifying conformance testing.
How to Get Started
To begin, you will need a user-specific API key from Infoway, making it easy to configure HL7 tools for seamless terminology access. For more detailed instructions you can refer to HL7’s documentation.
Supported Versions
- HL7 IG Publisher version 1.8.1 or later
- HL7 Validator version 6.5.0 or later
Accessing the Terminology Server APIs with an API Key
If your application does not support OAuth2 credentials (the preferred method), and you are using tools other than the HL7 tools mentioned above, then you can use an API Key to access the Terminology Server APIs as a final option. Follow these steps carefully, as the process differs from the OAuth2 flow.
- Use the Dedicated API Key URL
- To access the APIs using an API Key, use the following URL: https://terminologystandardsservice.ca/tx/fhir
- Ensure that all API requests include the `/tx/fhir` context path before appending query parameters.
- Include the API Key in the HTTP Header
- The API Key must be provided as an HTTP header in your requests. Api-Key: <your-api-key>
- Example CURL Command
- Here is a sample CURL command to demonstrate how to make a request using the API Key:
curl 'https://terminologystandardsservice.ca/tx/fhir' \ -H 'Api-Key: <your-api-key>'
Note
- Syndication API Access: Downloads through the Syndication API are not available for API Key users. Only FHIR Resources are available.
- Compatibility: Use API Keys only if your application does not support OAuth2.