Histórico da Página
...
- Visão Geral
- Exemplo de utilização
- Elegibilidade de Procedimentos
- Tabela de Códigos de erros
- Tela Elegibilidade de Procedimentos
- Outras Ações / Ações relacionadas
- Outras Ações / Ações relacionadas
- Tela Elegibilidade de Procedimentos
- Principais Campos e Parâmetros
- Principais Campos e Parâmetros
- Tabelas utilizadas
01. VISÃO GERAL
Este documento tem como objetivo demonstrar a utilização do endpoint deelegibilidade de procedimentos, que faz parte da api beneficiaryPosition do Produto TOTVS Saúde Planos Linha Protheus (totvsHealthPlans).
- /totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/eligibleProcedures
Esse endpoint será utilizado na nova tela de posiçã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
02. EXEMPLO DE UTILIZAÇÃO
Elegibilidade de Procedimentos (Carência/Cobertura)
Retorna uma coleção de procedimentos com o status se possui cobertura e se já cumpriu o período de carência, se houver.
Endpoint
https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/eligibleProcedures |
Parâmetros
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 |
...
Request
Não possui body!
...
Operação realizada com sucesso (200)
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 |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "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 } |
...
...
Mensagens de Erros
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. |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "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 (404):
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. |
Nenhum procedimento encontrado
400 |
03. TELA ELEGIBILIDADE DE PROCEDIMENTOS
...