Ogmma Revenue

Referências

GET/v1/referencias/cnes

Estabelecimentos de saúde no CNES — 140.937 unidades

O código CNES que a guia TISS exige do prestador. Busca por CNPJ, por nome, por município (código IBGE) ou pelo próprio código.

Escopo:
operadora:ler
Resposta:
200

Pedido

Parâmetros de query

CampoTipoO que é
buscatexto
2–120 caracteres
Texto a procurar. Casa por pedaço do nome e também pelo código, sem diferenciar acento nem caixa.
codigoCnestexto
1–10 caracteres
Código do estabelecimento no CNES, sete dígitos.
cnpjtexto
11–18 caracteres
CNPJ, 14 dígitos. Aceito com ou sem máscara; devolvido sem.
municipiotexto
6–7 caracteres
Código do município no IBGE, 6 ou 7 dígitos (ex. 420240 = Blumenau).
uftexto
2–2 caracteres
Sigla da unidade federativa, duas letras (ex. SC).
limiteinteiro
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.
deslocamentointeiro
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/cnes \
  -H "Authorization: Bearer $MIYDAS_CHAVE"

Resposta 200

datalista de EstabelecimentoCnesO recurso. Os campos estão na tabela abaixo.
paginacaoPaginacaoOnde esta página está no total. Vem fora de data.

Estabelecimento de saúde no CNES — o código que a guia TISS exige do prestador.

Campos de EstabelecimentoCnes

CampoTipoO que é
codigoCNEStextoCódigo do estabelecimento no CNES, sete dígitos.
cnpjtextoCNPJ, 14 dígitos. Aceito com ou sem máscara; devolvido sem.
razaoSocialtextoRazão social, como consta no cadastro público.
nomeFantasiatextoNome fantasia, quando o cadastro informa.
tipoUnidadeobjetoA espécie de estabelecimento na classificação do CNES.
codigointeiroO código do tipo no CNES (7 = hospital geral, 22 = clínica especializada, 39 = SADT).
descricaotextoO tipo por extenso.
cidadetextoMunicípio, por extenso.
codigoMunicipioIBGEtextoCódigo do município no IBGE, sete dígitos.
uftextoSigla da unidade federativa, duas letras (ex. SC).

Exemplo de retorno

{
  "data": [
    {
      "codigoCNES": "2583251",
      "cnpj": "81007866000126",
      "razaoSocial": "LABORATORIO DE ANALISES CLINICAS EXEMPLO LTDA",
      "nomeFantasia": "LABORATORIO EXEMPLO",
      "tipoUnidade": {
        "codigo": 39,
        "descricao": "Unidade de Serviço de Apoio de Diagnose e Terapia"
      },
      "cidade": "Blumenau",
      "codigoMunicipioIBGE": "420240",
      "uf": "SC"
    }
  ],
  "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_cnes

A 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.