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
  • Listar consultas
  • Listar documentos
  • Gerar documento
  • Obter transcrição
  • Gerar PDF
  • Rate limits
  1. API Reference

Endpoints

Listar consultas

GET /ehrs

Retorna uma lista paginada de EHRs.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

page

number

Número da página (default: 1)

per_page

number

Itens por página (default: 20, max: 100)

start_date

date

Filtro de data inicial (formato: YYYY-MM-DD)

patient_id

string

Filtro do ID do paciente

doctor_id

string

Filtro do ID do médico

Response

{
  "total": 150,
  "page": 1,
  "per_page": 20,
  "ehrs": [
    {
      "id": "ehr_123456",
      "patient_id": "pat_789012",
      "doctor_id": "doc_345678",
      "date": "2023-06-15T14:30:00Z",
      "documents": 0
    },
    // ...
  ]
}
{
  "error": "Invalid request"
}

Listar documentos

GET /ehrs/{ehr_id}/documents

Retorna uma lista de documentos associados a um EHR específico.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Response

{
  "id": 1,
  "name": "John",
  "age": 30
}
{
  "ehr_id": "ehr_123456",
  "documents": [
    {
      "id": "doc_901234",
      "type": "clinical_note",
      "created_at": "2023-06-15T15:00:00Z",
      "content": "Conteúdo do documento...",
    },
    // ...
  ]
}

Gerar documento

POST /ehrs/{ehr_id}/documents

Gera um novo documento para um EHR específico usando um template predefinido.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

type

string

Determina o template de documento a ser gerado (ex.: 'evolucao_enfermaria')

Response

{
  "document_id": "doc_123456",
  "status": "generated",
  "content": "Conteúdo do documento...",
}
{
  "error": "Invalid request"
}

Obter transcrição

GET /ehrs/{ehr_id}/transcription

Retorna a transcrição completa de uma consulta.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Response

{
  "ehr_id": "ehr_123456",
  "transcription": "Texto completo da transcrição...",
  "segments": [
    {
      "start_time": 0,
      "end_time": 10.5,
      "text": "Olá, como você está se sentindo hoje?"
    },
    // ...
  ]
}
{
  "error": "Invalid request"
}

Gerar PDF

POST /ehrs/{ehr_id}/pdf

Gera um PDF contendo todos os documentos de uma consulta específica.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

document_ids

array[string]

Lista de Id's dos documentos clínicos a serem impressos

customize

bool

Default: False

Response

{
  "pdf_url": "https://integration.voa.health/v1/ehrs/ehr_123456/pdf/download",
  "expires_at": "2023-06-16T14:30:00Z"
}
{
  "error": "Invalid request"
}

Rate limits

  • 1000 requisições por hora por token

  • 10 requisições por segundo por token

PreviousAutenticaçãoNextTestes de Carga

Last updated 9 months ago