Bienvenue sur la documentation de l'API FHIR Annuaire Santé en libre accès

Voici la documentation complète pour faciliter l’utilisation de l’API. Elle comprend des guides de prise en main rapide, des guides pour les développeurs, des démonstrations, des exemples d’implémentation, des guides de bonnes pratiques, des bibliothèques de référence, ainsi que des exemples de code. Cette documentation est conçue pour vous aider à maîtriser rapidement et efficacement l’API.

Documentation complète

Démarrage rapide

Présentation

L’API Annuaire Santé permet au grand public d’interroger facilement et rapidement les données en libre accès de l’Annuaire Santé. Cette API REST, basée sur la spécification HL7 FHIR, est conçue pour être:

  • Simple d’utilisation
  • Rapide
  • Toujours à jour
  • Compatible FHIR


A quoi sert l’API ?

En intégrant l’API Annuaire Santé dans votre système d’information, vous pouvez facilement trouver un professionnel intervenant dans le système de santé ou une structure, filtrer, ordonner et paginer les résultats selon vos souhaits.

Exemples de cas d’utilisation

Pour les structures de santé

  • Récupérer l’identifiant national des professionnels intervenant dans le système de santé,
  • Vérifier l’identité (identifiant national, nom, prénom), les qualifications et la situation d’exercice d’un professionnel,
  • Faciliter la coordination ville-hôpital avec la mise en place d’un annuaire de correspondants.

Pour les porteurs de projets nationaux et régionaux

  • Spécifier des règles métier en fonctions des données d’identification (qualifications…),
  • Consulter les activités d’un professionnel (comme l’adresse d’exercice) à partir de son identifiant national (par exemple lorsque le professionnel se connecte au service avec sa CPS ou sa e-CPS).

Pour les industriels et éditeurs

  • Mettre en œuvre des mécanismes de synchronisation avec un annuaire local,
  • Récupérer l’identifiant national pour gérer les accès au système d’information,
  • Utiliser les identifiants nationaux pour alimenter les métadonnées d’un document structuré.
  • Vérifier les numéros RPPS dans les documents #CDA

 

Aller plus loin


Documentation : Explorez la documentation.

Cas d'utilisation : Les cas d'utilisation pouvant vous servir d'inspiration pour vos développements.

Démonstrateur : Découvrez l'API au travers de l'interface IHM.

IG (Implementation Guide): Découvrez le modèle FHIR de l'Annuaire Santé au travers du guide d'implémentation.