Este documento tem como objetivo demonstrar a utilização do endpoint de elegibilidade de procedimentos, que faz parte da api beneficiaryPosition do Produto TOTVS Saúde Planos Linha Protheus (totvsHealthPlans).
Esse endpoint será utilizado na nova tela de Gestão do Beneficiário, desenvolvida em PO UI. (Biblioteca de componentes baseado em Angular)
Clique aqui para detalhes sobre como habilitar o serviço de APIs
Retorna uma coleção de procedimentos com o status se possui cobertura e se já cumpriu o período de carência, se houver.
| https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/eligibleProcedures |
|
| Authorization (header) |
| Cabeçalho usado para autorização das requisições | *required |
Content-Type (header) |
| 'application/json' é o formato do conteúdo | *required |
| SubscriberId (path) |
| Número da carteirinha do beneficiário | *required |
| status (query) |
| Filtro dos status da elegibilidade do procedimento, sendo:
| *required |
| proceduresFrom (query) |
| Código do Procedimento "de" para a busca | *required |
| proceduresTo (query) |
| Código Procedimento "até" para a busca | *required |
| proceduresTable (query) |
| Código da tabela padrão dos procedimentos | *required |
| page (query) |
| Paginação da Coleção | |
| pageSize (query) |
| Quantidade de Itens por Página |
Não possui body!
items |
| Procedimentos encontrados para elegibilidade do beneficiário. |
| items.tableCode |
| Código da tabela padrão do procedimento Campo: BR8_CODPAD |
| items.procedureCode |
| Código do Procedimento Campo: BR8_CODPSA |
| items.description |
| Descrição do Procedimento Campo: BR8_DESCRI |
| items.hasCoverage |
| Indica se o beneficiário possui cobertura para o procedimento, sendo: Sim ou Não |
| items.gracePeriodCompleted |
| Indica se o beneficiário já cumpriu o período de carência do procedimento, sendo: Sim ou Não Se o beneficiário não possuir cobertura esse atributo irá vim vazio. |
| hasNext |
| Indica se ainda existem registros a serem retornados |
| remainingRecords |
| Quantidade de registros ainda existem para retorno |
{
"items": [
{
"tableCode": "01",
"procedureCode": "10102019",
"description": "VISITA HOSPITALAR - PACIENTE INTERNADO",
"hasCoverage": "Não",
"gracePeriodCompleted": ""
},
{
"tableCode": "01",
"procedureCode": "10102027",
"description": "PLS DSAUPC VISITA OU CONSULTA HOSPITALAR DO MEDICO ASSISTENTE",
"hasCoverage": "Sim",
"gracePeriodCompleted": "Sim"
},
{
"tableCode": "01",
"procedureCode": "10102035",
"description": "PLS DSAUPC COP",
"hasCoverage": "Sim",
"gracePeriodCompleted": "Sim"
},
{
"tableCode": "01",
"procedureCode": "10102043",
"description": "PLS DSAUPC COP BGI",
"hasCoverage": "Não",
"gracePeriodCompleted": ""
},
{
"tableCode": "01",
"procedureCode": "10102051",
"description": "PLS DSAUPC COP BGI 2",
"hasCoverage": "Não",
"gracePeriodCompleted": ""
}
],
"hasNext": true,
"remainingRecords": 121
} |
code |
| Código identificador do erro. (Tabela de Erros) |
message |
| Literal no idioma da requisição descrevendo o erro para o usuário. |
detailedMessage |
| Mensagem técnica e mais detalhada do erro. |
{
"code": "E003",
"message": "Nenhum procedimento encontrado",
"detailedMessage": "Não foi encontrado nenhum procedimento para o filtro informado."
} |
Código de erros informado no Json de retorno com falha:
Code | message | detailedMessage | Status Code |
|---|---|---|---|
| E001 | Beneficiário não encontrado. | Não foi encontrado nenhum Beneficiário com a matricula {subscriberId} | 404 |
| E002 | Parâmetros obrigatórios | Obrigatório informar os códigos dos procedimentos, código da tabela e o status da consulta. | 400 |
Outras Ações / Ações relacionadas
| Ação | Descrição |
|---|---|
| Não se aplica | Não se aplica. |
Principais Campos e Parâmetros
| Campo | Descrição |
|---|---|
| BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG, BA1_DIGITO | Carteirinha do beneficiário |
| BR8_CODPAD | Tabela padrão dos procedimentos |
| BR8_CODPSA | Código dos procedimentos utilizados na busca "de" e "até" |
