Dataverse Healthcare API ‑ohjelmointirajapintojen yleiskatsaus

Dataverse Healthcare API -ohjelmointirajapinnat ovat täydellinen Microsoft Cloud for Healthcare -tuotevalikoima, joka mahdollistaa Dataversen käyttämisen FHIR-standardin mukaisesti. 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.

Huomautus

Lisätietoja Dataversen vakio-ohjelmointirajapinnoista on kohdassa 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.

Yhdessä nämä ohjelmointirajapinnat ja Azure Logic Apps korvaavat Microsoft Cloud for Healthcaressa Azure FHIR -synkronointiagentin työkalut, jotka on poistettu käytöstä.

Tärkeää

Vuoden 2023 lokakuusta alkaen Azure FHIR -synkronointiagentti on ollut virallisesti pois käytöstä. Sitä ei sisällytetä tietojen integroinnin työkalupakettiin, eikä sitä tueta Microsoft Cloud for Healthcare -ratkaisuna.

Toimitetun logiikkasovelluksen käyttäminen ei ole Dataverse Healthcare API -ohjelmistorajapintojen käytön edellytys. Vaihtoehtoina on Azuren oman logiikkasovelluksen muodostaminen, Power Automaten käyttäminen tai oman mukautetun koodin kehittäminen. Tietoja ei ole pakko synkronoida ulkoisen FHIR-palvelun kanssa. Synkronointi voidaan tehdä Azure Health -tietopalvelujen FHIR-päätepisteiden kanssa, tai tiedot vodaan lähettää suoraan ohjelmointirajapintoihin. Dataverse Healthcare API -ohjelmointirajapinnat on suunniteltu joustavaksi osaksi, jota voidaan käyttää omien Microsoft Cloud for Healthcareen liittyvien terveydenhuoltoratkaisuun suunnitteluun.

osa	Sisältö
Dataverse Healthcare API -ohjelmointirajapinnat	Yhteenveto tällä hetkellä Dataverse Healthcare API -ohjelmistorajapintojen kanssa saatavana olevia ohjelmistorajapintoja koskevista tiedoista.
Dataverse Healthcare API -ohjelmointirajapintojen takaisinkirjoituksen yleiskatsaus	Selittää Dataverse Healthcare API -ohjelmointirajapintojen takaisinkirjoitusprosessin.
Dataverse Healthcare API -ohjelmointirajapintojen määrittäminen	Sisältää Dataverse Healthcare API -ohjelmointirajapintojen määritysvaiheet.
Azuren logiikkasovelluksen määrittäminen HTTP-käynnistimen avulla	Sisältää yksityiskohtaiset, vaiheittaiset ohjeet oman Azuren logiikkasovelluksen määrittämiselle, jotta FHIR-tietoja käsitellään Dataverse Healthcare API -ohjelmointirajapinnoissa, Azure Health -tietopalveluissa tai molemmissa.
Healthcare API -ohjelmointirajapinnat: Käytä terveydenhoidon tietoputken mallia Azure Logic Appsin käyttöönotossa	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	Yhteenveto Dataverse Healthcare API -ohjelmointirajapintojen käynnistämisestä ja käyttämisestä sekä esimerkkejä ja yleisiä käyttöskenaarioita.
Dataverse Healthcare API -lokien tarkasteleminen	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.
• Pakettien käsittely käyttäen Uniform Resource Name (URN) -viitettä.
• FHIR-pakettien viite-eheyden varmistaminen – resurssi luodaan Dataversessä vasta, kun kaikki sen viitteet on ratkaistu.
• Laajennettujen tietueiden luominen kullekin FHIR-resurssille Dataversessä.
• Codeable conceptin luonti, kun ne puuttuvat Dataversestä.
• Yksityiskohtaiset ja lokalisoidut vastaukset.

upsert-paketin ohjelmointirajapinnassa (msind_UpsertBundle) on kaksi parametria, joilla on seuraavat määritelmät:

Pyyntöparametri	Kuvaus
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 upsert-toiminnon 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	Kuvaus
935000000	Pääresurssi on luotu.
935000001	Aiemmin luotua pääresurssia on päivitetty Dataversessä.
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-pakettiohjelmointirajapinta tukee tällä hetkellä vain erä- ja erävastaus-paketteja. Jos sellaisten tyyppien paketteja yritetään käsitellä, joita ei tueta, lähetettävän paketin tyyppi on vaihdettava. 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 erillisten toimintojen ryhmänä.

Kun muutat paketin tyypiksi Erä, on tärkeä ottaa huomioon, että muutos voi vaikuttaa yksittäisiin skenaarioihin. 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 errorlokeihin. 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.

retrieve-paketin ohjelmointirajapinnassa (msind_UpsertBundle) on yksi pyyntöparametri, joilla on seuraava määritelmä:

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

Tuetut FHIR-kyselyt

Kysely	Kuvaus
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.

Huomautus

Tulevat Dataverse Healthcare API -sisältävät panostuksia muiden FHIR-resurssien noutamiseen ja suodatuksen lisäominaisuuksiin.

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.

Lisätietoja Dataverse Healthcare API -ohjelmointirajapintojen määrittämisestä on kohdassa Dataverse Healthcare API -ohjelmointirajapintojen määrittäminen.

Katso myös

Mikä on Microsoft Cloud for Healthcare?
Tietojen integroinnin työkalupaketin yleiskatsaus
Dataverse Healthcare API -ohjelmointirajapintojen takaisinkirjoituksen yleiskatsaus
Dataverse Healthcare API -ohjelmointirajapintojen määrittäminen
Dataverse Healthcare -API -ohjelmointirajapintojen käyttäminen