Démarrage rapide

Tester l'API

Démarrer les tests API avec Postman
Démarrer les tests API avec cURL
Utiliser le Démonstrateur API FHIR Annuaire Santé

1) Démarrer les tests API avec Postman

Récupérer la collection Postman

Pour tester l’API FHIR Annuaire Santé, télécharger cette collection Postman contenant des exemples d’appels FHIR.

Configuration de la clé d’API

Une fois le projet importé dans votre espace Postman:

dans le menu “Environnements”: créer un environnement “Prod” et renseigner les variables nécessaires (ex: api_key et api_url)

dans l’en-tête (Header) de votre appel, saisir le nom de la clé ESANTE-API-KEY et saisir dans la colonne “valeur” votre api_key de manière dynamique dans votre Postman

dans le menu “Collection”: choisir un dossier et lancer un appel

NOTE	Attention: vérifier bien que les variables d’environnements soient bien sélectionnées (situé en haut à droite de l’écran) et que les variables sont utilisées dans les appels.

Veuillez trouver ci-dessous les variables utilisées dans le projet Postman:

Variable	Description	Valeur
api_key	Clé d’API (Si vous n’avez pas de clé, veuillez suivre la procédure décrite ici)	Saisissez votre clé
api_url	L’url d’accès à l’API	https://gateway.api.esante.gouv.fr/fhir/v2

2) Démarrer les tests API avec cURL

NOTE	Pour la suite de l’exercice, vous devez remplacer XXXX-XXXX-XXXX-XXXXX par votre clé d’API.

Pour ces premiers tests, nous utilisons cURL pour plus de simplicité.

Récuperer le Capability Statement FHIR (Metadata)

Test 1 : lancez la commande suivante pour récupérer le CapabilityStatement (liste des fonctionnalités de l’API) :

curl -H "ESANTE-API-KEY: XXXX-XXXX-XXXX-XXXXX" "https://gateway.api.esante.gouv.fr/fhir/metadata"

Ci-dessous la réponse de l’API :

{
    "resourceType": "CapabilityStatement",
    "status": "active",
    "fhirVersion": "4.0.1",
    "format": [
        "application/fhir+json",
        "json"
    ],
    "rest": [
        {
            "resource": [
                {
                    "type": "Organization",
                    "profile": "http://interop.esante.gouv.fr/ig/fhir/annuaire-donnee-publique/StructureDefinition/as-organization",
                    "interaction": [
                ...

NOTE	Le Capability Statement permet de connaitre les fonctionnalités disponibles sur le serveur FHIR (paramètres, ressources…).

Récuperer la ressource Practitioner

Test 2 : vous pouvez lancer cette requête pour récupérer les ressources “Practitioner” :

curl -H "ESANTE-API-KEY: " "/fhir/v2/Practitioner?_pretty=true&_format=json"

Ci-dessous un exemple de réponse :

{
    "resourceType": "Bundle",
    "type": "searchset",
    "id": "207ab354-2ac9-4228-a2e5-86d4fd996cfe",
    "total": 1811966,
    "entry": [
        {
            "fullUrl": "https://gateway.preprod.api.esante.gouv.fr/fhir/v2/Practitioner/003-5818457-5939334",
            "resource": {
                "resourceType": "Practitioner",
                "id": "003-5818457-5939334",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2025-01-29T15:29:39.003+01:00",
                    "source": "https://annuaire.sante.fr",
                    "profile": [
                        "https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-practitioner",
                        "https://interop.esante.gouv.fr/ig/fhir/annuaire/StructureDefinition/as-dp-practitioner"
                    ]
                },
                "language": "fr",
                "identifier": [
                    {
                        "use": "official",
                        "type": {
                            "coding": [
                                {
                                    "system": "https://hl7.fr/ig/fhir/core/CodeSystem/fr-core-cs-v2-0203",
                                    "code": "IDNPS"
                                }
                            ]
                        },
                        ...

3) Utiliser le Démonstrateur API FHIR Annuaire Santé

Consulter le Démonstrateur API FHIR Annuaire Santé et utiliser la clé API pour vous connecter à cette plateforme.

NOTE

L’erreur NET::ERR_CERT_AUTHORITY_INVALID est rencontrée car le certificat exposé sur le portail de démo de l’API FHIR est un certificat issu de l’IGC Santé de l’ANS, qui n’est pas une autorité de certification reconnue par les navigateurs du marché (a contrario des Thawte, DigiCert, etc). Pour y remédier, il faut ajouter le certificat AC IGC Santé dans votre navigateur pour qu’il soit reconnu par la suite.

Pour plus d’informations, consulter le site IGC-Santé de l’ANS

Taux de disponibilité

Le taux de disponibilité qui doit être assuré par le titulaire du marché qui maintient et héberge nos SI est de 99,4% (24h/24 et 7j/7).

Options d'accessibilité