Översikt över Dataverse Healthcare APIs

  • Artikel

Dataverse Healthcare APIs är ett fullständigt produkterbjudande från Microsoft Cloud for Healthcare som gör att du kan interagera med Dataverse genoma tt använda FHIR-standard. API:erna använder mappningar för verktygslådan för dataintegrering för att omvandla paketen mellan FHIR och Dataverse.

Dessa API:er implementeras som Dataverse API:er som har utformats för att acceptera FHIR-paket som indataparametrar. API:er hanterar mappning och omvandling av enskilda FHIR-resurser och publicerar de resulterande posterna till Dataverse. Du kan autentisera för och säkra dessa slutpunkter på samma sätt som med standard Dataverse API:er.

Kommentar

Om du vill läsa mer om standard Dataverse API:er går du till Skapa och använda anpassade API:er.

Dataverse Healthcare APIs kan användas för att:

  • Publicera FHIR-baserade data direkt till Dataverse.
  • Synkronisera Dataverse med externa FHIR-tjänster som Azure Health Data Services.

Dessa API:er i kombination med Azure Logic Apps utgör Microsoft Cloud for Healthcare-ersättningen för de verktyg för Azure FHIR: Synkroniseringsagent som tagits bort.

Viktigt!

Från och med oktober 2023 har Azure FHIR: Synkroniseringsagent dragits tillbaka officiellt. Det inkluderas inte i verktygslådan för dataintegrering och stöds inte som en Microsoft Cloud for Healthcare-lösning.

Att använda den medföljande logikappen är inte ett krav för att använda Dataverse Healthcare APIs. Du kan bygga din egen Azure Logic App, använda Power Automate eller utveckla din egen kod. Det finns inget krav på att synkronisera data med en extern FHIR-tjänst. Du kan synkronisera med Azure Health Data Services FHIR-slutpunkter eller publicera data direkt i API:er. Dataverse Healthcare APIs är tänkta att vara en flexibel komponent som kan användas för att designa dina hälsovårdslösningar runt Microsoft Cloud for Healthcare.

Avsnitt Innehåll
Dataverse Healthcare APIs Sammanfattar information om de API:er som för närvarande är tillgängliga som en del av Dataverse Healthcare APIs.
Översikt över tillbakaskrivning för Dataverse Healthcare APIs Förklarar tillbakaskrivningsprocessen för Dataverse Healthcare APIs.
Konfigurera Dataverse Healthcare APIs Innehåller steg för att konfigurera Dataverse Healthcare APIs
Konfigurera Azure Logic-appen med en HTTP-utlösare Innehåller en detaljerad steg-för-steg-guide för att skapa din egen Logic-app med syfte att mata in FHIR-data i Dataverse Healthcare APIs, Azure Health Data Services, eller både och.
Använd pipeline-mallen för hälsovårdsdata för att distribuera Azure Logic Apps Innehåller en steg-för-steg-guide om hur du använder en mall för att distribuera en grupp Logic Apps som orkesterar insamling av FHIR-paket i Dataverse Healthcare APIs och Azure Health-datatjänster
Använd Dataverse Healthcare APIs Sammanfattar hur du aktiverar och använder Dataverse Healthcare APIs med några exempel och vanliga användningsscenarier.
Granska Dataverse Healthcare API loggar Förklarar hur du granskar transaktionsloggarna för Dataverse Healthcare API-aktiviteter.

Dataverse Healthcare APIs

Följande API:er är för närvarandetillgängliga som en del av Dataverse Healthcare APIs:

  • API för upsertning av paket
  • Hämta paket API

API för upsertning av paket

Upserta paket API gör det möjligt att skicka FHIR-paket till Dataverse och omvandla dem till Dataverse poster.

API:et stöder för närvarande följande funktioner:

  • Insamling av både enskilda och blandade resurspaket. Ett enda resurspaket innehåller endast en resurstyp, medan ett blandat paket innehåller flera resurstyper.
  • Insamling av batchbunttyper. Mer information finns i Pakettyper som stöds.
  • Insamling av paket med URN-referens (Uniform Resource Name).
  • Säkerställa referensintegriteten for FHIR-paket – En resurs skapas endast i Dataverse om alla referenser matchas.
  • Skapa utökade poster för varje FHIR-resurs i Dataverse.
  • Skapa kodbara koncept när de saknas i Dataverse.
  • Och lokaliserade svar.

Upserta paket-API (msind_UpsertBundle) har två begäransparametrar definierade enligt följande:

Begär parameter Beskrivning
msind_JSON FHIR-paketet som måste infogas (obligatoriskt värde).
msind_BundleTag En tagg som hjälper till att identifiera paketen vid parsning av loggarna i Dataverse (valfritt värde).

För att lära dig hur du anropar API:et och granska några vanliga användningsscenarier, gå till Anropa upsert bundle API från webb-API.

Efter API-anrop kan du förvänta dig följande element i JSON-svaret:

Svarsparameter Beskrivning
msind_Status En boolesk som anger om paketet har bearbetats korrekt och om alla giltiga resurser har infogats i Dataverse.
msind_StatusDetail Ger detaljerad information om msind_Status-värdet.
msind_fhirresourceid FHIR-ID för resursen i paketet. Om en post i resultatet hör till en utökad post är värdet FHIR-ID för rotresursen.
msind_fhirresourcetype FHIR-resurstypen för resursen i paketet. Om en post i resultatet hör till en utökad post är värdet FHIR resurstyp för rotresursen.
msind_resultingrecordid Dataverse ID efter att posten upsert. Om en post i resultatet hör till en utökad post är värdet Dataverse ID för rotresursen.
msind_resultingrecordtype Namnet på entiteten Dataverse som posten har upsert till. Om en post i resultatet hör till en utökad post är värdet namnet på Dataverse entiteten för den utökade posten.
msind_requestactionperformed Typ av utförd åtgärd. Om du vill visa de förväntade värdena och deras beskrivning går du till Typer av begäransåtgärder som utförs.
msind_requeststatus Status för begäran. Om du vill visa de förväntade värdena och deras beskrivning går du till Typer av begäransstatus.
msind_requeststatusdetail Detaljerad information om msind_requeststatus-värdet.

Typer av begäransåtgärder som utförs

I följande tabell visas vilka värden som förväntas för svarsparameter msind_requestactionperformed:

Värde Beskrivning
935000000 En rotresurs har skapats.
935000001 En rotresurs som redan finns i Dataverse har uppdaterats.
935000002 Åtgärden utfördes på en utökad enhet.

Typer av begäran status

I följande tabell visas vilka värden som förväntas för svarsparameter msind_requeststatus:

Värde Beskrivning
935000000 Resurs upsert har lett till en framgång.
935000001 Resurs upsert har lett till en varning.
935000002 Resurs upsert har lett till ett fel.

Pakettyper som stöds

API för upsert-paket stöder för närvarande endast paket av typen batch och batchsvar. Om du försöker ta in paket av de typer som inte stöds måste du ändra typen på paketet som du skickar. Om du vill ändra pakettypen till batch innan du publicerar i API:er kan du ändra pakettypen med hjälp av den inbyggda ersättningsåtgärden i logik-appen. I det här steget bearbetas paketet som en grupp oberoende åtgärder.

När du ändrar pakettypen till batch är det viktigt att tänka på vilken effekt detta kan ha på de enskilda scenarierna. Om du ändrar ett transaktionspaket till batch kan detta få oönskade effekter på de data som du försöker föra in i Dataverse. Mer information om reglerna för att använda dessa paket finns i HL7 FHIR - Använda paket.

Om du skickar ett paket av typen batch-response, kommer Dataverse Healthcare API loggresurser av typen OperationOutcome med allvarlighetsvärdet error till loggar. Med den här åtgärden kan du posta paketet på en FHIR-server och skicka FHIR-serverns svar till Dataverse Healthcare API. Det här innebär att du kan registrera alla fel på en och samma plats.

Hämta paket API

Med hämtningspaketets API kan du fråga Dataverse om en enda FHIR-resurs med hjälp av FHIR ID. API omvandlar begäran och använder verktygen för dataintegrering för att svara på en FHIR-standardiserad resurs.

API:et stöder för närvarande följande funktioner:

  • Söka efter en enskild post med hjälp av FHIR ID.
  • Omfattande och lokaliserad loggning.

API:et för att hämta paketet (msind_RetrieveBundle) har en begäran parameter definierad enligt följande:

Begär parameter Beskrivning
msind_FHIRQuery FHIR-frågan som ska köras (obligatoriskt värde).

FHIR-frågor som stöds

Fråga Beskrivning
FHIRResource/FHIRID Frågan returnerar hela resursen tillsammans med de utökade entiteterna.
FHIRResource/FHIRId?_elements=element_1,element_2,...,element_n Frågan returnerar de element som angetts i frågan tillsammans med element som markerats som Obligatoriskt FHIR på attributmappningen.

För mer information, gå till FHIR element sökning.

För att lära dig hur du anropar API:et och granska några vanliga användningsscenarier, gå till Anropa hämta bundle API från webb-API.

Kommentar

Framtida Dataverse Healthcare API-versioner innehåller information om hur du hämtar ytterligare FHIR-resurser och ytterligare filtreringsfunktioner.

Efter API-anrop kan du se ett svar som innehåller status för den fullständiga förfrågan och detaljerad status för varje resurs och dess expanderade element.

Svarsparameter Beskrivning
msind_Status Ett boooleskt värde som anger om åtgärden har behandlats.
msind_StatusDetail Ger detaljerad information om msind_Status-värdet.
msind_JSON FHIR JSON-representation.

Information om hur du konfigurerar Dataverse Healthcare APIs, gå till Konfigurera Dataverse Healthcare APIs.

Se även

Vad är Microsoft Cloud for Healthcare?
Översikt över Verktygslåda för dataintegrering
Översikt över tillbakaskrivning för Dataverse Healthcare APIs
Konfigurera Dataverse Healthcare APIs
Använda Dataverse Healthcare APIs