Partager via

Vue d’ensemble des Dataverse Healthcare API

  • Article

Les Dataverse Healthcare API sont une offre de produits complète de Microsoft Cloud for Healthcare qui vous permet d’interagir avec Dataverse en utilisant la norme FHIR (Fast Health Interoperability Resources). Les API utilisent les mappages de la boîte à outils d’intégration des données pour transformer les packs entre FHIR et Dataverse.

Ces API sont implémentées en tant qu’API Dataverse conçues pour accepter les packs FHIR comme paramètres d’entrée. Les API gèrent le mappage et la transformation des ressources FHIR individuelles et publient les enregistrements obtenus dans Dataverse. Vous pouvez vous authentifier et protéger ces points de terminaison comme vous le feriez avec les API standard de Dataverse.

Note

Pour en savoir plus sur les API Dataverse standard, accédez à Créer et utiliser des API personnalisées.

Les Dataverse Healthcare API peuvent être utilisées pour :

  • Publier des données basées sur FHIR directement dans Dataverse.
  • Synchroniser Dataverse avec des services FHIR externes, comme les services de données de santé Azure.

Ces API combinées à Azure Logic Apps constituent le remplacement de Microsoft Cloud for Healthcare pour les outils de l’agent de synchronisation FHIR Azure retiré.

L’utilisation de l’application logique fournie n’est pas requise pour utiliser les Dataverse Healthcare API. Vous pouvez créer votre propre application logique, utiliser Power Automate ou développer votre propre code personnalisé. Il n’est pas non plus nécessaire de synchroniser les données avec un service FHIR externe. Vous pouvez effectuer une synchronisation avec les points de terminaison FHIR des Services de données de santé Azure ou publier des données directement dans les API. Les Dataverse Healthcare API sont conçues comme un composant flexible qui peut être utilisé pour concevoir vos solutions de soins de santé dans Microsoft Cloud for Healthcare.

Section Contenu
Dataverse Healthcare API Résume les informations sur les API actuellement disponibles dans le cadre des Dataverse Healthcare API.
Vue d’ensemble de l’écriture différée pour les Dataverse Healthcare API Explique le processus d’écriture différée pour les Dataverse Healthcare API.
Configurer les Dataverse Healthcare API Contient les étapes pour configurer les Dataverse Heathcare API.
Configurer Azure Logic App avec un déclencheur HTTP Contient un guide étape par étape détaillé pour créer votre propre application logique qui peut ingérer des données FHIR dans les Dataverse Healthcare API, les Services de données de santé Azure ou les deux.
Utiliser le modèle de pipeline de données de santé pour déployer Azure Logic Apps Fournit un guide étape par étape pour utiliser un modèle et déployer un groupe de Logic Apps qui orchestrent l’ingestion de packs FHIR dans les Dataverse Healthcare API et les Services de données de santé Azure.
Utiliser les Dataverse Heathcare API Résume comment invoquer et utiliser les Dataverse Healthcare API, avec des exemples et des scénarios d’utilisation courants.
Passer en revue les Journaux de Dataverse Healthcare API Explique comment examiner les journaux de transactions pour les activités des Dataverse Healthcare API.

Dataverse Healthcare API

Les API suivantes sont actuellement disponibles dans le cadre des Dataverse Heathcare API :

  • API d’upsert de pack
  • API de récupération de pack

API d’upsert de pack

L’API d’upsert de pack permet d’envoyer des packs FHIR à Dataverse et les transformer en enregistrements Dataverse.

L’API prend actuellement en charge les fonctionnalités suivantes :

  • L’ingestion de packs de ressources simples et mixtes. Un seul groupe de ressources contient un seul type de ressource, alors qu’un groupe mixte contient plusieurs types de ressources.
  • L’ingestion des types de packs batch. Pour plus d’informations, consultez Types de packs pris en charge.
  • Ingestion de packs avec des références Uniform Resource Name (URN).
  • Intégrité référentielle des packs FHIR : une ressource n’est créée dans Dataverse que si toutes ses références sont résolues.
  • La création d’enregistrements développés pour chaque ressource FHIR dans Dataverse.
  • La création de codeable concepts quand ils manquent dans Dataverse.
  • Réponses détaillées et localisées.

L’API (msind_UpsertBundle) dispose de deux paramètres de requête définis comme suit :

Paramètre de requête Description
msind_JSON Le pack FHIR qui doit être inséré (valeur obligatoire).
msind_BundleTag Une balise qui aide à identifier les packs lors de l’analyse des journaux dans Dataverse (valeur facultative).

Pour savoir comment invoquer l’API et examiner des scénarios d’utilisation courants, accédez à Invoquer l’API d’upsert de pack à partir de l’API Web.

Après l’invocation de l’API, les éléments suivants devraient être disponibles dans la réponse JSON :

Paramètre de réponse Description
msind_Status Une valeur booléenne qui indique si le pack a été traité avec succès et si toutes les ressources valides ont été insérées dans Dataverse.
msind_StatusDetail Fournit des informations détaillées sur la valeur msind_Status.
msind_fhirresourceid L’ID FHIR de la ressource dans le pack. Si une entrée dans le résultat se rapporte à un enregistrement développé, la valeur est l’ID FHIR de la ressource racine.
msind_fhirresourcetype Le type de ressource FHIR de la ressource dans le pack. Si une entrée dans le résultat se rapporte à un enregistrement développé, la valeur est le type de ressource FHIR de la ressource racine.
msind_resultingrecordid ID Dataverse une fois l’enregistrement inséré. Si une entrée dans le résultat se rapporte à un enregistrement développé, la valeur est l’ID Dataverse de la ressource racine.
msind_resultingrecordtype Le nom de l’entité Dataverse dans laquelle l’enregistrement a été inséré. Si une entrée dans le résultat se rapporte à un enregistrement développé, la valeur est le nom de l’entité Dataverse de l’enregistrement développé.
msind_requestactionperformed Le type d’action effectuée. Pour afficher les valeurs attendues et leur description, accédez à Types d’actions de demande effectuées.
msind_requeststatus Statut de la demande. Pour afficher les valeurs attendues et leur description, accédez à Types de statuts de demande.
msind_requeststatusdetail Informations détaillées sur la valeur msind_requeststatus.

Types d’actions de demande effectuées

Le tableau suivant répertorie les valeurs attendues pour le paramètre de réponse msind_requestactionperformed :

active Description
935000000 Une ressource racine est créée.
935000001 Une ressource racine déjà existante dans Dataverse est mise à jour.
935000002 L’action a été effectuée sur une entité étendue.

Types de statuts de la requête

Le tableau suivant répertorie les valeurs attendues pour le paramètre de réponse msind_requeststatus :

active Description
935000000 L’augmentation des ressources s’est soldée par un succès.
935000001 L’augmentation des ressources s’est soldée par un avertissement.
935000002 L’augmentation des ressources s’est soldée par une erreur.

Types de packs pris en charge

L’API du pack upsert prend actuellement en charge les packs de type batch et batch-response. Pour ingérer des packs de types non pris en charge, vous devez d’abord modifier le type du pack que vous envoyez. Si vous souhaitez modifier le type de pack en batch avant de publier dans les API, vous pouvez utiliser l’action de remplacement intégrée à l’application logique pour changer le type de pack. Cette étape traite le pack comme un groupe d’actions indépendantes.

Lorsque vous modifiez le type de pack en lot, il est important de prendre en compte son effet potentiel sur vos scénarios individuels. La modification d’un pack transactionnel en lot peut avoir des effets indésirables sur les données que vous tentez d’importer dans Dataverse. Pour plus d’informations sur les règles d’utilisation de ces offres groupées, rendez-vous sur HL7 FHIR – Utilisation des offres groupées.

Si vous envoyez un pack de type batch-response, Dataverse Healthcare API enregistre les ressources de type OperationOutcome avec une valeur de gravité error dans les journaux. Cette action vous permet de publier le pack dans un serveur FHIR et de diriger la réponse du serveur FHIR vers Dataverse Healthcare API. Par conséquent, vous pouvez capturer toutes les erreurs dans un seul emplacement.

API de récupération de pack

L’API de récupération de pack vous permet d’interroger Dataverse pour une seule ressource FHIR à l’aide de l’ID FHIR. L’API transforme la demande et utilise les mappages de la boîte à outils d’intégration des données pour répondre avec une ressource normalisée FHIR.

L’API prend actuellement en charge les fonctionnalités suivantes :

  • Recherche d’un seul enregistrement en utilisant l’ID FHIR.
  • Journalisation détaillée et localisée.

L’API (msind_RetrieveBundle) dispose d’un paramètre de requête défini comme suit :

Paramètre de requête Description
msind_FHIRQuery La requête FHIR à exécuter (valeur obligatoire).

Requêtes FHIR prises en charge

Requête Description
FHIRResource/FHIRID La requête renvoie la ressource entière avec les entités développées.
FHIRResource/FHIRId?_elements=element_1,element_2,...,element_n La requête renvoie les éléments spécifiés dans la requête ainsi que tous les éléments marqués comme FHIR obligatoire sur le mappage d’attributs.

Pour plus d’informations, consultez Recherche d’élément FHIR.

Pour savoir comment invoquer l’API et examiner des scénarios d’utilisation courants, accédez à Invoquer l’API de récupération de pack à partir de l’API Web.

Après l’invocation de l’API, vous pouvez voir une réponse contenant le statut de la demande complète, ainsi que le statut détaillé de chaque ressource et de ses éléments développés.

Paramètre de réponse Description
msind_Status Une valeur booléenne qui indique si l’action a été traitée avec succès.
msind_StatusDetail Fournit des informations détaillées sur la valeur msind_Status.
msind_JSON Représentation JSON FHIR.