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ão 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: false,
        allowCreateModels: false,
        enableFillEhr: true,
        consultationType: "IN_PERSON",
        allowChangeConsultationType: true
    },
});

Parâmetros de configuração

O argumento options pode receber os seguintes parâmetros:

Option	Descrição	Tipo	Default
renderElement	Elemento HTML do DOM no qual o plugin será renderizado. Caso nenhum elemento seja informado, o plugin será uma janela flutuante na página com botões de fechar e minimizar/maximizar.	HTMLElement	undefined
darkMode	Habilita o modo noturno da UI.	Boolean	false
consultationType	Permite pré-selecionar o tipo da consulta.	"TELEMEDICINE" ou "IN_PERSON"	"IN_PERSON"
allowChangeConsultationType	Habilita a troca do tipo da consulta por parte do usuário.	Boolean	true
allowCopyDocument	Exibe um botão de "Copiar Documento" para área de transferência.	Boolean	true
enableFillEhr	Exibe um botão de preencher prontuário ao gerar documentos que dispara um evento com os dados do documento gerado.	Boolean	false
allowScreenSharing	Caso desabilitado, a opção de compartilhar o áudio da tela para consultas de telemedicina não será exibida para os usuários. A única forma de captar áudio passa a ser enviando programaticamente um mediaStream para o plugin. Veja mais.	Boolean	true
enableTelemetry	Permite que a Voa colete dados de uso do Plugin para identificação de bugs e melhorias.	Boolean	true
structuredOutputSchema	Objeto JavaScript correspondente ao schema desejado de documento estruturado da consulta. Se informado, ao usar "Preencher prontuário" o plugin envia a mensagem voa.plugin.ehr.fill com o documento em texto; os dados estruturados são enviados em mensagem separada voa.plugin.ehr.structured_output com o formato especificado. Veja como criar o schema	Object	undefined

---

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.

Caso o usuário feche o plugin manualmente, a desmontagem também é realizada (opção de fechar manualmente só é exibida caso nenhum renderElement seja utilizado)

VoaPlugin.instance.unmount();