Endpoints

Base URL

https://integration.voa.health/v1

Todos os endpoints RNDS exigem autenticação via token Bearer JWT, da mesma forma que os demais endpoints da API Voa.

Authorization: Bearer <seu_token_jwt>

Enviar registro clínico à RNDS

POST /ehrs/{ehr_id}/rnds/submit

Envia os dados clínicos de uma consulta à RNDS no padrão FHIR R4. A Voa monta automaticamente o Bundle FHIR com todos os recursos necessários (Composition, Encounter, Condition, Procedure, MedicationRequest, etc.) a partir dos documentos e dados da consulta.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

document_type

string

Tipo do documento RNDS: RAC, RPM, REL (default: RAC)

patient_cpf

string

CPF do paciente (obrigatório)

patient_cns

string

CNS do paciente (opcional, usado quando disponível)

practitioner_cns

string

CNS do profissional de saúde responsável (obrigatório)

cnes

string

Código CNES do estabelecimento (obrigatório na primeira vez, depois é memorizado)

Response


Consultar status de envio

GET /ehrs/{ehr_id}/rnds/status

Retorna o status do último envio à RNDS para uma consulta específica.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Response

Status possíveis

Status
Descrição

pending

Envio em processamento

accepted

Registro aceito pela RNDS

rejected

Registro rejeitado — verifique os detalhes do erro

replaced

Registro foi substituído por uma versão mais recente

deleted

Registro foi excluído da RNDS


Substituir registro na RNDS

PUT /ehrs/{ehr_id}/rnds/replace

Substitui um registro previamente enviado à RNDS. Útil quando o profissional faz correções no documento clínico após o envio inicial.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

practitioner_cns

string

CNS do profissional responsável pela correção

Response


Excluir registro da RNDS

DELETE /ehrs/{ehr_id}/rnds

Remove um registro previamente enviado à RNDS. Esta ação é irreversível no barramento nacional.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

practitioner_cns

string

CNS do profissional que autoriza a exclusão

reason

string

Motivo da exclusão (obrigatório)

Response

circle-exclamation

Consultar paciente na RNDS

GET /rnds/patient

Consulta dados de um paciente no barramento nacional da RNDS.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Query Parameters

Name
Type
Description

cpf

string

CPF do paciente (obrigatório se não informar CNS)

cns

string

CNS do paciente (obrigatório se não informar CPF)

Response


Consultar profissional na RNDS

GET /rnds/practitioner

Consulta dados de um profissional de saúde no barramento nacional.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Query Parameters

Name
Type
Description

cns

string

CNS do profissional de saúde (obrigatório)

Response


Rate limits

Os endpoints RNDS seguem os mesmos limites da API Voa:

  • 1000 requisições por hora por token

  • 10 requisições por segundo por token

circle-info

O envio à RNDS envolve comunicação com o barramento nacional, o que pode adicionar latência de 2 a 5 segundos na resposta. Recomendamos implementar chamadas assíncronas para não bloquear a experiência do usuário.

Atualizado

Isto foi útil?