Utilisation des API


Les API REST du SMT permettent une interaction programmatique avec le serveur, facilitant l’accès automatisé aux terminologies, aux concepts, et aux alignements. Cette documentation vise à vous guider à travers l’utilisation de ces API, en offrant des exemples pratiques et des liens utiles.

Pour les tests, il est possible d’utiliser les outils de test des API de type : Postman ou Insomnia.

Accès aux API

Les API disponibles sont documentées sur la page Swagger du SMT, qui offre une vue d’ensemble des endpoints disponibles ainsi que des informations détaillées sur leur utilisation.

Swagger du SMT : https://smt.esante.gouv.fr/api-docs/

Télécharger la dernière version de la Terminologie

Objectif : Démontrer comment télécharger la dernière version de la terminologie ATC en utilisant l’API.

  1. Obtenir le `terminologyId` et la dernière version :
    • Avant de télécharger la terminologie, il est nécessaire de connaître son identifiant unique (terminologyId) et la version la plus récente.
      • Utilisez /api/terminologies/search avec le terme de recherche « atc » pour obtenir le terminologyId et la version actuelle.
      • La dernière version disponible (mars 2024) est « 2024-02 et le terminologyId est "terminologie-atc".

2. Télécharger la Terminologie :

  • Pour télécharger la dernière version de l’ATC, utilisez l’endpoint /wp-json/ans/terminologies/zip.
  • Ce processus nécessite de spécifier trois paramètres obligatoires dans la requête : terminologyId, licenceConsent, et version.

Rechercher les descendants du chapitre « respiratoire » dans la terminologie CISP-2

Objectif : Démontrer comment identifier et récupérer les descendants (concepts enfants) du terme « respiratoire » au sein de la terminologie CISP-2, utilisant les API REST du SMT.

Étape 1 : Trouver le conceptId du Terme « Respiratoire »

Pour commencer, vous devez trouver l’identifiant unique (conceptId) du terme « respiratoire » dans la CISP-2. Cela permet d’assurer que la recherche de descendants se concentre spécifiquement sur ce terme.

  1. Utiliser l’API de Recherche de Concepts :
    • Endpoint : /api/concepts/search
    • Méthode : POST
    • Corps de la Requête : JSON spécifiant terminologyId pour CISP-2 et le terme de recherche search pour « respiratoire ».
  2. Exemple de Requête :
    • Vous pouvez filtrer sur la terminologie CISP-2 en spécifiant son identifiant (terminologyId="terminologie-cisp") et le terme de recherche (search="respiratoire").

Étape 2 : Obtenir les Descendants du Terme « Respiratoire »

Après avoir obtenu le conceptId pour le terme « respiratoire » à partir de la première requête, utilisez cet identifiant pour trouver tous les concepts enfants directement associés.

  1. Utiliser l’API pour Rechercher des Concepts Enfants :
    • Endpoint : /api/concepts/child
    • Méthode : GET
    • Paramètres de Requête : terminologyId pour "terminologie-cisp" et conceptId pour l’identifiant trouvé.
  2. Exemple de Requête :
    • Avec le conceptId trouvé (par exemple, « https://data.esante.gouv.fr/wonca-cispclub/cisp2/R« ), vous pouvez maintenant utiliser cette information pour récupérer les descendants.

La requête vers l’API /api/concepts/child retournera une liste de tous les concepts enfants associés au terme « respiratoire » dans la CISP-2. Cette liste peut inclure diverses conditions, symptômes, ou interventions liées au système respiratoire, permettant une exploration détaillée de cette catégorie au sein de la terminologie.