Visão geral de write-back para Dataverse Healthcare APIs
A Dataverse Healthcare API upsert facilita a ingestão de dados FHIR (Fast Healthcare Interoperability Resources) no Dataverse. Após a disponibilização dos dados no Dataverse, os usuários poderão atualizar os novos registros, como atualizar as informações demográficas do paciente. A solução de write-back das Dataverse Healthcare APIs permite que essas alterações sejam postadas de volta no servidor FHIR de origem.
A abordagem de solução oferece alguma extensibilidade ao processo de write-back. A configuração de write-back também pode ter como destino um ponto de extremidade alternativo se os usuários precisarem injetar lógica personalizada nesse processo. Por exemplo, um Aplicativo Lógico do Azure personalizado pode ser direcionado para a mensagem de saída que executa processamento ou roteamento adicional. Esse ponto de extremidade de saída alternativo deve oferecer suporte à autenticação via OAuth 2.0 usando uma ID do cliente e um segredo do cliente.
O diagrama a seguir destaca o processo geral de write-back:
As etapas de processamento padrão são as seguintes:
- Você atualiza um registro no Dataverse.
- O Dataverse avalia a alteração e compõe um novo recurso FHIR que é postado no ponto de extremidade da API FHIR.
- O ponto de extremidade FHIR processa o recurso FHIR e retorna a resposta do resultado da operação para o Dataverse.
- O Dataverse registra os resultados operacionais nos logs do kit de ferramentas de integração de dados. O administrador pode revisar quaisquer falhas aqui.
Para fins de extensibilidade, você pode especificar uma abordagem alternativa de write-back, se necessário.
- O Dataverse envia a solicitação de recurso FHIR para o ponto de extremidade definido.
- O ponto de extremidade definido é responsável por processar o recurso FHIR postado e enviá-lo para a API FHIR.
- Você é responsável por registrar em log os resultados operacionais, para que o administrador possa revisar quaisquer falhas ao enviar dados para o ponto de extremidade personalizado.
Observação
A versão atual das Dataverse Healthcare APIs e o processo de write-back pressupõem que um serviço FHIR esteja disponível para criação e validação do recurso FHIR de saída. Essa configuração é necessária para gravar diretamente no serviço FHIR ou em um ponto de extremidade de saída alternativo. Ele garante a integridade do recurso FHIR de saída quando ocorre um evento de write-back. Testamos e validamos essa configuração em relação a um serviço FHIR dos Serviços de Dados de Saúde do Azure.
Um registro Proveniência do FHIR também é postado no ponto de extremidade FHIR quando o evento de write-back é processado. O recurso de proveniência rastreia informações sobre a atividade que criou, revisou, excluiu ou assinou uma versão de um recurso. Ele também descreve as entidades e agentes envolvidos. Você pode usar essas informações para formar avaliações sobre sua qualidade, confiabilidade ou confiabilidade. Também fornecem indicadores de onde ir para investigar mais a fundo as origens do recurso e as informações contidas nele.
Para obter mais informações sobre a proveniência do FHIR, acesse Proveniência do recurso FHIR.
Habilitar write-back
Habilitar o processo de write-back inclui as três etapas principais a seguir:
Fornecer detalhes de conectividade
Forneça os detalhes de conectividade para o ponto de extremidade FHIR que recebe os recursos FHIR postados. Você pode encontrar esses valores de configuração na seção Configurações de integração do kit de ferramentas de integração de dados.
Para obter mais informações sobre essas configurações, acesse Definir configurações de integração.
Atualizar mapas de entidades
Depois de fornecer os detalhes de conectividade, a próxima etapa será atualizar os mapas de entidade que controlam quais recursos FHIR devem participar do processo de write-back.
Os plug-ins de write-back usam os mesmos mapas de entidade configurados para a API upsert. Cada mapa de entidade pode incluir um atributo intitulado Habilitar write-back para FHIR. Quando o valor desse atributo é definido como Sim, os plug-ins de write-back postam atualizações para a tabela do Dataverse selecionada no ponto de extremidade FHIR. Esse processo permite um controle granular, tabela por tabela, sobre quais dados devem ser gravados de volta no ponto de extremidade FHIR.
Depois de habilitar o write-back para o mapa de entidades, o administrador poderá selecionar quais eventos desencadeiam o processo de write-back, indicado pelo campo Mensagens com Suporte . No momento, a solução de write-back é compatível com as mensagens Criar e Atualizar.
Para obter mais informações sobre como configurar mapas de entidades, acesse Configurar mapas de entidades.
Aplicar o consentimento do paciente
Os recursos do paciente incluem uma definição de configuração extra para write-back. Os pacientes podem optar por consentir ou negar que seus dados sejam atualizados no aplicativo Dataverse. O atributo Sincronização do FHIR do Azure Habilitada salva esse consentimento para cada paciente.
Quando o valor do atributo Sincronização do FHIR do Azure Habilitada é definido como Sim e o mapa de entidades do Paciente é configurado para write-back, quaisquer alterações nos atributos mapeados serão postadas no ponto de extremidade FHIR. Caso contrário, os plug-ins de write-back vão ignorar as alterações no registro do paciente.
Avisos comuns e cenários de erro
Avisos e exceções que podem ocorrer durante o processo de write-back são registrados nos logs do kit de ferramentas de integração de dados. Para obter mais informações sobre os logs, acesse Revisar os logs da Dataverse Healthcare API.
Definições de configuração inválidas
Se os detalhes de conectividade fornecidos na seção de configurações de integração estiverem incorretos, o processo de write-back registrará uma exceção e interromperá o processamento. Por exemplo, os valores de ID do Aplicativo/Cliente ou Segredo do Cliente podem estar incorretos.
Mensagem processada com avisos
O ponto de extremidade FHIR pode retornar alguns avisos ou mensagens informativas, mesmo que a solicitação de write-back seja processada com êxito. Os logs filho dessa mensagem de aviso contêm mais detalhes para os administradores analisarem.
Erros de proveniência do FHIR
Qualquer exceção relacionada à criação do registro de proveniência do FHIR é registrada com uma exceção geral, juntamente com os detalhes retornados pelo ponto de extremidade FHIR.
Atributos obrigatórios ausentes
O processamento de write-back para mapas de expansão requer uma referência ao registro pai. Se o valor do atributo do link pai estiver ausente, o processo de write-back registrará uma exceção e interromperá o processamento.
Tipo de contato inválido
Para os registros de contato do Dataverse, você deve definir corretamente o indicador do Tipo de Contato para que o write-back tenha êxito. Por exemplo, você deve defini-lo como Paciente ou Profissional. Se esse valor não estiver presente, o processo de write-back registrará uma exceção e interromperá o processamento.
Limitações
Atualmente, a solução de write-back tem as seguintes limitações:
- Formatação de saída: a solução de write-back não oferece suporte à formatação de saída. Atualmente, o processo publica o recurso FHIR que representa as alterações para o recurso FHIR atualizado no Dataverse.
- Autenticação: no momento, a solução de write-back oferece suporte à postagem somente em pontos de extremidade que usam autenticação OAuth.