Compartilhar via

Visão geral das Dataverse Healthcare APIs

  • Artigo

As Dataverse Healthcare APIs são uma oferta completa de produtos do Microsoft Cloud for Healthcare que permite que você interaja com o Dataverse usando o padrão FHIR (Fast Health Interoperability Resources). As APIs usam os mapas do kit de ferramentas de integração de dados para transformar os pacotes entre o FHIR e o Dataverse.

Essas APIs são implementadas como Dataverse APIs projetadas para aceitar pacotes FHIR como parâmetros de entrada. As APIs lidam com o mapeamento e a transformação de recursos FHIR individuais e publicam os registros resultantes no Dataverse. Você pode autenticar e proteger esses endpoints como faria com Dataverse APIs padrão.

Observação

Para saber mais sobre APIs padrão do Dataverse, acesse Criar e usar APIs personalizadas.

As Dataverse Healthcare APIs não podem ser usadas para:

  • Publicar dados baseados em FHIR diretamente no Dataverse.
  • Sincronizar o Dataverse com serviços FHIR externos, como Serviços de Dados de Saúde do Azure.

Essas APIs combinadas com Aplicativos Lógicos do Azure constituem a substituição do Microsoft Cloud for Healthcare para as ferramentas desativadas do agente de sincronização FHIR do Azure.

O uso do aplicativo lógico fornecido não é necessário para usar as Dataverse Healthcare APIs. Você pode criar seu próprio Aplicativo Lógico, usar o Power Automate ou desenvolver seu próprio código personalizado. Também não há necessidade de sincronizar dados com um serviço FHIR externo. Você pode sincronizar com os pontos de extremidade FHIR dos Serviços de Dados de Saúde do Azure ou postar dados diretamente nas APIs. As Dataverse Healthcare APIs devem ser um componente flexível que pode ser usado para projetar suas soluções de assistência médica em torno do Microsoft Cloud for Healthcare.

Seção Conteúdo
Dataverse Healthcare APIs Resume as informações sobre as APIs atualmente disponíveis como parte das Dataverse Healthcare APIs.
Visão geral de write-back para Dataverse Healthcare APIs Explica o processo de write-back para as Dataverse Healthcare APIs.
Configurar Dataverse Healthcare APIs Contém etapas para configurar as Dataverse Healthcare APIs.
Configurar o Aplicativo Lógico do Azure com um gatilho HTTP Contém um guia passo a passo detalhado para criar seu próprio Aplicativo Lógico que pode ingerir dados FHIR nas Dataverse Healthcare APIs, nos Serviços de Dados de Saúde do Azure ou em ambos.
Usar o modelo de pipeline de dados de Saúde para implantar Aplicativos Lógicos do Azure Fornece um guia passo a passo para usar um modelo para implantar um grupo de Aplicativos Lógicos que orquestram a ingestão de pacotes FHIR nas Dataverse Healthcare APIs e nos Serviços de Dados de Saúde do Azure.
Usar as Dataverse Healthcare APIs Resume como invocar e usar as Dataverse Healthcare APIs, com exemplos e cenários de uso comuns.
Revisar os logs da Dataverse Healthcare API Explica como revisar os logs de transação para atividades da Dataverse Healthcare API.

Dataverse Healthcare APIs

As seguintes APIs estão disponíveis como parte das Dataverse Healthcare APIs:

  • API de Pacote Upsert
  • Recuperar API do Pacote

API de Pacote Upsert

A API de Pacote Upsert permite enviar pacotes FHIR para o Dataverse e transformá-los em registros do Dataverse.

A API atualmente suporta os seguintes recursos:

  • Ingestão de pacotes de recursos únicos e mistos. Um único pacote de recursos contém apenas um tipo de recurso, enquanto um pacote misto contém vários tipos de recursos.
  • Ingestão de tipos de pacote configurável em lote. Para obter mais informações, acesse Tipos de pacote com suporte.
  • Ingestão de pacotes com referências de URN (Uniform Resource Name).
  • Integridade referencial de pacotes FHIR – um recurso só será criado no Dataverse se todas as suas referências forem resolvidas.
  • Criação de registros expandidos para cada recurso FHIR no Dataverse.
  • Criação de codeable concepts quando eles estão ausentes no Dataverse.
  • Respostas detalhadas e localizadas.

A API (msind_UpsertBundle) tem dois parâmetros de solicitação definidos da seguinte forma:

Parâmetro de solicitação Descrição
msind_JSON O pacote FHIR que precisa ser inserido (valor obrigatório).
msind_BundleTag Uma marca que ajuda a identificar os pacotes ao analisar os logs no Dataverse (valor opcional).

Para saber como invocar a API e revisar alguns cenários de uso comuns, acesse Invocar a API do pacote upsert da API Web.

Após a invocação da API, você pode esperar os seguintes elementos na resposta JSON:

Parâmetro de resposta Descrição
msind_Status Um booliano que indica se o pacote foi processado com sucesso e todos os recursos válidos foram atualizados no Dataverse.
msind_StatusDetail Fornece informações detalhadas sobre o valor msind_Status.
msind_fhirresourceid O ID FHIR dos recursos no pacote. Se uma entrada no resultado pertencer a um registro expandido, o valor será o ID FHIR do recurso raiz.
msind_fhirresourcetype O tipo do recurso FHIR do recurso no pacote. Se uma entrada no resultado pertencer a um registro expandido, o valor será o tipo do recurso FHIR do recurso raiz.
msind_resultingrecordid A ID do Dataverse após o upsert do registro. Se uma entrada no resultado pertencer a um registro expandido, o valor será o ID do Dataverse do recurso raiz.
msind_resultingrecordtype O nome da entidade do Dataverse na qual o registro foi atualizado. Se uma entrada no resultado pertencer a um registro expandido, o valor será o nome da entidade do Dataverse do recurso expandido.
msind_requestactionperformed O tipo de ação realizada. Para visualizar os valores esperados e sua descrição, acesse Tipos de ações de solicitação realizadas.
msind_requeststatus Status da solicitação. Para visualizar os valores esperados e sua descrição, acesse Tipos de ações de status solicitados.
msind_requeststatusdetail Informações detalhadas sobre o valor msind_requeststatus.

Tipos de ações de solicitação executadas

A tabela a seguir lista os valores esperados para o parâmetro de resposta do msind_requestactionperformed.

Valor Descrição
935000000 Um recurso raiz é criado.
935000001 Um recurso raiz já existente no Dataverse é atualizado.
935000002 A ação foi executada em uma entidade expandida.

Tipos de status de solicitação

A tabela a seguir lista os valores esperados para o parâmetro de resposta do msind_requeststatus.

Valor Descrição
935000000 O upsert de recursos resultou em um sucesso.
935000001 O upsert de recursos resultou em um aviso.
935000002 O upsert de recursos resultou em um erro.

Tipos de pacote com suporte

No momento, a API de pacote upsert oferece suporte a pacotes do tipo lote e resposta de lote. Para ingerir pacotes dos tipos sem suporte, primeiro você deve alterar o tipo do pacote que está enviando. Se quiser alterar o tipo de pacote para batch antes de publicar nas APIs, você pode usar a ação de substituição integrada do aplicativo lógico. Essa etapa processa o pacote como um grupo de ações independentes.

Ao alterar o tipo de pacote para lote, é importante considerar o efeito que isso pode ter em seus cenários individuais. Alterar um pacote transacional para lote pode ter efeitos indesejados nos dados que você está tentando trazer para o Dataverse. Para obter mais informações sobre as regras de uso desses pacotes, acesse HL7 FHIR – Usar pacotes.

Se você enviar um pacote do tipo resposta em lote, a Dataverse Healthcare API registrará recursos do tipo OperationOutcome com valor de gravidade error para logs. Essa ação permite postar o pacote em um servidor FHIR e canalizar a resposta do servidor FHIR para a Dataverse Healthcare API. Como resultado, você pode capturar todos os erros em um só lugar.

Recuperar API do Pacote

A API de pacote de recuperação permite consultar o Dataverse para um único recurso FHIR usando a ID FHIR. A API transforma a solicitação e usa os mapas do kit de ferramentas de integração de dados para responder com um recurso FHIR padronizado.

A API atualmente suporta os seguintes recursos:

  • Consulta de um único registro usando o ID FHIR.
  • Registro em log detalhado e localizado.

A API (msind_RetrieveBundle) tem um parâmetro de solicitação definido da seguinte forma:

Parâmetro de solicitação Descrição
msind_FHIRQuery A consulta FHIR a ser executada (valor obrigatório).

Consultas FHIR compatíveis

Consultar Descrição
FHIRResource/FHIRID A consulta retornará todo o recurso juntamente com as entidades expandidas.
FHIRResource/FHIRId?_elements=element_1,element_2,...,element_n A consulta retornará os elementos especificados na consulta juntamente com quaisquer elementos marcados como Obrigatório de FHIR no mapa de atributos.

Para obter mais informações, acesse Pesquisa de elementos de FHIR.

Para saber como invocar a API e revisar alguns cenários de uso comuns, acesse Invocar a API recuperar pacote da API Web.

Após a chamada da API, você pode ver uma resposta contendo o status da solicitação completa e o status detalhado de cada recurso e seus elementos expandidos.

Parâmetro de resposta Descrição
msind_Status Um booliano indicando quando uma ação foi processada corretamente.
msind_StatusDetail Fornece informações detalhadas sobre o valor msind_Status.
msind_JSON Representação FHIR JSON.