Pular para o conteúdo principal

Buscar autorizações do beneficiário

🌐 URLs dos Ambientes

🔹 Homologação

https://integracao.hml.cloud.medsenior.com.br/api/v1/beneficiario/autorizacoes?StatusSolicitacao={{statusSolicitacao}}&Matricula={{matricula}}&Cpf={{cpf}}&CodigoTuss={{codigoTuss}}&page={{page}}&pageSize={{pageSize}}

🔹 Produção

https://integracao.medsenior.com.br/api/v1/beneficiario/autorizacoes?StatusSolicitacao={{statusSolicitacao}}&Matricula={{matricula}}&Cpf={{cpf}}&CodigoTuss={{codigoTuss}}&page={{page}}&pageSize={{pageSize}}

Repita os parâmetros Matricula, Cpf ou CodigoTuss na query string para enviar múltiplos valores (&Matricula=12345&Matricula=67890).

📌 Endpoint

GET /api/v1/beneficiario/autorizacoes

🔐 Autenticação

Este endpoint requer token Bearer válido e as roles Administrador ou Leitor já aplicadas ao grupo beneficiario.

Authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO

🔽 Cabeçalhos

NomeValor
acceptapplication/json
content-typeapplication/json

🔽 Parâmetros de Entrada (query string)

NomeTipoObrigatórioDescrição
StatusSolicitacaoenum BuscarBeneficiarioAutorizacaoStatus (int ou nome)NãoPode ser informado pelo número do enumerador (5) ou pelo nome (PreAutorizadoPendenteExecutante). Quando omitido, assumimos o status Pré-autorizado, pendente executante (valor 5).
Matriculastring[] (multi-value)NãoMatrículas numéricas dos contratos ativos do beneficiário. Informe cada valor repetindo o parâmetro (Matricula=123&Matricula=456).
Cpfstring[] (multi-value)NãoCPFs dos beneficiários (apenas dígitos). Pode ser informado em conjunto com os demais filtros.
CodigoTussstring[] (multi-value)NãoCódigos TUSS dos procedimentos que compõem a autorização. Auxilia a restringir a busca a um exame específico.
pageintNãoPágina da consulta (padrão 1).
pageSizeintNãoQuantidade de registros por página (padrão 25).

🎯 Status disponíveis (BuscarBeneficiarioAutorizacaoStatus)

ValorNome (enum)Descrição retornada
1AutorizadoAutorizado
2EmAnaliseEm análise
3NegadoNegado
4PedidoParaAnalisePedido para análise
5PreAutorizadoPendenteExecutantePré-autorizado, pendente executante
6ProrrogacaoIntercorrenciaEmAnaliseProrrog/intercor em análise
7ProrrogacaoIntercorrenciaParaAnaliseProrrog/intercor p/ análise
8RegistroDeSeriadoAnalisadoRegistro de Seriado analisado

🔄 Exemplo de Requisição

🔹 Ambiente de homologação

curl -X 'GET' \
'https://integracao.hml.cloud.medsenior.com.br/api/v1/beneficiario/autorizacoes?StatusSolicitacao=5&Matricula=12345&Matricula=67890&Cpf=12345678901&CodigoTuss=40801095&page=1&pageSize=10' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json'

🔹 Ambiente de produção

curl -X 'GET' \
'https://integracao.medsenior.com.br/api/v1/beneficiario/autorizacoes?StatusSolicitacao=PreAutorizadoPendenteExecutante&Matricula=12345&Cpf=12345678901&page=1&pageSize=10' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json'

✅ Resposta de Sucesso

  • Status Code: 200 OK.
  • Corpo: objeto paginado (ServiceResultPaged) com metadados e lista ordenada pela DataSolicitacao.
{
"totalRecords": 1,
"totalPages": 1,
"page": 1,
"pageSize": 10,
"data": [
{
"guia": "240300123",
"beneficiario": {
"nome": "Ana Beatriz Souza",
"cpf": "12345678901",
"matricula": 12345,
"contatos": [
{
"tipoContato": "Celular",
"contato": "27999998888",
"comercial": false,
"residencial": false,
"cobranca": false,
"responsavel": false
}
]
},
"dataSolicitacao": "2024-03-15T10:23:00Z",
"dataVencimento": "2024-04-14T23:59:59Z",
"profissionalSolicitante": {
"nome": "Dr. Marcelo Lima",
"conselhoRegionalMedicina": "CRM-ES 12345"
},
"status": "Autorizado",
"tipo": "SADT",
"procedimentos": [
{
"codigoTUSS": "40801095",
"nomeProcedimento": "Ultrassonografia de Abdômen",
"dataSolicitacao": "2024-03-15T10:23:00Z",
"dataAprovacao": "2024-03-15T12:05:00Z",
"statusProcedimento": "Autorizado",
"executante": "Unidade Vitória",
"dataInclusao": "2024-03-15T10:23:00Z",
"quantidadeLiberada": 1,
"quantidadeSolicitada": 1
}
]
}
],
"messages": null
}

ℹ️ Observações de negócio

  • Quando StatusSolicitacao não é informado, o serviço assume o enumerador PreAutorizadoPendenteExecutante (valor 5), que representa o status textual "Pré-autorizado, pendente executante", e retorna apenas guias nessa situação.
  • As autorizações são buscadas diretamente no Portal do Cliente com Include para Beneficiário, Contratos, Contatos e Procedimentos, garantindo que o payload esteja completo para exibição.
  • O filtro por Matricula exige apenas números; qualquer valor não numérico interrompe a consulta com 400 A matrícula informada é inválida.
  • A resposta omite campos nulos para reduzir o payload, seguindo JsonIgnoreCondition.WhenWritingNull configurado globalmente.
  • Quando não há resultados, data vem vazio e totalRecords fica 0, mantendo o 200 OK.

❌ Códigos de Erro

Status CodeSignificadoDescrição
400Bad RequestMatrícula com caracteres inválidos.
401UnauthorizedToken ausente ou inválido.
403ForbiddenToken válido, mas usuário sem as roles Administrador ou Leitor.
500Server ErrorErro inesperado no Portal do Cliente ou ao acessar o banco de dados.