Übersicht der Dataverse Healthcare APIs

Die Dataverse Healthcare APIs sind ein vollständiges Produktangebot von Microsoft Cloud for Healthcare , das Ihnen die Interaktion mit Dataverse unter Verwendung des FHIR-Standards ermöglicht. 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

Erfahren Sie mehr über Standard Dataverse-APIs, wechseln Sie zu Nenutzerdefinierte 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 in Kombination mit Azure Logic Apps sind der Microsoft Cloud for Healthcare Ersatz für das Azure FHIR-Synchronisierungs-Agent Tool, das eingestellt wurde.

Wichtig

Gültig bis Oktober 2023 wurde der Azure FHIR-Synchronisierungs-Agent offiziell eingestellt. Es wird nicht im Datenintegrations-Toolkit enthalten sein und nicht als Microsoft Cloud for Healthcare-Lösung unterstützt werden.

Die Verwendung der bereitgestellten Logik-App ist keine Voraussetzung für die Verwendung von Dataverse Healthcare APIs. Sie können Ihre eigene Azure Logic App erstellen und 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 Azure Health Data Services FHIR-Endpunkte synchronisieren oder Daten direkt in den APIs veröffentlichen. 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 als Teil 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.
Konfigurieren Sie Azure Logic-Apps mit einem HTTP-Auslöser	Enthält eine detaillierte, schrittweise Anleitung zum Erstellen Ihrer eigenen Logic-App zum Einbinden von FHIR-Daten in Healthcare APIs von Dataverse, Azure Health Data Services oder beides.
Datenpipeline-Vorlage für Healthcare zum Bereitstellen 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-Bündeln in Healthcare APIs und Azure Health Data Services Dataverse orchestrieren.
Die Dataverse Healthcare APIs verwenden	Fasst zusammen, wie die Dataverse Healthcare APIs aufgerufen und verwendet wird mit einigen Beispielen und allgemeinen Nutzungsszenarien.
Ü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.
• Das Erfassen von Pakten mit Uniform Resource Name (URN) Referenz.
• Die Sicherstellung der referenziellen Integrität von FHIR-Pakten – Eine Ressource würde 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 Paket für Upsert-API (msind_UpsertBundle) verfügt über zwei Anforderungsparameter, die wie folgt definiert 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 Parsen 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, nachdem der Datensatz aktualisiert wurde. 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	Es wurde eine Stammressource erstellt.
935000001	Eine bereits in Dataverse vorhandene Stammressource wurde 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 nur Pakete vom Typ Batch und Batch-Antwort. Wenn Sie versuchen, Pakete der nicht unterstützten Typen aufzunehmen, müssen Sie den Typ des von Ihnen übermittelten Pakete ändern. 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. Dieser Schritt würde das Paket als Gruppe unabhängiger Aktionen verarbeiten.

Wenn Sie den Bundle-Typ auf Batch ändern, sollten Sie sorgfältig abwägen, welche Auswirkungen dies auf Ihre einzelnen Szenarien haben könnte. 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.

Das Anforderungspaket für API (msind_RetrieveBundle) verfügt über ein Anforderungsparameter, das wie folgt definiert ist:

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

Unterstützte FHIR-Abfragen

Abfrage	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.

Anmerkung

Zukünftige Dataverse Healthcare API-Releases werden Investitionen für den Abruf zusätzlicher FHIR-Ressourcen und zusätzliche Filterfunktionen beinhalten.

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.

Informationen zum Konfigurieren der Dataverse Healthcare APIs finden Sie unter Dataverse Healthcare APIs konfigurieren.

Siehe auch

Was ist Microsoft Cloud for Healthcare?
Übersicht über das Datenintegrations-Toolkit
Übersicht über die Rückschreibung für Dataverse Healthcare APIs
Konfigurieren Sie Dataverse Healthcare APIs
Verwenden Sie die Dataverse Healthcare APIs