Fluxo de uso

Instalação

Para utilizar o Plugin, é necessário importar um script no HTML da página. As duas formas mais indicadas são: adicionar diretamente no HTML ou carregar o script programaticamente usando javascript.

• Adicionar diretamente no HTML

<script type="module" src="https://integration.voa.health/plugin.js"></script>

• Adicionar programaticamente usando JavaScript:

<script>
    (() => {
        const script = document.createElement("script");
        script.src = "https://integration.voa.health/plugin.js";
        script.type = "module";
        
        document.head.appendChild(script);
        
        script.onload = async () => {
            // Com o script carregado, uma instância do VoaPlugin estará disponível
            // no escopo global da página
            await VoaPlugin.instance.init({ token: "YOUR_API_KEY" });
        }
    })();
</script>

Ao carregar o script, um tipo VoaPlugin é adicionado ao contexto global da página. Na sequência, é necessário chamar a função de init passando o token de autenticação.

Inicialização

Para inicializar o plugin, execute a função mount e passe os identificadores internos da consulta no seu prontuário.

Não é possível abrir mais de uma instância do Plugin na mesma página, portanto, chamadas dessa função enquanto há uma instância na tela não surtirá efeito.

await VoaPlugin.init({ token: "YOUR_API_KEY" });

VoaPlugin.instance.mount({
    doctorId: "", // Identificador do médico
    patientId: "", // Identificador do paciente
    consultationId: "", // Identificador da consulta
    options: {
        darkMode: true,
        allowCreateModels: true,
        enableFillEhr: true,
    },
});

O argumento options pode receber os seguintes parâmetros

Option	Descrição	Tipo	Default
darkMode	Habilita o modo noturno da UI	Boolean	false
enableFillEhr	Exibe um botão de preencher prontuário ao gerar documentos que dispara um evento com os dados do documento gerado	Boolean	false
allowCreateModels 🔜	Permite a criação de modelos personalizáveis	Boolean	true

---

Desmontagem

Para fechar uma instância aberta do Plugin, basta chamar a função unmount. Sempre utilize essa função ao invés de removê-lo manualmente do DOM da página para garantir sincronização dos dados e limpeza de memória.

VoaPlugin.instance.unmount();

---

Recebimento de Mensagens

A comunicação do Plugin com a página e feita por meio de mensagens utilizando o padrão publish-subscribe. Execute a função abaixo para inscrever um callback e receber as mensagens do Plugin.

const messageHandler = (message) => {
    // Adicione aqui seu tratamento para a mensagem
}

VoaPlugin.instance.addMessageListener(messageHandler);

Observe que a cada vez que addMessageListener é executada, uma nova função de listener é adicionada, portanto, é possível ter múltiplos listeners simultaneamente. Caso queira remover um callback adicionado, basta executar removeMessageListener;

VoaPlugin.instance.removeMessageListener(messageHandler);

Para mais detalhes sobre o formato e conteúdo das mensagens, acesse mensagens.

---

Envio de Mensagens

O Plugin também pode ser controlado programaticamente sem a necessidade de interações do usuário com a interface.

Em breve...