Pular para o conteúdo principal

Referência da API TranscriMed

Bem-vindo à Referência da API TranscriMed! Esta documentação abrangente cobre todos os endpoints disponíveis, formatos de requisição/resposta e métodos de autenticação.

URL Base​

Todas as requisições da API devem ser feitas para:

https://api.transcrimed.com.br

Modo de Teste​

Para testes e desenvolvimento, use credenciais de teste com o mesmo endpoint de produção:

  • Use client IDs começando com test_tc_ para ativar o modo de teste automaticamente
  • O modo de teste retorna dados simulados sem consumir créditos de produção
  • Não é necessária uma URL de staging separada - a API detecta automaticamente as credenciais de teste

Exemplo de credenciais de teste:

client_id: test_tc_abc123...
client_secret: test_tcs_xyz789...

Autenticação​

Todos os endpoints da API requerem autenticação usando tokens de acesso OAuth2. Inclua seu token de acesso no cabeçalho Authorization:

Authorization: Bearer seu_token_de_acesso_aqui

Saiba mais sobre autenticação em nosso Guia de Autenticação.

Documentação Interativa da API​

Explore nossas APIs com documentação interativa baseada em especificações OpenAPI:

API de Autenticação​

Gerencia o fluxo de autenticação OAuth2 para integrações seguras com parceiros.

Endpoints principais:

  • GET /api/oauth/authorize - Iniciar autorização OAuth2
  • POST /api/oauth/token - Trocar código por tokens
  • POST /api/oauth/revoke - Revogar tokens de acesso

Escopos:

  • medical_records:read - Ler registros médicos
  • medical_records:write - Criar e atualizar registros médicos
  • medical_records:delete - Excluir registros médicos
  • jobs:read - Ler status e resultados de tarefas
  • jobs:write - Criar, cancelar e gerenciar tarefas
  • worklists:write - Enviar itens de lista de trabalho
  • worklists:manage - Gerenciar status de itens de lista de trabalho
  • worklists:read - Ler itens de lista de trabalho

API de Lista de Trabalho​

INTEGRAÇÃO PRINCIPAL PARA PARCEIROS DO SETOR DE SAÚDE

Integração bidirecional com sistemas RIS/PACS para gerenciamento de listas de trabalho médicas. Esta é nossa API mais utilizada para integrações com sistemas de saúde.

Endpoints principais:

  • POST /api/v1/worklists/ingest - Receber itens de lista de trabalho de sistemas externos
  • PATCH /api/v1/worklists/items/{id} - Atualizar status de item da lista de trabalho

Funcionalidades Principais:

  • Receber listas de trabalho de sistemas RIS/PACS externos
  • Processar e normalizar dados de exames baseados em DICOM
  • Enviar automaticamente documentos médicos processados de volta aos sistemas de origem
  • Mapeamento de campos em formato snake_case para compatibilidade com API REST
  • Suporte a idempotência para ingestão confiável
  • Deduplicação baseada em accession_number ou study_uid
  • Notificações via webhook para documentos concluídos

Fluxo de Integração:

  1. Ingestão: Sistema RIS/PACS externo envia lista de trabalho via API
  2. Seleção: Médicos visualizam e selecionam exames no painel do TranscriMed
  3. Processamento: Profissionais médicos gravam áudio para exames selecionados
  4. Geração: TranscriMed cria documentos médicos estruturados
  5. Entrega: Documentos concluídos são enviados automaticamente de volta ao sistema de origem

Por que Escolher a Integração com Lista de Trabalho?

  • Fluxo Integrado: Integra-se diretamente aos fluxos de trabalho RIS/PACS existentes
  • Entrega Automatizada: Não é necessária transferência manual de documentos
  • Compatível com DICOM: Usa padrões familiares de imagem médica
  • Bidirecional: Envia listas de trabalho E recebe documentos concluídos
  • Pronto para Empresas: Construído para ambientes de saúde de alto volume

API de Registros Médicos​

Funcionalidade principal de processamento e gerenciamento de registros médicos.

Endpoints principais:

  • POST /api/v1/medical-records/generate - Gerar registros médicos
  • GET /api/v1/medical-records - Listar registros médicos
  • GET /api/v1/medical-records/{id} - Obter registro específico
  • PUT /api/v1/medical-records/{id} - Atualizar registro
  • DELETE /api/v1/medical-records/{id} - Excluir registro
  • POST /api/v1/medical-records/{id}/correct - Correções por voz

Funcionalidades:

  • Suporte a entrada de áudio e texto
  • Seleção de idioma
  • Modos de processamento síncrono e assíncrono (assíncrono apenas para geração de registros médicos)
  • Geração baseada em templates
  • Gerenciamento de versões
  • Notificações via webhook para tarefas assíncronas

API de Tarefas​

Rastreamento e gerenciamento de tarefas assíncronas para processamento em segundo plano.

Endpoints principais:

  • GET /api/v1/jobs - Listar tarefas
  • GET /api/v1/jobs/{id} - Obter detalhes da tarefa
  • GET /api/v1/jobs/{id}/logs - Obter logs da tarefa
  • GET /api/v1/jobs/{id}/result - Obter resultado da tarefa
  • DELETE /api/v1/jobs/{id} - Cancelar tarefa

Estados das Tarefas:

  • queued - Aguardando processamento
  • in_progress - Processando atualmente
  • completed - Concluída com sucesso
  • failed - Falhou com erros
  • cancelled - Cancelada pelo usuário

Formato de Resposta​

Todas as respostas da API seguem um formato consistente:

Resposta de Sucesso​

{
  "success": true,
  "data": {
    // Dados da resposta aqui
  },
  "meta": {
    "request_id": "req_123456",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

Resposta de Erro​

{
  "success": false,
  "error": {
    "code": "CODIGO_ERRO",
    "message": "Mensagem de erro legível",
    "details": {
      // Detalhes adicionais do erro
    }
  },
  "meta": {
    "request_id": "req_123456",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

Códigos de Status HTTP​

CódigoDescrição
200Sucesso
201Criado
202Aceito (processamento assíncrono iniciado)
400Requisição Inválida
401Não Autorizado
403Proibido
404Não Encontrado
429Muitas Requisições
500Erro Interno do Servidor

Precisa de Ajuda?​

Recursos de Documentação​

Ferramentas de Desenvolvimento​

Canais de Suporte​

Tempos de Resposta Rápidos​

  • Problemas Críticos: < 2 horas
  • Questões de Integração: < 24 horas
  • Solicitações de Recursos: conforme prioridade e acordo de suporte aplicável

Pronto para integrar? Explore a documentação interativa da API para testes práticos.