Del via

Oversigt over Dataverse Healthcare API'er

  • Artikel

Dataverse healthcare API'er er et komplet produkttilbud fra Microsoft Cloud for Healthcare, som giver dig mulighed for at kommunikere med Dataverse ved hjælp af FHIR-standarden (Fast Health Interoperability Resources). API'erne bruger dataintegrationsværktøjssæt-tilknytningerne til at transformere bundterne mellem FHIR og Dataverse.

Disse API'er implementeres som Dataverse API'er , der er udviklet til at acceptere FHIR-bundter som inputparametre. API'erne håndterer tilknytningen og transformeringen af de enkelte FHIR-ressourcer og sender posterne til Dataverse. Du kan godkende og sikre disse slutpunkter på samme måde som med standard Dataverse-API'er.

Bemærk

Hvis du vil vide mere om standard-API'er Dataverse, skal du gå til Oprette og bruge brugerdefinerede API'er.

Dataverse healthcare API'er til behandling kan bruges til at:

  • Post FHIR-baserede data direkte i Dataverse.
  • Synkroniser Dataverse med eksterne FHIR-tjenester, f.eks. Azure Health Data Services.

Disse API'er kombineres med Azure Logic Apps udgør Microsoft Cloud for Healthcare-erstatning for den udfasede Azure FHIR-synkroniseringsagentværktøj.

Brug af den medfølgende logikapp er ikke påkrævet ved brug af Dataverse healthcare API. Du kan opbygge din egen Logikapp, bruge Power Automate eller udvikle din egen brugerdefinerede kode. Det er heller ikke et krav, at data skal synkroniseres med en ekstern FHIR-tjeneste. Du kan synkronisere med Azure Health Data Services FHIR-slutpunkter eller sende data direkte i API'erne. Dataverse healthcare API'er er beregnet til at være en fleksibel komponent, der kan bruges til at designe dine sundhedsløsninger omkring Microsoft Cloud for Healthcare.

Afsnit Indhold
Dataverse Healthcare API'er Opsummerer oplysninger om de API'er, der i øjeblikket er tilgængelige som en del af Dataverse healthcare API'er.
Oversigt over tilbageskrivning til Dataverse Healthcare API'er I denne artikel forklares tilbageskriveprocessen for Dataverse healthcare API'er.
Konfigurer Dataverse Healthcare API'er Indeholder trin til konfiguration af Dataverse healthcare API'er.
Konfigurere Azure Logic App med en HTTP-udløser Indeholder en detaljeret trinvis vejledning i at oprette din egen Logikapp, der kan indeholde FHIR-data i Dataverse healthcare API'er, Azure Health Data Services eller begge dele.
Bruge pipelineskabelon til sundhedsdata til at udrulle Azure Logic Apps Indeholder en trinvis vejledning i, hvordan du bruger en skabelon til at installere en gruppe Logic Apps, der organiserer indtag af FHIR-bundter i Dataverse healthcare API'er og Azure Health-dataservices.
Bruge Dataverse Healthcare API'er Opsummerer, hvordan du aktiverer og bruger Dataverse healthcare API'er til behandling med eksempler og almindelige brugsscenarier.
Gennemse Dataverse Healthcare API-logfiler I denne artikel forklares, hvordan du gennemser transaktionslogfilerne for Dataverse healthcare API-aktiviteter.

Dataverse Healthcare API'er

Følgende API'er er i øjeblikket tilgængelige som en del af Dataverse healthcare API'er:

  • Upsert bundt-API
  • Hent bundt-API

Upsert bundt-API

Upsert bundt-API'en gør det muligt at sende FHIR-bundter til Dataverse og transformere dem til Dataverse-poster.

API understøtter i øjeblikket følgende funktioner:

  • Indtagelse af både enkelt- og blandet ressourcebundter. En enkelt ressourcebundt indeholder kun én ressourcetype, mens en blandet ressourcetype indeholder flere ressourcetyper.
  • Indtagelse af batch-bundttyper. Du kan finde flere oplysninger i Understøttede bundttyper.
  • Bundter med URN-referencer (Uniform Resource Name).
  • Refererende integritet for FHIR-bundter – Der oprettes kun en ressource i Dataverse, hvis alle referencerne løses.
  • Oprettelse af udvidede poster for de enkelte FHIR-ressourcer i Dataverse.
  • Oprettelse af koncepter, der kan kodes, når de mangler i Dataverse.
  • Verbose og oversatte responser.

API'en (msind_UpsertBundle) har to anmodningsparametre defineret på følgende måde:

Parameter for anmodning Description
msind_JSON Det FHIR-bundt, der skal indsættes (påkrævet værdi).
msind_BundleTag En kode, der hjælper dig med at identificere bundterne, når du fortolker loggene i Dataverse (valgfri værdi).

Du kan få mere at vide om, hvordan du aktiverer API'en og gennemgår nogle almindelige brugsscenarier, i Aktivér upsert-bundtet med API fra web-API.

Efter API -kald kan du forvente følgende elementer i JSON-svaret:

Responsparameter Beskrivelse
msind_Status En boolesk værdi, der angiver, om bundtningen blev behandlet korrekt, og alle gyldige ressourcer blev upsert til Dataverse.
msind_StatusDetail Indeholder detaljerede oplysninger om msind_Status-værdien.
msind_fhirresourceid FHIR ID for ressourcen i bundtet. Hvis en post i resultatet vedrører en udvidet post, er værdien FHIR-id for rodressourcen.
msind_fhirresourcetype FHIR ID-ressourcetype for ressourcen i bundtet. Hvis en post i resultatet vedrører en udvidet post, er værdien FHIR-ressourcetype for rodressourcen.
msind_resultingrecordid Id'et Dataverse, når posten er blevet oprettet. Hvis en post i resultatet vedrører en udvidet post, er værdien Dataverse-id for rodressourcen.
msind_resultingrecordtype Navnet for Dataverse-objektet, som posten er upsert til, Hvis en post i resultatet vedrører en udvidet post, er værdien navnet på Dataverse-objektet for den udvidede post.
msind_requestactionperformed Typen af handling, der er udført. Hvis du vil have vist de forventede værdier og beskrivelsen af dem, skal du gå til Typer af handlinger, der udføres i forbindelse med anmodninger.
msind_requeststatus Status for anmodningen. Hvis du vil have vist de forventede værdier og beskrivelsen af dem, skal du gå til Typer af status for anmodninger.
msind_requeststatusdetail Detaljerede oplysninger om msind_requeststatus-værdien.

Typer af udførte anmodningshandlinger

I nedenstående tabel vises de forventede værdier for msind_requestactionperformed-svarparameteren:

Værdi Description
935000000 Der oprettes en rodressource.
935000001 En rodressource, der allerede findes i Dataverse, opdateres.
935000002 Handlingen blev udført på et udvidet objekt.

Typer af anmodningsstatus

I nedenstående tabel vises de forventede værdier for msind_requeststatus-svarparameteren:

Værdi Beskrivelse
935000000 Ressource-upsert resulterede i en succes.
935000001 Ressource-upsert resulterede i en advarsel.
935000002 Ressource-upsert resulterede i en fejl.

Understøttede bundttyper

Upsert bundle-API'en understøtter i øjeblikket bundter af typen batch og batchrespons. Ved indtagelse af bundter af de typer, der ikke understøttes, skal du først ændre den type bundt, du sender. Hvis du vil ændre bundttypen til batch, før du sender indlæg til API'erne, kan du bruge den handling til erstatning, der er indbygget i logikappen, til at ændre bundttypen. Dette trin behandler pakken som en gruppe af uafhængige handlinger.

Når du ændrer bundttypen til batch, er det vigtigt at overveje, hvilken effekt den kan have på de enkelte scenarier. Ændring af et transaktionsbundt til batch kan have uønsket effekt på de data, du forsøger at hente i Dataverse. Du kan finde flere oplysninger om reglerne for brug af disse bundter ved at gå til HL7 FHIR - Bruge bundter.

Hvis du sender en bundt af typen batchrespons, logfører Dataverse healthcare API-logfil-ressourcer af typen OperationOutcome med overensstemmelsesværdi error til -logfilerne. Du kan bruge denne handling til at sende bundtet til en FHIR-server og sende svaret fra FHIR-serveren til Dataverse healthcare API. Derfor kan du registrere alle fejlene på ét sted.

Hent bundt-API

Hent bundt-API'en giver dig mulighed for at forespørge Dataverse om en enkelt FHIR-ressource ved hjælp af FHIR-id. API'en transformerer anmodningen og bruger tilknytninger til dataintegrationsværktøjssættet til at reagere med en standardiseret FHIR-ressource.

API understøtter i øjeblikket følgende funktioner:

  • Der søges efter en enkelt post ved hjælp af FHIR-id.
  • Verbose og oversatte logfiler.

API'en (msind_RetrieveBundle) har et anmodningsparameter defineret på følgende måde:

Parameter for anmodning Description
msind_FHIRQuery FHIR-forespørgsel, der skal udføre (påkrævet værdi).

Understøttede FHIR-forespørgsler

Anmodning Description
FHIRResource/FHIRID Hele ressourcen returneres sammen med de udvidede objekter i forespørgslen.
FHIRResource/FHIRId?_elements=element_1,element_2,...,element_n I forespørgslen returneres de elementer, der er angivet i forespørgslen, sammen med de elementer, der er markeret som FHIR påkrævet på attributtilknytningen.

Du finder flere oplysninger i FHIR-elementsøgning.

Du kan få mere at vide om, hvordan du aktiverer API'en og gennemgår nogle almindelige brugsscenarier, i Aktivér det hentede upsert-bundt med API fra web-API.

Efter API-aktivering kan du se et svar, der indeholder statussen for den fuldstændige anmodning, samt den detaljerede status for hver enkelt ressource og dens udvidede elementer.

Responsparameter Beskrivelse
msind_Status En boolesk værdi, der angiver, om handlingen blev behandlet korrekt.
msind_StatusDetail Indeholder detaljerede oplysninger om msind_Status-værdien.
msind_JSON FHIR JSON-repræsentation.