Histórico da Página

...

Visão Geral
Exemplo de utilização
1. Elegibilidade de Procedimentos
2. Tabela de Códigos de erros
Tela Elegibilidade de Procedimentos
1. Outras Ações / Ações relacionadas
Tela Elegibilidade de Procedimentos
1. 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

Image Modified

Parâmetros

Authorization (header)	Image Modified	Cabeçalho usado para autorização das requisições	*required
Content-Type (header)	Image Modified	'application/json' é o formato do conteúdo	*required
SubscriberId (path)	Image Modified	Número da carteirinha do beneficiário	*required
status (query)	Image Modified	Filtro dos status da elegibilidade do procedimento, sendo: 1 = Todos 2 = Em Carência 3 = Sem Cobertura	*required
proceduresFrom (query)	Image Modified	Código do Procedimento "de" para a busca	*required
proceduresTo (query)	Image Modified	Código Procedimento "até" para a busca	*required
proceduresTable (query)	Image Modified	Código da tabela padrão dos procedimentos	*required
page (query)	Image Modified	Paginação da Coleção
pageSize (query)	Image Modified	Quantidade de Itens por Página

...

Request

Não possui body!

...

Operação realizada com sucesso (200)

items	Image Modified	Procedimentos encontrados para elegibilidade do beneficiário.
items.tableCode	Image Modified	Código da tabela padrão do procedimento Campo: BR8_CODPAD
items.procedureCode	Image Modified	Código do Procedimento Campo: BR8_CODPSA
items.description	Image Modified	Descrição do Procedimento Campo: BR8_DESCRI
items.hasCoverage	Image Modified	Indica se o beneficiário possui cobertura para o procedimento, sendo: Sim ou Não
items.gracePeriodCompleted	Image Modified	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	Image Modified	Indica se ainda existem registros a serem retornados
remainingRecords	Image Modified	Quantidade de registros ainda existem para retorno

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Sucesso
linenumbers	true
collapse	true

{
  "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	Image Modified	Código identificador do erro. (Tabela de Erros)
message	Image Modified	Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage	Image Modified	Mensagem técnica e mais detalhada do erro.

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Falha
linenumbers	true
collapse	true

{
  "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.

E003

Nenhum procedimento encontrado

Não foi encontrado nenhum procedimento para o filtro informado.

400

03. TELA ELEGIBILIDADE DE PROCEDIMENTOS

...

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave