Referências
/v1/referencias/tussTerminologia TUSS — 54.497 termos, o vigente por padrão
A tabela que a guia TISS exige. tabela=22 são os procedimentos, tabela=38 os motivos de glosa, 19/20 materiais e medicamentos.
Por padrão devolve só o que está VIGENTE: código revogado numa guia é recusa certa. incluirRevogados=true traz o histórico, de propósito.
Não tem recorte de empresa — é tabela pública, igual para todo mundo.
- Escopo:
- operadora:ler
- Resposta:
- 200
Pedido
Parâmetros de query
| Campo | Tipo | O que é |
|---|---|---|
| busca | texto 2–120 caracteres | Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa. |
| codigo | texto 1–20 caracteres | O código exato do termo na tabela. Use com tabela — o mesmo código existe em tabelas diferentes com significados diferentes. |
| tabela | inteiro 1–99 | Qual tabela o código usa (22 = TUSS procedimentos, 00 = tabela própria da operadora). Padrão 22. |
| incluirRevogados | texto um de: true, false | Traz também código já revogado. Por padrão false: código revogado atrapalha quem monta guia, mas é necessário para ler documento antigo. |
| limite | inteiro 1–100 · padrão 25 | Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo. |
| deslocamento | inteiro padrão 0 | Quantos registros pular, para a página seguinte. Use com paginacao.total da resposta; paginacao.temMais diz se vale pedir mais. |
* obrigatório. Campo desconhecido é recusado, não ignorado: a API responde VALIDATION_ERROR em vez de descartar em silêncio.
Exemplo de chamada
curl -X GET https://api.miydas.com.br/v1/referencias/tuss \
-H "Authorization: Bearer $MIYDAS_CHAVE"Resposta 200
| data | lista de TermoTuss | O recurso. Os campos estão na tabela abaixo. |
| paginacao | Paginacao | Onde esta página está no total. Vem fora de data. |
Um termo da terminologia TUSS. Por padrão só o vigente: código revogado numa guia é recusa certa.
Campos de TermoTuss
| Campo | Tipo | O que é |
|---|---|---|
| codigo | texto | O código do termo na tabela. Único dentro da tabela, não entre tabelas. |
| termo | texto | O termo como a tabela oficial o nomeia. |
| descricaoDetalhada | texto | A descrição longa do termo, quando a tabela oficial traz uma. |
| tabela | inteiro | 22 = procedimentos · 38 = motivos de glosa · 19/20 = materiais e medicamentos. |
| tipoDaTabela | texto | A tabela TUSS de onde o termo vem, pelo número oficial da ANS. |
| vigenteDe | texto | Primeiro dia em que o termo vale na tabela oficial. |
| vigenteAte | texto | Nulo = vigente. Preenchido no passado = revogado. |
| apresentacao | texto | Como o produto se apresenta (ex. frasco 10 ml). Só em material e medicamento. |
| fabricante | texto | Fabricante do produto. Só em material e medicamento. |
| registroANVISA | texto | Registro do produto na ANVISA, quando a linha é material ou medicamento. |
| porte | texto | O porte do procedimento na tabela, quando ela o classifica — entra no cálculo de honorário. |
| capitulo | texto | O capítulo da tabela a que o termo pertence. |
| grupo | texto | O grupo dentro do capítulo. |
Exemplo de retorno
{
"data": [
{
"codigo": "40301591",
"termo": "Colesterol LDL, dosagem",
"descricaoDetalhada": null,
"tabela": 22,
"tipoDaTabela": "PROCEDIMENTOS",
"vigenteDe": "2012-01-01",
"vigenteAte": null,
"apresentacao": null,
"fabricante": null,
"registroANVISA": null,
"porte": "1A",
"capitulo": "Procedimentos diagnósticos e terapêuticos",
"grupo": "Análises clínicas"
}
],
"paginacao": {
"total": 1,
"limite": 20,
"deslocamento": 0,
"temMais": false
}
}Experimente sem chave
O sandbox devolve este mesmo corpo, sem autenticação e sem tocar na base de ninguém.
curl https://api.miydas.com.br/v1/sandbox/referencias_tussA chave de teste myd_test_… é outra coisa: ela opera na homologação da operadora e serve para escrever. Para ver o formato antes de ter credencial, convênio e varredura, é este sandbox.
Erros
Esta rota não tem erro próprio: só os comuns a qualquer chamada com chave — chave ausente ou inválida, escopo insuficiente, parâmetro recusado e erro interno.
Toda falha tem o mesmo formato: { "error": "CODIGO", "message": "…", "details": { … } }. error é estável e serve para lógica; message é para gente e pode mudar. Erros comuns a toda rota com chave (lista completa) não se repetem aqui.