Nouvelle API V2

Les nouveautés de cette API

 

1) Un aperçu des changements sur l’API FHIR V2

Nouveautés sur l’API Description
Mise à jour de l’API FHIR V2 L’API FHIR a été actualisée en cohérence avec le nouveau guide d’implémentation rédigé par l’équipe interopérabilité de l’ANS
Changement dans les réponses JSON et le Capability Statement Les réponses JSON et le Capability Statement (metadata) ont été mises à jour
Alignement avec les ressources FRCore L’API est désormais alignée avec les ressources FRCore
Réduction de la dépendance avec la solution HAPI Cette nouvelle version de l’API FHIR réduit la dépendance à HAPI en développant des API propres à l’ANS. Ainsi, HAPI est utilisé uniquement pour la structure des données du serveur FHIR
Séparation des concepts Practitioner et PractitionerRole Les profils génériques sont désormais divisés avec des profils différents : publics et privés. Pour l’instant, cette nouvelle API expose uniquement les données publiques.

 

2) Est-ce-que les 2 versions de l’API FHIR sont toujours disponibles?

Oui, vous pouvez appeler les deux versions de l’API FHIR. Une décommission totale de l’API FHIR V1 sera prévue pour mars 2026. Pour plus d’explications sur la manière d’interroger les deux versions de l’API, consulter le lien suivant pour l’API FHIR V1 ou le lien suivant pour l’API FHIR V2.

A noter que:

  • Le démonstrateur API utilisera par défaut la nouvelle version de l’API FHIR V2.
  • Lors des appels au service de l’API FHIR via cUrl, Postman, etc. (https://gateway.api.esante.gouv.fr/fhir), le service retournera une réponse via l’API FHIR V1. Ce choix a été fait pour éviter toute perturbation avec les consommateurs actuels.

 

3) Existe-il un risque sur la migration entre la V1 et la V2 ?

La migration entre l’API FHIR V1 et V2 est relativement simple. A noter que pour les consommateurs qui souhaitent utiliser l’API FHIR V2 :

  • Les ID techniques seront identiques pour les 3 ressources suivantes: Organization, HealthcareService et Device
  • A l’inverse, un changement est apporté sur les 2 ressources Practitioner et PractitionerRole entre la V1 et la V2 : la correspondance des ID techniques entre la V1 et la V2 sur ces 2 ressources ne seront pas identiques (suite à une modélisation trop différente dans le guide d’implémentation)

 

Nous avons pu aussi constater que certains consommateurs peuvent conserver les ID techniques dans leurs requêtes :

  • Si ces consommateurs stockent ces ID techniques, il peut y avoir ce risque entre la V1 et la V2. Il est recommandé d’utiliser les identifiants métiers (ex: identifier) sur les ressources.
  • A noter qu’Il n’y avait pas d’identifiant métier sur le PractitionerRole dans l’API FHIR V1. Dans l’API FHIR V2, l’attribut identifier (identifiant métier) a été ajouté sur la ressource PractitionerRole.

 

4) Les nouveautés sur chaque ressource

Quelles sont les nouveautés globalement sur cette nouvelle version publiée :

  • Dans l’attribut Ressources: ajout dans l’attribut profile du profile fr-core canonical
  • Lorsqu’une ressource est désactivée : ajout de la source et profile dans le champ meta
  • Modifications importantes sur les 2 ressources Practitioner et PractitionerRole : le valueHumanName sur la ressource Practitioner est supprimé au profit de l’attribut Name dans la ressource Practitioner.
  • Regroupement des informations mail MSSanté et moyens de communication dans un attribut telecom
  • Modification de plusieurs codes systèmes
  • Modification de plusieurs Jeux De Valeurs (JDV)
  • Suppression de la ressource “Subscription”
  • Revue sur le format de réponse du Capability Statement (metadata). Pour plus d’informations sur les capacités du serveur FHIR, n’hésitez pas à consulter le Capability Statement ainsi que le guide d’implémentation
GET [base]/metadata
# récupère les capacités et spécifications du serveur FHIR

  Nous allons voir en détail les nouveautés au niveau de chaque ressource:  

Nouveautés sur Practitioner

Données Ressource Practitioner
active Si la ressource est en statut false, les informations suivantes seront visibles: id de la ressource, identifiant du professionnel (Identifiant national, RPPS) et le champ active
cps Ajout des informations liées aux cartes CPx du Professionnel. Possibilité d’avoir plusieurs cartes CPx
identifier Ajout systématique de l’identifiant national (IDNPS)
identifier-type Mise à jour du code système du type d’identifiant national de la personne physique : https://hl7.fr/ig/fhir/core/CodeSystem/fr-core-cs-v2-0203
name Ajout de l’attribut name contenant les données du professionnel (nom d’exercice, prénom, d’exercice, le préfix (ex : MME) et le suffixe (ex : DR) )
qualification Ajout des informations sur la catégorie professionnelle, la profession, les savoir-faire et les types de savoir-faire.
telecom Ajout d’un attribut telecom contenant l’ensemble des informations MSSanté (Type de messagerie, Type de BAL, dématérialisation, etc.)

Nouveautés sur PractitionerRole

Données Ressource PractitionerRole
identifier Ajout d’un attribut identifier au niveau du PractitionerRole. L’identifier est également un paramètre de recherche
code Suppression des attributs catégorie professionnelle et Profession (déplacés dans Practitioner)
cps Suppression des informations liées aux cartes CPx du Professionnel (déplacés dans Practitioner)
telecom Ajout d’un attribut telecom pour regrouper l’ensemble des informations de communication (adresse MSS, telephone, etc.)
valueHumanName Suppression des informations liées à l’exercice professionnel du Practitioner (déplacés dans Practitioner sous l’attribut Name)
specialty Suppression des informations liées aux savoir-faire et aux types de savoir-faire (déplacés dans Practitioner)

Nouveautés sur Organization

Données Ressource Organization
identifier Mise à jour du code système pour filtrer sur les structures FINESS : https://finess.esante.gouv.fr
identifier Mise à jour du code système pour filtrer sur les structures RPPSRang : https://rpps.esante.gouv.fr
telecom Ajout d’un attribut telecom contenant l’ensemble des informations de communication (adresse MSS, téléphone, adresse mail)
active Si la ressource est en statut false, les informations suivantes seront visibles: id de la ressource, identifiant de la structure (finess, rpps rang, etc.), name (raison sociale) et active

Nouveautés sur Device

Données Ressource Device
periodAuthorization Ajout de la période d’autorisation (date de début / date de fin)
status Si la ressource est en “inactive”, les champs suivants seront présents: language, numéro d’autorisation ARHGOS

Nouveautés sur HealthCareService

Données Ressource Device
type Ajout de la catégorie Activité Santaire régulée avec un binding sur la JDV : https://mos.esante.gouv.fr/NOS/JDV_J133-ActiviteSanitaireRegulee-RASS/FHIR/JDV-J133-ActiviteSanitaireRegulee-RASS
active Si la ressource est en false, les champs suivants seront présents: numéro d’autorisation ARHGOS