Voa Docs
  • Seja bem-vindo(a)! 👋
  • Início
    • Primeiros passos
    • Escolha sua integração
  • Integração
    • Plugin
      • Fluxo de uso
      • Mensagens
    • iFrame
      • Instalação
      • Autenticação
      • Tipos de mensagem
      • Fluxo de uso
      • Modelos
        • Anamnese padrão
        • Cardiologia
        • Dermatologia
        • Endocrinologia
        • Geriatria
        • Geriatria - Novo
        • Ginecologia / Saúde da mulher
        • Perícia médica
        • Neurologia
        • Nutrologia
        • Obstetrícia
        • Medicina do Trabalho
        • Oncologia
        • Oftalmologia
        • Ortopedia
        • Otorrinolaringologia
        • Pediatria
        • Pneumologia
        • Psiquiatria
        • Psicologia
        • Consulta de retorno
        • Reumatologia
        • Medicina do Esporte
        • Cirurgia
        • Evolução de enfermaria
        • SOAP
    • Extensão do Navegador
      • Instalação e uso
    • Webhooks
      • Implementação
      • Testes e segurança
  • API Reference
    • Introdução
    • Autenticação
    • Endpoints
  • Apêndice
    • Testes de Carga
Powered by GitBook
On this page
  • Mensagens enviadas pelo Plugin
  • Tipos de mensagens
  • Mensagens enviadas para o Plugin
  1. Integração
  2. Plugin

Mensagens

Mensagens enviadas pelo Plugin

As mensagens enviadas pelo Plugin via callback tem o seguinte formato:

{ 
    eventName: string, // String com o nome do evento
    eventData: {} // Caso o evento tenha algum dado associado, será enviado nesse campo em formato de objeto. Caso contrário, será undefined
}

Tipos de mensagens

  • Consulta criada

Ao abrir o plugin, caso uma consulta não exista com os identificadores fornecidos, ela será criada na Voa e esse evento será disparado.

{
    eventName: "voa.plugin.ehr.created",
    eventData: {
        id: "", // uuid da consulta na Voa,
        type: "" // TELEMEDICINE ou IN_PERSON
    }
}
  • Gravação iniciada

{
    eventName: "voa.plugin.recorder.started",
}
  • Gravação pausada

{
    eventName: "voa.plugin.recorder.paused",
}
  • Transcrição disponível

{
    eventName: "voa.plugin.ehr.transcriptions",
    eventData: {
        transcriptions: [
            {
                start_time: "00m 00s", 
                text: "Hello"
            },
            {
                start_time: "00m 02s", 
                text: "World!"
            },
        ]
    }
}
  • Documento gerado

{
    eventName: "voa.plugin.ehr.document.created",
    eventData: {
        id: "", // uuid do documento na Voa,
        created_at: "" // timestamp de criação do documento
    }
}
  • Documento copiado

{
    eventName: "voa.plugin.ehr.document.copied",
}
  • Preencher prontuário

Este evento é disparado se a opção enableFillEhr estiver habilitada e o usuário clicar em "Preencher prontuário".

{
    eventName: "voa.plugin.ehr.fill",
    eventData: {
        document: "", // representação markdown do documento
    }
}
  • Plugin minimizado

Evento disparado quando usuário clica em minimizar o Plugin para reduzir o tamanho da janela.

{
    eventName: "voa.plugin.ehr.document.minimized",
}
  • Plugin maximizado

Evento disparado quando usuário clica em maximizar o Plugin para expandir a janela.

{
    eventName: "voa.plugin.maximized",
}
  • Plugin aberto

Evento disparado assim que o Plugin é exibido para o usuário.

{
    eventName: "voa.plugin.opened",
}
  • Plugin maximizado

Evento disparado assim que o Plugin é fechado.

{
    eventName: "voa.plugin.closed",
}

Mensagens enviadas para o Plugin

Em breve...

PreviousFluxo de usoNextiFrame

Last updated 23 days ago