Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
    1. Tela XXX
      1. Outras Ações / Ações relacionadas
    2. Tela XXX
      1. Principais Campos e Parâmetros
    3. Tabelas utilizadas

    01. VISÃO GERAL

    Este documento tem como objetivo demonstrar a utilização da API Extrato de Reembolso para a integração do TOTVS Saúde Planos Linha Protheus com a Mobile Saúde, onde será disponibilizado ao beneficiário a relação dos seus protocolos de reembolso e seus status, a visualização dos itens do protocolo e o histórico de alterações de status.

    A API utilizará o padrão REST.

    02. EXEMPLO DE UTILIZAÇÃO

    Segue os métodos utilizados na API:

    • reeExtrato Retorna uma lista com todos os protocolos de reembolso do beneficiário e do seu grupo familiar, conforme regra de negócio.
    • reeDetalhe: Retorna eventos (itens) de um reembolso especifico.
    • reeHistorico: Retorna o histórico de alterações de status do protocolo de reembolso.
    • reeStatus: Retorna os status do protocolo de reembolso, para montagem das legendas da listagem.

    Abaixo serão apresentados exemplos de cada método. 

    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 reeExtrato

    ...

      1. Método extratoReembolso
        1. Regras de Negocio do Método
        2. EndPoint
        3. Parâmetros de Entrada do Método
        4. Exemplo
        5. Estrutura de Retorno
      2. Método detalheReembolso
        1. Regras de Negocio do Método
        2. EndPoint
        3. Parâmetros de Entrada do Método
        4. Exemplo
        5. Estrutura de Retorno
      3. Método historicoReembolso
        1. Regras de Negocio do Método
        2. EndPoint
        3. Parâmetros de Entrada do Método
        4. Exemplo
        5. Estrutura de Retorno
      4. Método statusReembolso
        1. Regras de Negocio do Método
        2. EndPoint
        3. Parâmetros de Entrada do Método
        4. Exemplo
        5. Estrutura de Retorno
    1. Tela Extrato de Reembolso
      1. Outras Ações / Ações relacionadas
    2. Tela Extrato de Reembolso
      1. Principais Campos e Parâmetros
    3. Tabelas utilizadas


    01. VISÃO GERAL
    Âncora
    VISAO
    VISAO

    Este documento tem como objetivo demonstrar a utilização da API Extrato de Reembolso para a integração do TOTVS Saúde Planos Linha Protheus com a Mobile Saúde, onde será disponibilizado ao beneficiário a relação dos seus protocolos de reembolso e seus status, a visualização dos itens do protocolo e o histórico de alterações de status.

    A API utilizará o padrão REST.

    02. EXEMPLO DE UTILIZAÇÃO
    Âncora
    EXEMPLO
    EXEMPLO

    Segue os métodos utilizados na API:

    • extratoReembolso Retorna uma lista com todos os protocolos de reembolso do beneficiário

    ...

    • e do seu grupo familiar, conforme regra de negócio.
    • detalheReembolso: Retorna eventos (itens) de um reembolso especifico.
    • historicoReembolso: Retorna o histórico de alterações de status do protocolo de reembolso.
    • statusReembolso: Retorna os status do protocolo de reembolso, para montagem das legendas da listagem.


    Abaixo serão apresentados exemplos de cada método. 

    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

    Este método irá retornar a lista com todos os protocolos de reembolso do beneficiário. Será retornado somente o cabeçalho do reembolso.

    Regras de Negocio do Método
    Âncora
    EXTRATOREGRA
    EXTRATOREGRA

    Se os parâmetros Data Inicial e Data Final não forem informados, será retornado uma lista de reembolsos de acordo com a quantidade de meses cadastrado no campo Qt. Meses G. (BA0_MSGUIA). Caso o campo não seja encontrado na base de dados, será utilizado o período de verificação dos últimos 12 meses.

    Quando o beneficiário solicitado for o titular, será retornado os seus reembolsos e de todo o grupo familiar.

    Quando o beneficiário solicitado for um dependente, será retornado apenas os

    ...

    Regras de Negocio do Método

    Se os parâmetros Data Inicial e Data Final não forem informados, será retornado uma lista de reembolsos de acordo com a quantidade de meses cadastrado no campo Qt. Meses G. (BA0_MSGUIA). Caso o campo não seja encontrado na base de dados, será utilizado o período de verificação dos últimos 12 meses.

    Quando o beneficiário solicitado for o titular, será retornado os seus reembolsos e de todo o grupo familiar.

    Quando o beneficiário solicitado for um dependente, será retornado apenas os seus próprios reembolsos.

    Endpoint
    Âncora
    EXTRATOENDPOINT
    EXTRATOENDPOINT

    Url

    Método

    Header Content-Type

    Descrição

    https://<url>:<porta>/rest/mobileSaude/v1/
    reeExtrato
    extratoReembolsoPOSTapplication/jsonRetorna uma lista com os protocolos de reembolso

    Parâmetros de Entrada do Método
    Âncora
    EXTRATOPARAMETRO
    EXTRATOPARAMETRO

    Parâmetro

    Obrigatório

    Tipo

    Descrição

    chaveBeneficiarioSimCaracterChave do Beneficiário (Matricula do sistema, sendo Operadora, Empresa, Matricula, Tipo Registro, DigitoCPF)
    dataInicialNãoCaracterData inicial do extrato de reembolso
    dataFinalNãoCaracterData final do extrato de reembolso

    Exemplo
    Âncora
    EXTRATOEXEMPLO
    EXTRATOEXEMPLO

    Bloco de código
    languagec#
    themeMidnight
    titleRequest body
    linenumberstrue
    collapsetrue
    {
        "chaveBeneficiario": "00011007000001012",
        "dataInicial": "2022-02-11",
        "dataFinal": "2022-02-11"
    }
    Bloco de código
    languagec#
    themeMidnight
    titleAPI Retorno - Sucesso
    linenumberstrue
    collapsetrue
    {
        "status": true,
        "extrato": [
            {
                "beneficiarioNome ": "CATELYN STARK",
                "dataInclusao": "2022-02-11",
                "tipoServicoId": "",
                "cidade": "",
                "prestadorCodigo": "000001",
                "prestadorCpfCnpj": "66579707000102",
                "tipoServicoDescricao": "",
                "estado": "",
                "previsaoPagamento": "2022-02-18",
                "beneficiarioMatricula": "00011007000001012",
                "valorReembolsado": 76.4,
                "statusId": 2,
          "chaveBeneficiario": "82737323800",
          "prestadorNomedataInicial": "HOSPITAL MATER DEI2022-07-04",
                "observacao"dataFinal": "TESTE OBSERVACAO",
            2022-07-04"
    }
    Bloco de código
    languagec#
    themeMidnight
    titleAPI Retorno - Sucesso
    linenumberstrue
    collapsetrue
    {
        "valorApresentadostatus": 600true,
                "chaveReembolso"extrato": "00000020180119000054"
            },[
            {
                "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": "000001",
                "beneficiarioMatriculaprestadorNome": "00011007000001012HOSPITAL MATER DEI",
                "valorReembolsadoprestadorCpfCnpj": 0"66579707000102",
                "statusIdtipoServicoId": 5"",
                "prestadorNometipoServicoDescricao": "HOSPITAL MATER DEI",
                "observacaovalorApresentado": ""100,
                "valorApresentadovalorReembolsado": 2780,
                "chaveReembolsoobservacao": "00000020180119000055"
            }
        ]
    }
    Bloco de código
    languagec#
    themeMidnight
    titleRetorno API - Falha
    linenumberstrue
    collapsetrue
    {
        "status": false,
        "motivoCritica": "Não existem protocolos de reembolso a serem visualizados"
    }

    Estrutura de Retorno
    Âncora
    EXTRATOESTRUTURA
    EXTRATOESTRUTURA

    AtributoTipoDescrição
    statusLógico

    True: Indica que a requisição foi bem-sucedida

    False: Indica que a requisição foi mal sucedida

    motivoCriticaCaracterMotivo pelo qual não foi possível realizar a requisição, quando o status for igual a False
    extrato ArrayLista de objetos de “extrato“
    chaveReembolso CaracterNumero do Protocolo de Reembolso no sistema
    beneficiarioMatriculaCaracterMatricula do Beneficiário (Operadora + Empresa + Matricula + Tipo Registro + Digito)
    beneficiarioNomeCaracterNome do Beneficiário
    statusId NuméricoCódigo do status, conforme retorno do método reeStatus statusReembolso.
    cidadeCaracterCidade do Atendimento
    estado CaracterEstado do Atendimento
    dataInclusao CaracterData de Digitação do Protocolo de Reembolso (Formato: YYYY-MM-DD)
    previsaoPagamentoCaracterData de Pagamento (Formato: YYYY-MM-DD)
    prestadorCodigoCaracter

    Código da Rede de Atendimento

    prestadorNome CaracterNome da Rede de Atendimento
    prestadorCpfCnpjCaracterCPF/CNPJ da Rede de Atendimento
    tipoServicoIdCaracterNão utilizado
    tipoServicoDescricaoCaracterNão utilizado
    valorApresentado NuméricoValor apresentado no Protocolo de Reembolso
    valorReembolsadoNuméricoValor Reembolsado pelo Operadora
    observacaoCaracterObservação do Protocolo de Reembolso

    ...

    de Reembolso

    Método detalheReembolso
    Âncora
    DETALHE
    DETALHE

    Este método irá retornar os detalhes dos eventos (itens) de um protocolo de reembolso.

    Regras de Negocio do Método
    Âncora
    DETALHEREGRA
    DETALHEREGRA

    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 .

    Endpoint
    Âncora
    DETALHEENDPOINT
    DETALHEENDPOINT

    UrlMétodoHeader Content-TypeDescrição
    https://<url>:<porta>/rest/mobileSaude/v1/
    reeDetalhe
    detalheReembolsoPOSTapplication/jsonRetorna os itens de um protocolo especifico

    Parâmetros de Entrada do Método
    Âncora
    DETALHEPARAMETRO
    DETALHEPARAMETRO

    ParâmetroObrigatórioTipoDescrição
    chaveReembolso SimCaracterNumero do Protocolo de Reembolso no Sistema

    Exemplo
    Âncora
    DETALHEEXEMPLO
    DETALHEEXEMPLO

    Bloco de código
    languagec#
    themeMidnight
    titleRequest body
    linenumberstrue
    collapsetrue
    {
        "chaveReembolso": "00000020180119000055"
    }
    Bloco de código
    languagec#
    themeMidnight
    titleAPI Retorno - Sucesso
    linenumberstrue
    collapsetrue
    {
        "status": true,
        "itemitens": [
            {
                "procedimentoDescricao": "SANGUE OCULTO, PESQUISA NAS FEZES",
                "quantidadeExecutada": 1,
                "dataExecucao": "2022-02-11",
                "cidade": "ACARAU",
                "valorApresentado": 25,
                "estado": "CE",
                "documentoTipo": "NOTA FISCAL",
                "documentoNumero": "2513",
                "itemId": "00000020180119000055001",
                "statusId": 4,
                "valorReembolsado": 0,
                "observacao": "",
                "procedimento": "40303136"
            },
            {
                "procedimentoDescricao": "CONSULTA EM CONSULTORIO",
                "quantidadeExecutada": 1,
                "dataExecucao": "2022-02-11",
                "cidade": "AGUA BRANCA",
                "valorApresentado": 253,
                "estado": "AL",
                "documentoTipo": "NOTA FISCAL",
                "documentoNumero": "2134",
                "itemId": "00000020180119000055002",
                "statusId": 3,
                "valorReembolsado": 0,
                "observacao": "",
                "procedimento": "10101012"
            }
        ],
        "documentodocumentos": [
            {
                "nomeArquivo": "LOG NO SCHEDULE DO RATEIO DAS BAIXAS.ZIP",
                "caminhoArquivo": "http://www.seudominio.com.br/documentos/reembolso/LOG NO SCHEDULE DO RATEIO DAS BAIXAS.ZIP",
                "nomeApresentacao": "log no schedule do rateio das baixas"
            },
            {
                "nomeArquivo": "PATCH SISPAC.RAR",
                "caminhoArquivo": "http://www.seudominio.com.br/documentos/reembolso/PATCH SISPAC.RAR",
                "nomeApresentacao": "PATCH SISPAC"
            },
            {
                "nomeArquivo": "06581736341-IRPF-2021-2020-ORIGI-IMAGEM-RECIBO.PDF",
                "caminhoArquivo": "http://www.seudominio.com.br/documentos/reembolso/06581736341-IRPF-2021-2020-ORIGI-IMAGEM-RECIBO.PDF",
                "nomeApresentacao": "06581736341-irpf-2021-2020-origi-imagem-recibo"
            }
        ]
    }
    Bloco de código
    languagec#
    themeMidnight
    titleRetorno API - Falha
    linenumberstrue
    collapsetrue
    {
        "status": false,
        "motivoCritica": "Não existem detalhes a serem visualizados"
    }

    Estrutura de Retorno
    Âncora
    DETALHEESTRUTURA
    DETALHEESTRUTURA

    AtributoTipoDescrição
    statusLógico

    True: Indica que a requisição foi bem-sucedida

    False: Indica que a requisição foi mal sucedida

    motivoCriticaCaracterMotivo pelo qual não foi possível realizar a requisição, quando o status for igual a False
    itensArrayLista de objetos de “itens“
    documentos ArrayLista de objetos de “documentos“
    itemIdCaracterNumero do Protocolo do Reembolso no sistema mais o sequencial do item.
    procedimentoCaracterCódigo do procedimento
    procedimentoDescricaoCaracterDescrição do procedimento
    statusIdNuméricoCódigo do status, conforme retorno do método
    reeStatus
    statusReembolso.
    cidadeCaracterCidade do Atendimento
    estado CaracterEstado do Atendimento
    dataExecucao CaracterData de execução do procedimento (Formato: YYYY-MM-DD)
    documentoTipo CaracterTipo do Documento do Reembolso
    documentoNumeroCaracterNumero do Documento
    quantidadeExecutadaNuméricoQuantidade Realizada
    valorApresentadoNuméricoValor apresentado no Protocolo
    valorReembolsadoNuméricoValor reembolsado pela Operadora
    observacaoCaracterNão utilizado
    nomeApresentacaoCaracterDescrição do Arquivo
    nomeArquivo CaracterArquivo com a extensão.
    caminhoArquivo CaracterURL do Arquivo no servidor para download.

    Método

    ...

    historicoReembolso
    Âncora
    HISTORICO
    HISTORICO

    Este método irá retornar o histórico de alterações de status do protocolo de reembolso.

    Regras de Negocio do Método
    Âncora
    HISTORICOREGRA
    HISTORICOREGRA

    Esse método irá receber a chave do reembolso que foi retornado no método reeExtrato

    ...

    extratoReembolso

    Endpoint
    Âncora
    HISTORICOENDPOINT
    HISTORICOENDPOINT

    UrlMétodoHeader Content-TypeDescrição
    https://<url>:<porta>/rest/mobileSaude/v1/
    reeHistorico
    historicoReembolsoPOSTapplication/jsonRetorna o histórico de alterações de status do protocolo de reembolso

    Parâmetros de Entrada do Método
    Âncora
    HISTORICOPARAMETRO
    HISTORICOPARAMETRO

    ParâmetroObrigatórioTipoDescrição
    chaveReembolsoSimCaracterNumero do Protocolo de Reembolso no Sistema

    Exemplo
    Âncora
    HISTORICOEXEMPLO
    HISTORICOEXEMPLO

    Bloco de código
    languagec#
    themeMidnight
    titleRequest body
    linenumberstrue
    collapsetrue
    {
        "chaveReembolso": "00000020180119000055"
    }

    ...

    Bloco de código
    languagec#
    themeMidnight
    titleRetorno API - Falha
    linenumberstrue
    collapsetrue
    {
        "status": false,
        "motivoCritica": "Não existem históricos a serem visualizados"
    }

    Estrutura de Retorno
    Âncora
    HISTORICOESTRUTURA
    HISTORICOESTRUTURA

    AtributoTipoDescrição
    statusLógico

    True: Indica que a requisição foi bem-sucedida

    False: Indica que a requisição foi mal sucedida

    motivoCriticaCaracter Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False
    historicoArrayLista de objetos de “historico“
    dataHora CaracterData e Hora da movimentação do status do Reembolso
    statusIdCaracterCódigo do status, conforme retorno do método
    reeStatus
    statusReembolso.

    Método

    ...

    statusReembolso
    Âncora
    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
    Âncora
    STATUSREGRA
    STATUSREGRA

    Segue tabela abaixo dos status da API relacionados com os status do protocolo de reembolso no remote:

    Status na APIStatus no Remote
    0 = Solicitação não concluidaA = Solicitação não concluída
    1 = Protocolado0 = Solicitado (Portal) ; 1 = Protocolado
    2 = Em Analise2 = Em analise ; 3 = Deferido ; 5 = Em digitacao ; 9 = Auditoria

    3 = Aprovado 

    6 = Lib. financeiro ; Legenda Verde do Item do Reembolso
    4 = Rejeitado4 = Indeferido ; 7 = Nao lib. financeiro ; 8 = Glosado ; Legenda Vermelho do Item do Reembolso
    5 = Aguardando informação do beneficiárioB = Aguardando informação do Beneficiário
    6 = Aprovado parcialmenteC = Aprovado Parcialmente
    7 = CanceladoD = Cancelado
    8 = Reembolso revertidoE = Reembolso Revertido

    Endpoint
    Âncora
    STATUSENDPOINT
    STATUSENDPOINT

    UrlMétodoHeader Content-TypeDescrição
    https://<url>:<porta>/rest/mobileSaude/v1/
    reeStatus
    statusReembolsoPOSTapplication/jsonRetorna os status do protocolo de
    autorização
    reembolso

    Parâmetros de Entrada do Método
    Âncora
    STATUSPARAMETRO
    STATUSPARAMETRO

    Não é necessário enviar parâmetros para este método.

    ...

    Exemplo
    Âncora
    STATUSEXEMPLO
    STATUSEXEMPLO

    Bloco de código
    languagec#
    themeMidnight
    titleRequest body
    linenumberstrue
    collapsetrue
    {}
    Bloco de código
    languagec#
    themeMidnight
    titleAPI Retorno - Sucesso
    linenumberstrue
    collapsetrue
    {
        "status": true,
        "reembolsoStatus": [
            {
                "chaveStatus": "0",
                "descricao": "Solicitação não concluida"
            },
            {
                "chaveStatus": "1",
                "descricao": "Protocolado"
            },
            {
                "chaveStatus": "2",
                "descricao": "Em Analise"
            },
            {
                "chaveStatus": "3",
                "descricao": "Aprovado"
            },
            {
                "chaveStatus": "4",
                "descricao": "Rejeitado"
            },
            {
                "chaveStatus": "5",
                "descricao": "Aguardando informação do beneficiário"
            },
            {
                "chaveStatus": "6",
                "descricao": "Aprovado parcialmente"
            },
            {
                "chaveStatus": "7",
                "descricao": "Cancelado"
            },
            {
                "chaveStatus": "8",
                "descricao": "Reembolso revertido"
            }
        ]
    }

    Estrutura de Retorno
    Âncora
    STATUSESTRUTURA
    STATUSESTRUTURA

    AtributoTipoDescrição
    statusLógico

    True: Indica que a requisição foi bem-sucedida

    False: Indica que a requisição foi mal sucedida

    motivoCriticaCaracter Motivo pelo qual não foi possível realizar a requisição, quando o status for igual a False

    reembolsoStatus

    ArrayLista de objetos de “reembolsoStatus
    chaveStatusCaracterCódigo de identificação do status do Reembolso
    descricao
    CaracterDescrição do status

    Veja um exemplo de como a comunicação com a API é feita na prática:

    03. TELA EXTRATO DE REEMBOLSO

    Outras Ações / Ações relacionadas

    ...

    CaracterDescrição do status

    03. TELA EXTRATO DE REEMBOLSO
    Âncora
    TELAEXTRATO1
    TELAEXTRATO1

    Outras Ações / Ações relacionadas

    AçãoDescrição
    Não se aplicaNão se aplica

    04. TELA EXTRATO DE REEMBOLSO
    Âncora
    TELAEXTRATO2
    TELAEXTRATO2

    Principais Campos e Parâmetros do TOTVS Saúde Planos Linha Protheus

    CampoDescrição
    BA0_MSGUIAIndica a quantidade de meses que o sistema irá verificar os protocolos de reembolso. Por exemplo: valor 6, será verificado os reembolsos dos últimos 6 meses 
    BA0_MSURDOInforme a URL HTTP para download dos arquivos anexados do protocolo de reembolso.

    05. TABELAS UTILIZADAS
    Âncora
    TABELAS
    TABELAS

    • BOW - Protocolo de Reembolso
    • B1N - Itens do Protocolo de Reembolso
    • ACB - Banco de Conhecimento
    • BOX - Histórico do Protocolo de Reembolso

    04. TELA EXTRATO DE REEMBOLSO

    Principais Campos e Parâmetros do TOTVS Saúde Planos Linha Protheus

    ...