Freigeben über

Übersicht der Dataverse Healthcare APIs

  • Artikel

Die Dataverse Healthcare APIs sind ein umfassendes Produktangebot im Rahmen von Microsoft Cloud for Healthcare, das Ihnen die Interaktion mit Dataverse erlaubt, indem Sie den FHIR-Standard (Fast Health Interoperability Resources) verwenden. Die APIs verwenden weiterhin die Datenintegrations-Toolkit-Zuordnungen, um die Pakete zwischen FHIR und Dataverse zu transformieren.

Diese APIs werden als Dataverse APIs implementiert, die FHIR-Pakete als Eingabeparameter akzeptieren. Die APIs übernehmen die Zuordnung und Transformation einzelner FHIR-Ressourcen und veröffentlichen die resultierenden Datensätze in Dataverse. Sie können sich bei diesen Endpunkten wie bei Standard-Dataverse-APIs authentifizieren und sichern.

Anmerkung

Weitere Informationen zu den Standard-Dataverse-APIs finden Sie unter Benutzerdefinierte APIs erstellen und verwenden.

Die Dataverse Healthcare APIs können für Folgendes verwendet werden:

  • FHIR-basierte Daten direkt in Dataverse veröffentlichen
  • Dataverse mit externen FHIR-Diensten wie Azure Health Data Services synchronisieren

Diese APIs bilden in Kombination mit Azure Logic Apps den Microsoft Cloud for Healthcare-Ersatz für die nicht mehr verfügbaren Azure FHIR-Synchronisierungs-Agent-Tools.

Die Verwendung der bereitgestellten Logik-App ist für die Nutzung der Dataverse Healthcare APIs nicht erforderlich. Sie können Ihre eigene Logik-App erstellen, Power Automate verwenden oder Ihren eigenen benutzerdefinierten Code entwickeln. Es besteht auch keine Notwendigkeit, Daten mit einem externen FHIR-Dienst zu synchronisieren. Sie können mit den FHIR-Endpunkten von Azure Health Data Services synchronisieren oder Daten direkt in die APIs bereitstellen. Die Dataverse Healthcare APIs sollen eine flexible Komponente sein, die für die Gestaltung Ihrer Gesundheitslösungen um Microsoft Cloud for Healthcare verwendet werden kann.

Abschnitt Inhalt
Dataverse Healthcare APIs Fasst Informationen zu den APIs zusammen, die derzeit im Rahmen der Dataverse Healthcare APIs verfügbar sind.
Überblick über Zurückschreiben für Dataverse Healthcare APIs Erklärt den Rückschreibvorgang für Dataverse Healthcare APIs.
Dataverse Healthcare APIs konfigurieren Enthält Schritte zum Konfigurieren der Dataverse Healthcare APIs.
Azure Logic App mit einem HTTP-Trigger konfigurieren Enthält eine detaillierte Schritt-für-Schritt-Anleitung zum Erstellen Ihrer eigenen Logik-App, die FHIR-Daten in Dataverse Healthcare APIs, Azure Health Data Services oder beides erfassen kann.
Pipeline-Vorlage für Gesundheitsdaten zur Bereitstellung von Azure Logic Apps verwenden Bietet eine schrittweise Anleitung für die Verwendung einer Vorlage zum Bereitstellen einer Gruppe von Logic-Apps, die das Einbinden von FHIR-Paketen in Dataverse Healthcare APIs und Azure Health Data Services orchestrieren.
Die Dataverse Healthcare APIs verwenden Fasst zusammen, wie die Dataverse Healthcare APIs aufgerufen und verwendet werden, mit Beispielen und gängigen Verwendungsszenarien.
Übersicht über Dataverse Healthcare API-Protokolle Erklärt, wie die Transaktionsprotokolle für Dataverse Healthcare API-überprüft werden.

Dataverse Healthcare APIs

Die folgenden APIs sind derzeit als Teil der Dataverse Healthcare APIs verfügbar:

  • Upsert-Bundle-API
  • Retrieve-Bundle-API

Upsert-Bundle-API

Die Upsert Bundle API ermöglicht das Senden von FHIR Bundles an Dataverse und deren Umwandlung in Dataverse Datensätze.

Die API unterstützt derzeit folgende Funktionen:

  • Erfassung von einzelnen und gemischten Ressourcen-Paketen. Ein einzelnes Ressourcenpaket enthält nur einen Ressourcentyp, während ein gemischtes Ressourcenpaket mehrere Ressourcentypen enthält.
  • Das Erfassen von Batch-Pakettypen. Weitere Informationen finden Sie unter Unterstützte Pakettypen.
  • Erfassung von Paketen mit Uniform Resource Name-Referenzen (URN-Referenzen).
  • Referenzielle Integrität von FHIR-Paketen – eine Ressource wird nur dann in Dataverse erstellt, wenn alle ihre Referenzen aufgelöst sind.
  • Erstellung von erweiterten Datensätzen für jede FHIR-Ressource in Dataverse.
  • Erstellung von codeable concept, wenn sie in Dataverse fehlen.
  • Ausführliche und lokalisierte Antworten.

Die API (msind_UpsertBundle) hat zwei Anforderungsparameter, die wie folgt festgelegt sind:

Anforderungsparameter Beschreibung
msind_JSON Das FHIR-Paket, das eingefügt werden muss (erforderlicher Wert).
msind_BundleTag Ein Tag, das beim Identifizieren der Pakete beim Analysieren der Protokolle in Dataverse hilft (optionaler Wert).

Um zu erfahren, wie Sie die API aufrufen und einige gängige Nutzungsszenarien überprüfen, wechseln Sie zu Upsert-Pakete-API über die Web-API aufrufen.

Nach dem API-Aufruf können Sie die folgenden Elemente in der JSON-Antwort erwarten:

Antwortparameter Beschreibung
msind_Status Ein boolescher Wert, der angibt, ob das Bundle erfolgreich verarbeitet wurde und alle gültigen Ressourcen in Dataverse eingefügt wurden.
msind_StatusDetail Bietet detaillierte Informationen über den msind_Status-Wert.
msind_fhirresourceid Die FHIR-ID der Ressource im Paket Wenn sich ein Eintrag im Ergebnis auf einen erweiterten Datensatz bezieht, ist der Wert die FHIR-ID der Stammressource.
msind_fhirresourcetype Der FHIR-Ressourcentyp der Ressource im Paket Wenn sich ein Eintrag im Ergebnis auf einen erweiterten Datensatz bezieht, ist der Wert des FHIR-Ressourcentyps der Stammressource.
msind_resultingrecordid Die Dataverse-ID nach dem Upsert des Datensatzes. Wenn sich ein Eintrag im Ergebnis auf einen erweiterten Datensatz bezieht, ist der Wert die Dataverse-ID der Stammressource.
msind_resultingrecordtype Der Name der Dataverse-Entität, in den der Datensatz hochgeladen wurde. Wenn sich ein Eintrag im Ergebnis auf einen erweiterten Datensatz bezieht, ist der Wert der Name der Dataverse-Entität des erweiterten Datensatzes.
msind_requestactionperformed Der Typ der durchgeführten Maßnahme Um die erwarteten Werte und ihre Beschreibung anzuzeigen, gehen Sie zu Typen der ausgeführten Anforderungsaktionen.
msind_requeststatus Der Status der Anforderung. Um die erwarteten Werte und ihre Beschreibung anzuzeigen, gehen Sie zu Typen von Anforderungsstatus.
msind_requeststatusdetail Detaillierte Informationen zum msind_requeststatus-Wert.

Arten der durchgeführten Anfrageaktionen

In der folgenden Tabelle sind erwartete Werte für das msind_requestactionperformed-Antwortparameter aufgeführt:

Wert Beschreibung
935000000 Eine Stammressource wird erstellt.
935000001 Eine bereits vorhandene Stammressource in Dataverse wird aktualisiert.
935000002 Die Aktion wurde für eine erweiterte Entität durchgeführt.

Arten von Anfragestatus

In der folgenden Tabelle sind erwartete Werte für das msind_requeststatus-Antwortparameter aufgeführt:

Wert Beschreibung
935000000 Die Ressource Upsert hat zu einem Erfolg geführt.
935000001 Die Ressource upsert führte zu einer Warnung.
935000002 Die Ressource upsert führte zu einem Fehler.

Unterstützte Pakettypen

Die Upsert-Paket-API unterstützt derzeit Pakete vom Typ Batch und Batchantwort. Um Pakete der nicht unterstützten Typen zu erfassen, müssen Sie zuerst den Typ des Pakets ändern, das Sie übermitteln. Wenn Sie den Pakettyp vor dem Senden an die APIs auf Batch ändern möchten, können Sie die in die Logik-App integrierte Aktion ersetzen verwenden, um den Bündeltyp zu ändern. Dieses Schritt verarbeitet das Paket als eine Gruppe unabhängiger Aktionen.

Wenn Sie den Pakettyp in Batch ändern, müssen Sie berücksichtigen, welche Auswirkungen dies auf Ihre einzelnen Szenarien haben kann. Das Ändern eines Transaktionspakets in ein Batch könnte unerwünschte Auswirkungen auf die Daten haben, die Sie in Dataverse einbringen möchten. Weitere Informationen zu den Regeln für die Verwendung dieser Bundles finden Sie unter HL7 FHIR - Verwendung von Bundles.

Wenn Sie ein Paket vom Typ batch-response übermitteln, protokolliert die Dataverse Healthcare API Ressourcen vom Typ OperationOutcome mit Schweregradwert error zu den Protokollen. Mit dieser Aktion können Sie das Paket auf einem FHIR-Server veröffentlichen und die Antwort vom FHIR-Server an die Dataverse Healthcare API weiterleiten. So können Sie alle Fehler an einem Ort erfassen.

Retrieve-Bundle-API

Mit der API zum Abrufen von Bundles können Sie Dataverse für eine einzelne FHIR-Ressource unter Verwendung der FHIR-ID abfragen. Die API wandelt die Anfrage um und verwendet die Zuordnungen des Datenintegrations-Toolkits, um mit einer FHIR-standardisierten Ressource zu antworten.

Die API unterstützt derzeit folgende Funktionen:

  • Abfrage eines einzelnen Datensatzes mithilfe der FHIR-ID.
  • Ausführliche und lokalisierte Protokollierung.

Die API (msind_RetrieveBundle) hat einen Anforderungsparameter, der wie folgt festgelegt ist:

Anforderungsparameter Beschreibung
msind_FHIRQuery Die auszuführende FHIR-Abfrage (erforderlicher Wert).

Unterstützte FHIR-Abfragen

Abfragen Beschreibung
FHIRResource/FHIRID Die Abfrage gibt die gesamte Ressource zusammen mit den erweiterten Entitäten zurück.
FHIRResource/FHIRId?_elements=element_1,element_2,...,element_n Die Abfrage gibt die in der Abfrage angegebenen Elemente zusammen mit allen Elementen zurück, die in der Attributzuordnung als FHIR erforderlich markiert sind.

Weitere Informationen finden Sie unter FHIR-Elementsuche.

Um zu erfahren, wie Sie die API aufrufen und einige gängige Nutzungsszenarien überprüfen, wechseln Sie zu Abrufpakete-API über die Web-API aufrufen.

Nach dem API-Aufruf können Sie eine Antwort sehen, die den Status der vollständigen Anfrage sowie den detaillierten Status jeder Ressource und ihrer erweiterten Elemente enthält.

Antwortparameter Beschreibung
msind_Status Ein boolescher Wert, der angibt, ob die Action erfolgreich durchgeführt wurde.
msind_StatusDetail Bietet detaillierte Informationen über den msind_Status-Wert.
msind_JSON FHIR JSON Darstellung.