Bases de l'API

URL d’accès (base url)

Tous les accès se font via HTTPS.

Environnement Production

Environnement Bac à sable (en accès restreint)

Points de terminaison (endpoints)

Méthodes HTTP (http verbs)

L’API est conforme à la norme REST. Vous pouvez utiliser les ressources avec les méthodes HTTP suivantes :

En-têtes (headers)

-- Exemple :

  curl 
    -H "ESANTE-API-KEY: XXXX-XXXX-XXXX-XXXXX"  \
    "[api-url]/metadata"  
    
    -- XXXX-XXXX-XXXX-XXXXX étant l'API KEY

Construction de la réponse de base

Réponse de base – Succès

Lien vers la spécification FHIR : https://www.hl7.org/fhir/R4/bundle.html

Si la recherche est un succès, le serveur répond :

NOTE| La recherche est un succès à partir du moment où la requête peut être exécutée. Il peut il y avoir 0 à n correspondances. Plus de précision sur la spécification FHIR : https://www.hl7.org/fhir/R4/http.html

Réponse de base – Echec

Lien vers la spécification FHIR : https://www.hl7.org/fhir/R4/operationoutcome.html

Si la recherche échoue, le serveur doit répondre :

NOTE| L’échec d’une recherche est la non-possibilité d’exécuter la requête, ce qui est différent d’aucune correspondance à la recherche. Plus de précision sur la spécification FHIR : https://www.hl7.org/fhir/R4/http.html

Codes d’état HTTP (HTTP status codes)

Toutes les réponses utilisent des codes d’état HTTP standard.

Erreur NET::ERR_CERT_AUTHORITY_INVALID sur l’IHM (https://portail.openfhir.annuaire.sante.fr)

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 l’AC IGC Santé dans le navigateur pour qu’elle soit reconnue par la suite.

Paramètres d’entrée

Les paramètres et critères de recherche de l’API sont standard FHIR :

NOTE| Pour plus de détails sur les paramètres d’entrées de l’API, se référer au CapabilityStatement : [api-url]/metadata

Paramètres et modificateurs de requêtes FHIR

Sont supportés les paramètres et le modificateurs suivants :

Pagination

Lorsqu’une réponse inclut de nombreux résultats, l’API les pagine et en retourne une partie. Par défaut, elle ne retourne que 50 éléments .Quand une réponse est paginée, les réponses incluent des liens permettant de récupérer les pages suivantes. Seul le lien Next est supporté.

Suppression d’une ressource (active=false ; status=inactive)

De manière générale, la ressource n’est plus publiée dans l’API à partir du moment où elle devient inactive. Cependant, elle ne disparait pas complétement de l’API puisqu’elle reste présente dans le delta avec uniquement son id et le champs active = false (device : status inactive). Ce fonctionnement permet notamment aux consommateurs du delta d’isoler les ressources supprimées entre deux dates (synchronisations).

Par défaut, l’API remonte toutes les ressources (actives et inactives). Pour exlcure les ressources inactives du résulat, utilisez le paramètre active ou status.

{
    "resourceType": "Bundle",
    "id": "835a413a-d78e-4e80-8735-7a9e14b1b4e9",
    "meta": {
        "lastUpdated": "2023-11-02T10:02:24.909+00:00"
    },
    "type": "searchset",
    "total": 1,
    "link": [
        {
            "relation": "self",
            "url": "https://gateway.preprod.api.esante.gouv.fr/fhir/v1/Practitioner?_id=003-118475&active=false"
        }
    ],
    "entry": [
        {
            "fullUrl": "https://gateway.api.esante.gouv.fr/fhir/v1/Practitioner/003-118475",
            "resource": {
                "resourceType": "Practitioner",
                "id": "003-118475",
                "meta": {
                    "versionId": "2",
                    "lastUpdated": "2023-09-05T08:55:12.763+00:00",
                    "source": "https://annuaire.sante.fr",
                    "profile": [
                        "https://annuaire.sante.gouv.fr/fhir/StructureDefinition/AS-Practitioner"
                    ]
                },
                "active": false
            }
        }
    ]
}