Histórico da Página
...
- Visão Geral
- Exemplo de utilização
- Tela Extrato de Reembolso
- Tela Extrato de Reembolso
- Tabelas utilizadas
...
Segue os métodos utilizados na API:
- reeExtratoextratoReembolso: Retorna uma lista com todos os protocolos de reembolso do beneficiário e do seu grupo familiar, conforme regra de negócio.
- reeDetalhedetalheReembolso: Retorna eventos (itens) de um reembolso especifico.
- reeHistoricohistoricoReembolso: Retorna o histórico de alterações de status do protocolo de reembolso.
- reeStatusstatusReembolso: Retorna os status do protocolo de reembolso, para montagem das legendas da listagem.
...
A autenticação é realizada através da Api /token, onde será retornado a chave e token a ser adicionado no header de cada método.
Método
...
extratoReembolso Âncora EXTRATO EXTRATO
EXTRATO | |
EXTRATO |
Este método irá retornar a lista com todos os protocolos de reembolso do beneficiário. Será retornado somente o cabeçalho do reembolso.
...
Endpoint ÂncoraEXTRATOENDPOINT EXTRATOENDPOINT
EXTRATOENDPOINT | |
EXTRATOENDPOINT |
Url | Método | Header Content-Type | Descrição |
---|---|---|---|
https://<url>:<porta>/rest/mobileSaude/v1/ |
extratoReembolso | POST | application/json | Retorna uma lista com os protocolos de reembolso |
Parâmetros de Entrada do Método ÂncoraEXTRATOPARAMETRO EXTRATOPARAMETRO
EXTRATOPARAMETRO | |
EXTRATOPARAMETRO |
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
chaveBeneficiario | Sim | Caracter | Chave do Beneficiário (Matricula do sistema, sendo Operadora, Empresa, Matricula, Tipo Registro e DigitoCPF) |
dataInicial | Não | Caracter | Data inicial do extrato de reembolso |
dataFinal | Não | Caracter | Data final do extrato de reembolso |
...
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "chaveBeneficiario": "0001100700000101282737323800", "dataInicial": "2022-0207-1104", "dataFinal": "2022-0207-1104" } |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "status": true, "extrato": [ { "beneficiarioNome chaveReembolso": "CATELYN STARK00000020180119000056", "dataInclusaobeneficiarioMatricula": "2022-02-1100011008000019017", "tipoServicoIdbeneficiarioNome": "RUAN CAUA DA COSTA", "cidadestatusId": ""1, "prestadorCodigocidade": "000001", "prestadorCpfCnpjestado": "66579707000102", "tipoServicoDescricaodataInclusao": "2022-07-04", "estadoprevisaoPagamento": "", "previsaoPagamentoprestadorCodigo": "2022-02-18000001", "beneficiarioMatriculaprestadorNome": "00011007000001012", HOSPITAL "valorReembolsado": 76.4MATER DEI", "statusIdprestadorCpfCnpj": 2, "prestadorNome": "HOSPITAL MATER DEI", "observacao": "TESTE OBSERVACAO", "valorApresentado": 600, "chaveReembolso": "00000020180119000054" }, { "beneficiarioNome ": "CATELYN STARK", "dataInclusao": "2022-02-11", "tipoServicoId": "", "cidade": "", "prestadorCodigo": "000001", "prestadorCpfCnpj": "66579707000102", "tipoServicoDescricao": "", "estado": "", "previsaoPagamento": "", "beneficiarioMatricula": "00011007000001012", "valorReembolsado": 0"66579707000102", "statusIdtipoServicoId": 5"", "prestadorNometipoServicoDescricao": "HOSPITAL MATER DEI", "observacaovalorApresentado": ""100, "valorApresentadovalorReembolsado": 2780, "chaveReembolsoobservacao": "00000020180119000055" } ] } |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "status": false, "motivoCritica": "Não existem protocolos de reembolso a serem visualizados" } |
...
Atributo | Tipo | Descrição |
---|---|---|
status | Lógico | True: Indica que a requisição foi bem-sucedida False: Indica que a requisição foi mal sucedida |
motivoCritica | Caracter | Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False |
extrato | Array | Lista de objetos de “extrato“ |
chaveReembolso | Caracter | Numero do Protocolo de Reembolso no sistema |
beneficiarioMatricula | Caracter | Matricula do Beneficiário (Operadora + Empresa + Matricula + Tipo Registro + Digito) |
beneficiarioNome | Caracter | Nome do Beneficiário |
statusId | Numérico | Código do status, conforme retorno do método reeStatus statusReembolso. |
cidade | Caracter | Cidade do Atendimento |
estado | Caracter | Estado do Atendimento |
dataInclusao | Caracter | Data de Digitação do Protocolo de Reembolso (Formato: YYYY-MM-DD) |
previsaoPagamento | Caracter | Data de Pagamento (Formato: YYYY-MM-DD) |
prestadorCodigo | Caracter | Código da Rede de Atendimento |
prestadorNome | Caracter | Nome da Rede de Atendimento |
prestadorCpfCnpj | Caracter | CPF/CNPJ da Rede de Atendimento |
tipoServicoId | Caracter | Não utilizado |
tipoServicoDescricao | Caracter | Não utilizado |
valorApresentado | Numérico | Valor apresentado no Protocolo de Reembolso |
valorReembolsado | Numérico | Valor Reembolsado pelo Operadora |
observacao | Caracter | Observação do Protocolo de Reembolso |
Método
...
detalheReembolso Âncora DETALHE DETALHE
DETALHE | |
DETALHE |
Este método irá retornar os detalhes dos eventos (itens) de um protocolo de reembolso.
...
Esse método irá receber a chave do reembolso que foi retornado no método reeExtrato extratoReembolso.
Através do campo URL Document (BA0_MSURDO) no cadastro da operadora, deverá ser informado o caminho de acesso dos arquivos anexados no protocolo para download .
...
Url | Método | Header Content-Type | Descrição |
---|---|---|---|
https://<url>:<porta>/rest/mobileSaude/v1/reeDetalhedetalheReembolso | POST | application/json | Retorna os itens de um protocolo especifico |
...
Atributo | Tipo | Descrição |
---|---|---|
status | Lógico | True: Indica que a requisição foi bem-sucedida False: Indica que a requisição foi mal sucedida |
motivoCritica | Caracter | Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False |
itens | Array | Lista de objetos de “itens“ |
documentos | Array | Lista de objetos de “documentos“ |
itemId | Caracter | Numero do Protocolo do Reembolso no sistema mais o sequencial do item. |
procedimento | Caracter | Código do procedimento |
procedimentoDescricao | Caracter | Descrição do procedimento |
statusId | Numérico | Código do status, conforme retorno do método reeStatus statusReembolso. |
cidade | Caracter | Cidade do Atendimento |
estado | Caracter | Estado do Atendimento |
dataExecucao | Caracter | Data de execução do procedimento (Formato: YYYY-MM-DD) |
documentoTipo | Caracter | Tipo do Documento do Reembolso |
documentoNumero | Caracter | Numero do Documento |
quantidadeExecutada | Numérico | Quantidade Realizada |
valorApresentado | Numérico | Valor apresentado no Protocolo |
valorReembolsado | Numérico | Valor reembolsado pela Operadora |
observacao | Caracter | Não utilizado |
nomeApresentacao | Caracter | Descrição do Arquivo |
nomeArquivo | Caracter | Arquivo com a extensão. |
caminhoArquivo | Caracter | URL do Arquivo no servidor para download. |
Método
...
historicoReembolso Âncora HISTORICO HISTORICO
HISTORICO | |
HISTORICO |
Este método irá retornar o histórico de alterações de status do protocolo de reembolso.
...
Esse método irá receber a chave do reembolso que foi retornado no método reeExtrato extratoReembolso.
Endpoint ÂncoraHISTORICOENDPOINT HISTORICOENDPOINT
HISTORICOENDPOINT | |
HISTORICOENDPOINT |
Url | Método | Header Content-Type | Descrição |
---|---|---|---|
https://<url>:<porta>/rest/mobileSaude/v1/ |
historicoReembolso | POST | application/json | Retorna o histórico de alterações de status do protocolo de reembolso |
Parâmetros de Entrada do Método ÂncoraHISTORICOPARAMETRO HISTORICOPARAMETRO
HISTORICOPARAMETRO | |
HISTORICOPARAMETRO |
...
Atributo | Tipo | Descrição |
---|---|---|
status | Lógico | True: Indica que a requisição foi bem-sucedida False: Indica que a requisição foi mal sucedida |
motivoCritica | Caracter | Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False |
historico | Array | Lista de objetos de “historico“ |
dataHora | Caracter | Data e Hora da movimentação do status do Reembolso |
statusId | Caracter | Código do status, conforme retorno do método reeStatus statusReembolso. |
Método
...
statusReembolso Âncora STATUS STATUS
STATUS | |
STATUS |
Retorna os status do protocolo de reembolso, para montagem das legendas da listagem referente aos métodos reeExtratoextratoReembolso, reeDetalhe detalheReembolso e reeHistoricohistoricoReembolso.
Regras de Negocio do Método ÂncoraSTATUSREGRA STATUSREGRA
STATUSREGRA | |
STATUSREGRA |
...
Url | Método | Header Content-Type | Descrição |
---|---|---|---|
https://<url>:<porta>/rest/mobileSaude/v1/reeStatusstatusReembolso | POST | application/json | Retorna os status do protocolo de reembolso |
...
Atributo | Tipo | Descrição |
---|---|---|
status | Lógico | True: Indica que a requisição foi bem-sucedida False: Indica que a requisição foi mal sucedida |
motivoCritica | Caracter | Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False |
reembolsoStatus | Array | Lista de objetos de “reembolsoStatus“ |
chaveStatus | Caracter | Código de identificação do status do Reembolso |
descricao | Caracter | Descrição do status |
Veja um exemplo de como a comunicação com a API é feita na prática:
...
03. TELA EXTRATO DE REEMBOLSO ÂncoraTELAEXTRATO1 TELAEXTRATO1
TELAEXTRATO1 | |
TELAEXTRATO1 |
...