CONTEÚDO
- Visão Geral
- Exemplo de utilização
- Autorizações
- Dados da Autorização
- Eventos da Autorização
- Tela Autorizações do Beneficiário
- Outras Ações / Ações relacionadas
- Outras Ações / Ações relacionadas
- Tela Autorizações do Beneficiário
- 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 dos endpoints de autorizações do beneficiário, que faz parte da api beneficiaryPosition do Produto TOTVS Saúde Planos Linha Protheus (totvsHealthPlans).
- /totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/authorizations
- /totvsHealthPlans/v1/beneficiaryPosition/authorizations/{authorizationId}
- /totvsHealthPlans/v1/beneficiaryPosition/authorizations/{authorizationId}/events
Esses endpoints serão utilizados 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
02. EXEMPLO DE UTILIZAÇÃO
Autorizações
Retorna uma coleção com as autorizações do beneficiário
Endpoint
https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/authorizations |
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 | |
phases (query) | Fases das autorizações, sendo:
| ||
formTypes (query) | Tipos de autorizações, sendo:
Guias de acordo com o cadastro da tabela BCL | ||
initialDate (query) | Data inicial das autorizações: 'AAAA-MM-DD' | ||
finalDate (query) | Data final das autorizações: 'AAAA-MM-DD' | ||
page (query) | Paginação da Coleção | ||
pageSize (query) | Quantidade de Itens por Página | ||
order (query) | Ordenação da Coleção | ||
fields (query) | Filtro de campos dos registros | ||
filter (query) | Indica o filtro querystring recebido (pode se utilizar um filtro oData) |
Request
Não possui body!
Operação realizada com sucesso (200)
items | Autorizações do Beneficiário | |
items.{campo do SX3} | Os campos retornados da tabela SE1:
| |
items.authorizationid | Chave identificador da autorização para ser utilizado nos endpoints:
Campo: ALIAS+BD5_CODOPE+BD5_CODLDP+BD5_CODPEG+BD5_NUMERO | |
struct | Estrutura dos fields de acordo com o dicionário de dados (SX3) | |
hasNext | Indica se ainda existem registros a serem retornados | |
remainingRecords | Quantidade de registros ainda existem para retorno |
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. |
Pontos de Entrada
A rotina antiga da Posição do Beneficiário possuía alguns pontos de entrada para customizar a busca das autorizações, portanto foi criado o seguinte ponto de entrada:
Dados da Autorização
Retorna os dados da autorização
Endpoint
https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/authorizations/{authorizationId} |
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 | |
authorizationId (path) | Chave de Identificação da autorização | *required | |
fields (query) | Filtro de campos dos registros |
Request
Não possui body!
Operação realizada com sucesso (200)
fields | Autorizações do Beneficiário | |
fields.{campo do SX3} | Os campos retornados da tabela de autorização: Tabela BD5 (Autorizações do Proc. Contas):
Tabela BEA (Autorizações de origem HAT - Portal Autorizador):
Tabela BE4 (Solic. de Internação):
| |
struct | Estrutura dos fields de acordo com o dicionário de dados (SX3) | |
folders | Pastas do fields (Abas) de acordo com o dicionário de dados (SXA) |
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. |
Pontos de Entrada
A rotina antiga da Posição do Beneficiário possuía alguns parâmetros para customizar os campos que serão apresentados no cabeçalho da autorização, portanto foi criado o seguinte ponto de entrada:
Eventos da Autorização
Retorna uma coleção com os eventos da autorização
Endpoint
https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/authorizations/{authorizationId}/events |
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 | |
authorizationId (path) | Chave de Identificação da Autorização | *required | |
fields (query) | Filtro de campos dos registros |
Request
Não possui body!
Operação realizada com sucesso (200)
items | Eventos da Autorização | |
items.{campo do SX3} | Os campos retornados da autorização Tabela BD6 (Autorizações do Proc. Contas):
Tabela BEA (Autorizações de origem HAT - Portal Autorizador):
Tabela BEJ (Solic. de Internação):
| |
struct | Estrutura dos fields de acordo com o dicionário de dados (SX3) | |
hasNext | Indica se ainda existem registros a serem retornados | |
remainingRecords | Quantidade de registros ainda existem para retorno |
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. |
Pontos de Entrada
A rotina antiga da Posição do Beneficiário possuía alguns parâmetros para customizar os campos que serão apresentados no cabeçalho da autorização, portanto foi criado o seguinte ponto de entrada:
Tabela de Código de Erros
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 | Autorização não encontrada. | Autorização informada não encontrada na base de dados. | 404 |
E003 | Autorização informada invalida. | Dados da autorização informada estão inválidos. | 400 |
03. TELA AUTORIZAÇÕES DO BENEFICIÁRIO
Outras Ações / Ações relacionadas
Ação | Descrição |
---|---|
Não se aplica | Não se aplica |
04. TELA AUTORIZAÇÕES DO BENEFICIÁRIO
Principais Campos e Parâmetros
Campo | Descrição |
---|---|
BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG, BA1_DIGITO | Carteirinha do beneficiário |
ALIAS+BD5_CODOPE+BD5_CODLDP+BD5_CODPEG+BD5_NUMERO | Chave de identificação da autorização |
05. TABELAS UTILIZADAS
- BA1 - Beneficiários
- BD5 - Processamento de Contas
- BD6 - Eventos Processamentos Contas
- BE2 - Autorização e Procedimentos
- BE4 - Internações
- BEA - Complementos Movimentações
- BEJ - Itens Autorização Internação