Jaa

Dataverse Healthcare API ‑ohjelmointirajapintojen yleiskatsaus

  • Artikkeli

Dataverse Healthcare API -ohjelmointirajapinnat ovat täysi tuotetarjooma Microsoft Cloud for Healthcarelta, joka mahdollistaa vuorovaikutuksen Dataversen kanssa käyttämällä FHIR (Fast Health Interoperability Resources) -standardia. Ohjelmointirajapinnat käyttävät tietojen integroinnin työkalupaketin yhdistämismäärityksiä pakettien muuntamiseen FHIR:n ja Dataversen välillä.

Nämä ohjelmointirajapinnat toteutetaan Dataverse-ohjelmointirajapintoina, jotka on suunniteltu hyväksymään FHIR-paketit syöteparametreina. Ohjelmointirajapinnat käsittelevät yksittäisten FHIR-resurssien yhdistämisen ja muunnon sekä lähettävät tuloksena olevat tietueet Dataverseen. Näitä päätepisteitä voidaan käyttää todentamiseen ja ne voidaan suojata samalla tavoin kuin Dataversen vakio-ohjelmointirajapinnat.

Muistiinpano

Lisätietoja vakiomuotoisista Dataverse-ohjelmointirajapinnoista: Mukautettujen ohjelmointirajapintojen luominen ja käyttäminen.

Dataverse Healthcare API -ohjelmointirajapintojen avulla voidaan

  • lähettää FHIR-pohjaisia tietoja suoraan Dataverseen
  • synkronoida Dataverse ja ulkoiset FHIR-palvelut, kuten Azure Health -tietopalvelut.

Nämä ohjelmointirajapinnat yhdessä Azure Logic Appsin kanssa muodostavat Microsoft Cloud for Healthcaren korvaajan käytöstä poistetuille Azuren FHIR-synkronointiagenttityökaluille.

Käyttöön annettua logiikkasovellusta ei tarvita Dataverse Healthcare API -ohjelmointirajapintojen käyttöön. Voit luoda oman logiikkasovelluksesi käyttämällä Power Automatea tai kehittämällä oman mukautetun koodisi. Tietoja ei ole pakko synkronoida ulkoisen FHIR-palvelun kanssa. Voit suorittaa synkronoinnin Azure Health -tietopalvelujen FHIR-päätepisteiden kanssa tai julkaista tietoja suoraan ohjelmointirajapintoihin. Dataverse Healthcare API -ohjelmointirajapinnat on suunniteltu joustavaksi osaksi, jota voidaan käyttää omien Microsoft Cloud for Healthcareen liittyvien terveydenhuoltoratkaisuun suunnitteluun.

osa Content
Dataverse Healthcare API -ohjelmointirajapinnat Luo yhteenvedon niitä ohjelmointirajapintoja koskevista tiedoista, jotka kulloinkin ovat käytettävissä osana Dataverse Healthcare API -ohjelmointirajapintoja.
Dataverse Healthcare API -ohjelmointirajapintojen takaisinkirjoituksen yleiskatsaus Selittää Dataverse Healthcare API -ohjelmointirajapintojen takaisinkirjoitusprosessin.
Dataverse Healthcare API -ohjelmointirajapintojen määritys Sisältää Dataverse Healthcare API -ohjelmointirajapintojen määritysvaiheet.
Azure-logiikkasovelluksen määrittäminen HTTP-käynnistimellä Sisältää yksityiskohtaisen vaiheittaisen oppaan sellaisen oman logiikkasovelluksen luomiseen, joka voi käsitellä FHIR-tietoja Dataverse Healthcare API -ohjelmointirajapinnoissa, Azure Health -tietopalveluissa tai molemmissa.
Azure-logiikkasovellusten käyttöönotto terveydenhoidon tietoputken mallin avulla Sisältää vaiheittaiset ohjeet mallin käyttämiselle, kun otetaan käyttöön Logic Apps -ryhmä, joka käsittelee FHIR-paketteja Dataverse Healthcare API -ohjelmointirajapinnoissa, Azure Health -tietopalveluissa tai molemmissa.
Dataverse Healthcare API -ohjelmointirajapintojen käyttäminen Luo yhteenvedon siitä, miten Dataverse Healthcare API -ohjelmointirajapintoja käynnistetään ja käytetään, ja sisältää esimerkkejä ja yleisiä käyttöskenaarioita.
Dataverse Healthcare API -ohjelmointirajapintalokien tarkastaminen Selittää, miten Dataverse Healthcare API -toimintojen tapahtumalokeja tarkastellaan.

Dataverse Healthcare API -ohjelmointirajapinnat

Seuraavat ohjelmointirajapinnat ovat tällä hetkellä saatavana Dataverse Healthcare API -ohjelmistorajapintojen osana:

  • Upsert-paketin ohjelmointirajapinta
  • Paketin noutamisen ohjelmointirajapinta

Upsert-paketin ohjelmointirajapinta

Upsert-paketin ohjelmointirajapinta mahdollistaa FHIR-pakettien lähettämisen Dataverseen ja niiden muuntamisen Dataverse-tietueiksi.

Ohjelmointirajapinta tukee tällä hetkellä seuraavia ominaisuuksia:

  • Sekä yhden että useamman resurssin pakettien käsittely. Yksi resurssipaketti sisältää vain yhden resurssityypin, kun tässä yhdistelmäpaketti sisältää useita resurssityyppejä.
  • Eräpakettityyppien käsittely. Lisätietoja on Tuetut pakettityypit käsittelevässä ohjeessa.
  • Uniform Resource Name (URN) -viitteitä sisältävien pakettien käsittely.
  • FHIR-pakettien viite-eheys – resurssi luotaisiin Dataversessä vain, jos kaikki sen viitteet on ratkaistu.
  • Laajennettujen tietueiden luominen kullekin FHIR-resurssille Dataversessä.
  • Codeable conceptin luonti, kun ne puuttuvat Dataversestä.
  • Yksityiskohtaiset ja lokalisoidut vastaukset.

Ohjelmointirajapinnalla (msind_UpsertBundle) on kaksi pyyntöparametria, jotka on määritetty seuraavasti:

Pyyntöparametri Description
msind_JSON Lisättävä FHIR-paketti (pakollinen arvo).
msind_BundleTag Tunniste, joka auttaa tunnistamaan paketit jäsennettäessä lokeja Dataversessa (valinnainen arvo).

Lisätietoja ohjelmointirajapinnan käynnistämisestä ja joistakin yleisistä käyttöskenaarioista on kohdassa upsert-paketin ohjelmointirajapinnan kutsuminen verkko-ohjelmointirajapinnasta.

Ohjelmointirajapinnan kutsuminen jälkeen JSON-vastauksessa voidaan odottaa olevan seuraavia elementtejä:

Vastausparametri Kuvaus
msind_Status Totuusarvo ilmaisee, onnistuiko paketin käsittely ja kaikkien kelvollisten resurssien upsert-toiminto Dataverseen.
msind_StatusDetail Sisältää tarkkoja tietoja msind_Status-arvosta.
msind_fhirresourceid Paketin resurssin FHIR ID. Jos tuloksessa oleva merkintä koskee laajennettua tietuetta, arvo on pääresurssin FHIR ID.
msind_fhirresourcetype Paketin resurssin FHIR-resurssityyppi. Jos tuloksessa oleva merkintä koskee laajennettua tietuetta, arvo on pääresurssin FHIR-resurssityyppi.
msind_resultingrecordid Dataverse-tunnus tietueen päivittämisen ja lisäämisen jälkeen. Jos tuloksessa oleva merkintä koskee laajennettua tietuetta, arvo on pääresurssin Dataverse-tunnus.
msind_resultingrecordtype Sen Dataverse-entiteetin nimi, johon tietue lisättiin upsert-toiminnolla. Jos tuloksessa oleva merkintä koskee laajennettua tietuetta, arvo on laajennetun Dataverse-entiteetin nimi.
msind_requestactionperformed Suoritetun toiminnon tyyppi. Lisätietoja odotetuista arvoista ja niiden kuvauksista on kohdassa Suoritettujen pyyntötoimintojen tyypit.
msind_requeststatus Pyynnön tila. Lisätietoja odotetuista arvoista ja niiden kuvauksista on kohdassa Pyynnön tilatyypit.
msind_requeststatusdetail Tarkkoja tietoja msind_requeststatus-arvosta.

Suoritettavien pyyntötoimintojen tyypit

Seuraavassa taulukossa on msind_requestactionperformed-vastausparametrin odotetut arvot:

Arvo Description
935000000 Juuriresurssi luodaan.
935000001 Dataversessä jo oleva juuriresurssi päivitetään.
935000002 Toiminto suoritettiin laajennetulle entiteetille.

Pyyntötilan tyypit

Seuraavassa taulukossa on msind_requeststatus-vastausparametrin odotetut arvot:

Arvo Kuvaus
935000000 Resurssin upsert onnistui.
935000001 Resurssin upsertin tuloksena oli varoitus.
935000002 Resurssin upsertin tuloksena oli virhe.

Tuetut pakettityypit

Upsert-paketin ohjelmointirajapinta tukee tällä hetkellä tyyppien erä ja erävastaus paketteja. Jotta voit käsitellä sellaisten tyyppien paketteja, joita ei tueta, sinun on aluksi muutettava lähetettävän paketin tyyppiä. Jos haluat vaihtaa paketin tyypin eräksi ennen niiden lähettämistä ohjelmointirajapinnille, voit muuttaa paketin tyyppiä käyttämällä logiikkasovelluksen sisäistä korvaustoimintoa. Tämä vaihe käsittelee paketin itsenäisten toimintojen ryhmänä.

Kun vaihdat paketin tyypiksi erä, on tärkeää ottaa huomioon vaikutukset, jotka tällä voi olla yksittäisiin skenaarioihisi. Tapahtumapaketin muuttamisella eräksi voi olla ei-toivottuja vaikutuksia tietoon, joita yritetään tuoda Dataverseen. Lisätietoja näiden pakettien käyttösäännöistä on ohjeaiheessa HL7 FHIR – pakettien käyttäminen.

Jos erä-vastaus-tyyppinen paketti lähetetään, Dataverse Healthcare API kirjaa OperationOutcome-tyypin resurssin ja vakavuusasteen arvon error lokeihin. Tämä toiminto mahdollistaa paketin lähettämisen FHIR-palvelimeen ja putken FHIR-palvelimesta saadun vastauksen lähettämiseen Dataverse Healthcare API -ohjelmointirajapintaan. Niinpä kaikki virheet voidaan siepata samassa paikassa.

Paketin noutamisen ohjelmointirajapinta

Pakettien noutamisen ohjelmointirajapinnan avulla voit kysellä Dataverseltä yksittäistä FHIR-resurssia FHIR-tunnuksen avulla. Ohjelmointirajapinta muuntaa pyynnön ja käyttää tietojen integroinnin työkalupaketin yhdistämismäärityksen vastaamiseen standardoidun FHIR-resurssin avulla.

Ohjelmointirajapinta tukee tällä hetkellä seuraavia ominaisuuksia:

  • Yhden tietueen kysely käyttämällä FHIR ID:tä.
  • Yksityiskohtaiset ja lokalisoidut kirjaukset lokeihin.

Ohjelmointirajapinnalla (msind_RetrieveBundle) on yksi pyyntöparametri, joka on määritetty seuraavasti:

Pyyntöparametri Description
msind_FHIRQuery Suoritettava FHIR-kysely (pakollinen arvo).

Tuetut FHIR-kyselyt

Query Description
FHIRResource/FHIRID Kysely palauttaa koko resurssin ja sen laajennetut entiteetit.
FHIRResource/FHIRId?_elements=element_1,element_2,...,element_n Kysely palauttaa kyselyssä määritetyt elementit sekä kaikki määritteet, joilla on määritekartassa merkintä FHIR vaaditaan.

Lisätietoja on kohdassa FHIR-elementtien haku.

Lisätietoja ohjelmointirajapinnan käynnistämisestä ja joistakin yleisistä käyttöskenaarioista on kohdassa retrieve-paketin ohjelmointirajapinnan kutsuminen verkko-ohjelmointirajapinnasta.

Ohjelmointirajapinnan kutsumisen jälkeen nähdään vastaus, joka sisältää valmiin pyynnön tilan sekä kunkin resurssin ja sen laajennettujen elementtien yksityiskohtaisen tilan.

Vastausparametri Kuvaus
msind_Status Totuusarvo ilmaisee, onnistuiko toiminnon käsittely.
msind_StatusDetail Sisältää tarkkoja tietoja msind_Status-arvosta.
msind_JSON FHIR JSON -esitys.