Par où commencer?
Pour commencer, vous aurez besoin d’une clé API unique fournie par Inforoute pour configurer facilement les outils d’HL7 et accéder à la terminologie. Pour plus d’information, voir la documentation d’HL7.
Versions prises en charge
- HL7 IG Publisher : version 1.8.1 ou suivante
- HL7 Validator : version 6.5.0 ou suivante
Accéder aux API du serveur terminologique à l’aide d’une clé API
Si votre application ne prend pas en charge les données d’accès de type OAuth2 (la méthode privilégiée), et que vous utilisez des outils autres que les outils d’HL7 mentionnés ci-dessus, vous pouvez utiliser une clé API pour accéder aux API du serveur terminologique. Il s’agit d’une solution de dernier recours. Suivez bien les étapes ci-dessous; elles diffèrent de celles fournies pour les données de type OAuth2.
- Utiliser l’URL de la clé API dédiée
- Pour accéder aux API à l’aide d’une clé API, utiliser l’URL suivante : https://terminologystandardsservice.ca/tx/fhir
- S’assurer que toutes les demandes d’API incluent le chemin contextuel '/tx/fhir' avant d’ajouter les paramètres de configuration.
- Inclure la clé API dans l’en-tête de la requête HTTP
- La clé API doit être fournie comme en-tête de la requête HTTP dans vos requêtes.
Api-Key: <your-api-key>
- La clé API doit être fournie comme en-tête de la requête HTTP dans vos requêtes.
- Exemple d’une commande cURL
- Voici un exemple de commande cURL pour faire une requête à l’aide de la clé API:
curl 'https://terminologystandardsservice.ca/tx/fhir' \ -H 'Api-Key: <your-api-key>'
Note
- Accès avec l’API de syndication : les utilisateurs de clé API n’ont pas accès aux téléchargements effectués à l’aide de l’API de syndication. Ils ont accès aux ressources FHIR seulement.
- Compatibilité : utilisez les clés API seulement si votre application ne prend pas en charge les données d’accès de type OAuth2.

