Overzicht van Dataverse Healthcare APIs
De Dataverse Healthcare APIs zijn een volledig productaanbod van Microsoft Cloud for Healthcare waarmee u kunt communiceren met Dataverse door gebruik te maken van de FHIR-standaard. De API's gebruiken de toewijzingen van de Gegevensintegratietoolkit om de bundels tussen FHIR en Dataverse te transformeren.
Deze API's zijn geïmplementeerd als Dataverse-API's die zijn ontworpen om FHIR-bundels als invoerparameters te accepteren. De API's zorgen voor het toewijzen en transformeren van individuele FHIR-resources en posten de resulterende records in Dataverse. U kunt deze eindpunten verifiëren en beveiligen zoals u dat met de standaard Dataverse-API's zou doen.
Notitie
Voor meer informatie over standaard Dataverse-API's, gaat u naar Aangepaste API's maken en gebruiken.
De Dataverse Healthcare APIs kunnen worden gebruikt om:
- Op FHIR gebaseerde gegevens rechtstreeks in Dataverse te posten.
- Dataverse met externe FHIR-services zoals Azure Health Data Services te synchroniseren.
Deze API's vormen in combinatie met Azure Logic Apps de vervanging van Microsoft Cloud for Healthcare voor de Azure-hulpprogramma's voor FHIR-synchronisatieagenten die buiten gebruik zijn gesteld.
Belangrijk
Met ingang van oktober 2023 is Azure FHIR-synchronisatieagent officieel buiten gebruik gesteld. Het wordt niet opgenomen in de gegevensintegratietoolkit en wordt niet ondersteund als een Microsoft Cloud for Healthcare-oplossing.
Het gebruik van de meegeleverde logische app is geen vereiste voor het gebruik van de Dataverse Healthcare APIs. U kunt uw eigen Azure Logic App bouwen, Power Automate gebruiken, of uw eigen aangepaste code ontwikkelen. Er is ook geen vereiste om gegevens te synchroniseren met een externe FHIR-service. U kunt met FHIR-eindpunten van Azure Health Data Services synchroniseren of gegevens rechtstreeks in de API's posten. De Dataverse Healthcare APIs zijn bedoeld als een flexibel onderdeel dat kan worden gebruikt voor het ontwerpen van uw oplossingen voor gezondheidszorg rond Microsoft Cloud for Healthcare.
| Sectie | Inhoud |
|---|---|
| Dataverse Healthcare APIs | Vat informatie samen over de API's die momenteel beschikbaar zijn als onderdeel van de Dataverse Healthcare APIs. |
| Overzicht van terugschrijfoplossing voor Dataverse Healthcare APIs | Geeft uitleg over het terugschrijfproces voor Dataverse Healthcare APIs. |
| Dataverse Healthcare APIs configureren | Bevat stappen voor het configureren van de Dataverse Healthcare APIs. |
| Azure Logic App configureren met een HTTP-trigger | Bevat een gedetailleerde stapsgewijze handleiding voor het maken van uw eigen logische app om FHIR-gegevens op te nemen in Dataverse Healthcare APIs, Azure Health Data Services of beide. |
| Pipelinesjabloon voor gezondsheidsgegevens gebruiken om Azure Logic Apps te implementeren. | Biedt een stapsgewijze handleiding voor het gebruik van een sjabloon om een groep Logic Apps te implementeren die de opname van FHIR-bundels in Dataverse Healthcare APIs en Azure Health Data Services indelen |
| De Dataverse Healthcare APIs gebruiken | Vat samen hoe u de Dataverse Healthcare APIs kunt oproepen, met enkele voorbeelden en veelvoorkomende gebruiksscenario's. |
| Dataverse Healthcare API-logboeken controleren | Legt uit hoe u de transactielogboeken voor Dataverse Healthcare API-activiteiten kunt controleren. |
Dataverse Healthcare APIs
De volgende API's zijn momenteel beschikbaar als onderdeel van de Dataverse Healthcare APIs:
- Upsert-bundel-API
- Ophaalbundel-API
Upsert-bundel-API
Met de upsert-bundel-API kunnen FHIR-bundels naar Dataverse worden verzonden en naar Dataverse-records worden getransformeerd.
De API ondersteunt momenteel het volgende:
- Opname van zowel enkele als gemengde resourcebundels. Een enkele resourcebundel bevat slechts één resourcetype, terwijl een gemengde bundel meerdere resourcetypen bevat.
- Opname van batchbundeltypen. Ga voor meer informatie naar Ondersteunde typen bundels.
- Opname van bundels met URN-referentie (Uniform Resource Name).
- Zorgen voor de referentiële integriteit van FHIR-bundels – een resource wordt alleen gemaakt in Dataverse als alle bijbehorende verwijzingen zijn opgelost.
- Het maken van uitgebreide records voor elke FHIR-resource in Dataverse.
- Het maken van codeable concepts wanneer ze ontbreken in Dataverse.
- Uitgebreide en gelokaliseerde responsen.
De upsert-bundel-API (msind_UpsertBundle) heeft twee verzoekparameters die als volgt zijn gedefinieerd:
| Aanvraagparameter | Omschrijving |
|---|---|
| msind_JSON | De FHIR-bundel die moet worden ingevoegd (vereiste waarde). |
| msind_BundleTag | Een tag die helpt bij het identificeren van de bundels bij het parseren van de aanmeldingen in Dataverse (optionele waarde). |
Ga voor meer informatie over het aanroepen van de API en het bekijken van enkele veelvoorkomende gebruiksscenario's naar De upsert-bundel-API aanroepen vanuit de web-API.
Na het aanroepen van de API kunt u de volgende elementen verwachten in het JSON-antwoord:
| Responsparameter | Omschrijving |
|---|---|
| msind_Status | Een booleaanse waarde die aangeeft of de bundel met succes is verwerkt en of alle geldige resources zijn ingevoegd in Dataverse. |
| msind_StatusDetail | Levert gedetailleerde informatie over de waarde msind_Status. |
| msind_fhirresourceid | De FHIR-id van de resource in de bundel. Als een vermelding in het resultaat betrekking heeft op een uitgevouwen record, is de waarde de FHIR-id die van de hoofdresource. |
| msind_fhirresourcetype | Het FHIR-resourcetype van de resource in de bundel. Als een vermelding in het resultaat betrekking heeft op een uitgevouwen record, is de waarde het FHIR-resourcetype die van de hoofdresource. |
| msind_resultingrecordid | De Dataverse-id nadat het record is ingevoegd. Als een vermelding in het resultaat betrekking heeft op een uitgevouwen record, is de waarde de Dataverse-id die van de hoofdresource. |
| msind_resultingrecordtype | De naam van de Dataverse-entiteit waar de record is ingevoegd. Als een vermelding in het resultaat betrekking heeft op een uitgevouwen record, is de waarde de naam van de Dataverse-entiteit van het uitgebreide record. |
| msind_requestactionperformed | Het type uitgevoerde actie. Ga naar Typen uitgevoerde verzoekacties om de verwachte waarden en hun beschrijving te bekijken. |
| msind_requeststatus | De status van de aanvraag. Ga naar Typen verzoekstatussen om de verwachte waarden en hun beschrijving te bekijken. |
| msind_requeststatusdetail | Gedetailleerde informatie over de waarde msind_requeststatus. |
Soorten uitgevoerde aanvraagacties
De volgende tabel bevat de verwachte waarden voor de responsparameter msind_requestactionperformed:
| Weergegeven als | Omschrijving |
|---|---|
| 935000000 | Er is een hoofdresource gemaakt. |
| 935000001 | Een hoofdresource die al bestaat in Dataverse is bijgewerkt. |
| 935000002 | De actie is uitgevoerd op een uitgebreide entiteit. |
Typen aanvraagstatus
De volgende tabel bevat de verwachte waarden voor de responsparameter msind_requeststatus:
| Weergegeven als | Omschrijving |
|---|---|
| 935000000 | De resource-upsert resulteerde in een succes. |
| 935000001 | De resource-upsert resulteerde in een waarschuwing. |
| 935000002 | De resource-upsert resulteerde in een fout. |
Ondersteunde typen bundels
De upsert bundel-API ondersteunt momenteel alleen bundels van het type batch en batch-respons. Als u bundels probeert op te nemen van de typen die niet worden ondersteund, moet u het type wijzigen in de bundel die u indient. Als u het bundeltype wilt wijzigen in batch voordat u naar de API's post, kunt u de ingebouwde logische app actie vervangen gebruiken om het bundeltype te wijzigen. Deze stap verwerkt de bundel als een groep onafhankelijke acties.
Wanneer u het bundeltype wijzigt in batch, is het belangrijk om zorgvuldig na te denken over het effect dat dit kan hebben op uw individuele scenario's. Het wijzigen van een transactiebundel in batch kan ongewenste effecten hebben op de gegevens die u probeert op te nemen in Dataverse. Ga voor meer informatie over de regels voor het gebruik van deze bundels naar HL7 FHIR - bundels gebruiken.
Als u een bundel indient van het type batchrespons, registreert de Dataverse Healthcare API resources van het type OperationOutcome met urgentiewaarde error in de logboeken. Met deze actie kunt u de bundel naar een FHIR-server posten en het antwoord van de FHIR-server naar de Dataverse Healthcare API leiden. Als gevolg hiervan kunt u alle fouten op één plek vastleggen.
Ophaalbundel-API
Met de ophaalbundel-API kunt u query's uitvoeren op Dataverse voor één FHIR-resource met de FHIR-id. De API transformeert het verzoek en gebruikt de toewijzingen van de Gegevensintegratietoolkit om te reageren met een gestandaardiseerde FHIR-resource.
De API ondersteunt momenteel het volgende:
- Query's uitvoeren voor één record met behulp van FHIR-id′s.
- Uitgebreide en gelokaliseerde logboekregistratie.
De ophaalbundel-API (msind_RetrieveBundle) heeft één verzoekparameter die als volgt is gedefinieerd:
| Aanvraagparameter | Omschrijving |
|---|---|
| msind_FHIRQuery | De uit te voeren FHIR-query (vereiste waarde). |
Ondersteunde FHIR-query's
| Query | Omschrijving |
|---|---|
| FHIRResource/FHIRID | De query retourneert de volledige resource samen met de uitgebreide entiteiten. |
| FHIRResource/FHIRId?_elements=element_1,element_2,...,element_n | De query retourneert de elementen die in de query zijn gespecificeerd samen met alle elementen die zijn gemarkeerd als FHIR vereist in de kenmerktoewijzing. Ga voor meer informatie naar FHIR-element zoeken. |
Ga voor meer informatie over het aanroepen van de API en het bekijken van enkele veelvoorkomende gebruiksscenario's naar De ophaalbundel-API aanroepen vanuit de web-API.
Notitie
Toekomstige Dataverse Healthcare API-releases omvatten investeringen voor het ophalen van aanvullende FHIR-bronnen en aanvullende filtermogelijkheden.
Nadat de API is aangeroepen, kunt u een respons zien met de status van het volledige verzoek en de gedetailleerde status van elke resource en de bijbehorende uitgevouwen elementen.
| Responsparameter | Omschrijving |
|---|---|
| msind_Status | Een booleaanse waarde die aangeeft of de actie is verwerkt. |
| msind_StatusDetail | Levert gedetailleerde informatie over de waarde msind_Status. |
| msind_JSON | FHIR JSON-weergave. |
Ga voor informatie over het configureren van de Dataverse Healthcare APIs naar Dataverse Healthcare APIs configureren.
Zie ook
Wat is Microsoft Cloud for Healthcare ?
Overzicht van de gegevensintegratietoolkit
Overzicht van terugschrijven voor Dataverse Healthcare APIs
Dataverse Healthcare APIs configureren
De Dataverse Healthcare APIs gebruiken