Histórico da Página

CONTEÚDO

1. Visão Geral
2. Exemplo de utilização
   1. Método guiaAutorizacoes
      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 guiaDetalhe
      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 guiaPdf
      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 guiaStatus
      1. Regras de Negocio do Método
      2. EndPoint

      3. Parâmetros de Entrada do Método

      4. Exemplo

      5. Estrutura de Retorno

3. Tela Extrato de Autorizações
   1. Outras Ações / Ações relacionadas
      
4. Tela Extrato de Autorizações
   1. Principais Campos e Parâmetros
      
5. Tabelas utilizadas

01. VISÃO GERAL

Âncora
VISAO VISAO

Este documento tem como objetivo demonstrar a utilização da API Extrato de Autorizações 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 das suas autorizações e seus status, a visualização dos itens da guia e a impressão da guia completa em PDF.

A API utilizará o padrão REST.

02. EXEMPLO DE UTILIZAÇÃO

Âncora
EXEMPLO EXEMPLO

Segue os métodos utilizados na API:

...

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 guiaAutorizacoes

Âncora
AUTORIZACAO AUTORIZACAO

Este método irá retornar a lista com todas as solicitações de autorização do beneficiário. Será retornado somente o cabeçalho da autorização.

Regras de Negocio do Método

Âncora
AUTORIZACAOREGRA AUTORIZACAOREGRA

As guias que o sistema irá retornar são: SP/SADT, Consulta, Odontológica (BEA); Solicitação de Internação (BE4); Prorrogação de Internação (B4Q); Anexo Clínico (B4A). 

...

Quando o beneficiário solicitado for um dependente, será retornado apenas as suas próprias autorizações.

Endpoint

Âncora
AUTORIZACAOENDPOINT AUTORIZACAOENDPOINT

Parâmetros de Entrada do Método

Âncora
DECLARACAOPARAMETRO DECLARACAOPARAMETRO

Exemplo

Âncora
DECLARACAOEXEMPLO DECLARACAOEXEMPLO

{
    "chaveBeneficiarioTipo": "CPF",
    "multiContract": true,
    "chaveBeneficiario": "76461633090",
    "dataInicial": "2022-01-01",
    "dataFinal": "2022-02-04"
}

...

{
    "status": false,
    "motivoCritica": "Não existem autorizações a serem visualizadas"
}

Estrutura de Retorno

Âncora
AUTORIZACAORETORNO AUTORIZACAORETORNO

Método guiaDetalhe

Âncora
DETALHE DETALHE

Este método irá retornar os detalhes dos eventos (itens) de uma guia de autorização.

Regras de Negocio do Método

Âncora
DETALHEREGRA DETALHEREGRA

Os itens das guias que o sistema irá retornar são: SP/SADT, Consulta, Odontológica (BE2); Solicitação de Internação (BEJ); Prorrogação de Internação (BQV); Anexo Clínico (B4C). 

Esse método irá receber a chave de autorização que foi retornado no método guiaAutorizacoes. A Chave deverá conter a tabela do cabeçalho e o numero da guia.

Endpoint

Âncora
DETALHEENDPOINT DETALHEENDPOINT

Parâmetros de Entrada do Método

Âncora
DETALHEPARAMETRO DETALHEPARAMETRO

Exemplo

Âncora
DETALHEEXEMPLO DETALHEEXEMPLO

{
    "chaveAutorizacao": "BEA|000120220200000005"
}

...

{
    "status": false,
    "motivoCritica": "Não existem itens a serem visualizados"
}

Estrutura de Retorno

Âncora
DETALHERETORNO DETALHERETORNO

Método guiaPdf

Âncora
PDF PDF

Este método irá retornar uma URL ou um caracter BASE64 do arquivo PDF da guia completa.

Regras de Negocio do Método

Âncora
PDFREGRA PDFREGRA

O PDF das guias que o sistema irá retornar são: SP/SADT, Consulta, Odontológica (BEA); Solicitação de Internação (BE4); Prorrogação de Internação (B4Q); Anexo Clínico (B4A).

...

Para guias de liberação SADT, o sistema não irá gerar o PDF quando não tiver saldo disponível, ou seja, a liberação já foi executada em uma guia de autorização. Através do parâmetro MV_PLIMSAE é possível permitir a geração quando não houver saldo.

Através do campo Modo PDF (BA0_MSPDFM) no cadastro da operadora, será definido o tipo de PDF que será gerado (URL ou base64). Quando utilizado via URL, deverá informar no campo URL PDF (BA0_MSPDFU) o caminho para acessar pela internet.

Endpoint

Âncora
PDFENDPOINT PDFENDPOINT

Parâmetros de Entrada do Método

Âncora
PDFPARAMETRO PDFPARAMETRO

Exemplo

Âncora
PDFEXEMPLO PDFEXEMPLO

{
    "chaveAutorizacao": "BEA|000120220200000005"
}

...

{
    "status": false,
    "motivoCritica": "Não foi possível gerar o PDF da Guia"
}

Estrutura de Retorno

Âncora
PDFRETORNO PDFRETORNO

Método guiaStatus

Âncora
STATUS STATUS

Retorna os status da autorização, para montagem das legendas da listagem referente aos métodos guiaAutorizacoes e guiaDetalhe.

Regras de Negocio do Método

Âncora
STATUSREGRA STATUSREGRA

O sistema irá retornar os status da guia no padrão da TISS: 1=Autorizado; 2=Em análise; 3=Negado; 4=Aguardando justificativa técnica do solicitante; 5=Aguardando documentação do prestador; 6=Solicitação cancelada; 7=Autorizado parcialmente.

Endpoint

Âncora
STATUSENDPOINT STATUSENDPOINT

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

{}

{
    "status": true,
    "autorizacaoStatus": [
        {
            "chaveStatus": "1",
            "descricao": "Autorizado"
        },
        {
            "chaveStatus": "2",
            "descricao": "Em análise"
        },
        {
            "chaveStatus": "3",
            "descricao": "Negado"
        },
        {
            "chaveStatus": "4",
            "descricao": "Aguardando justificativa técnica do solicitante"
        },
        {
            "chaveStatus": "5",
            "descricao": "Aguardando documentação do prestador"
        },
        {
            "chaveStatus": "6",
            "descricao": "Solicitação cancelada"
        },
        {
            "chaveStatus": "7",
            "descricao": "Autorizado parcialmente"
        }
    ]
}

Estrutura de Retorno

Âncora
STATUSRETORNO STATUSRETORNO

...

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

03. TELA EXTRATO DE AUTORIZAÇÕES

Âncora
TELAAUTORIZACOES1 TELAAUTORIZACOES1

Outras Ações / Ações relacionadas

04. TELA EXTRATO DE AUTORIZAÇÕES

Âncora
TELAAUTORIZACOES2 TELAAUTORIZACOES2

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

05. TABELAS UTILIZADAS

Âncora
TABELAS TABELAS

• BEA - Cabeçalho das Guias de Autorizações
• BE2 - Itens das Guias Autorizações
• BE4 - Cabeçalho das Guias de Internações
• BEJ - Itens das Guias de Internações
• B4Q - Cabeçalho das Guias de Prorrogação de Internação
• BQV - Itens das Guias de Prorrogação de Internação (Evolução das Diárias)
• B4A - Cabeçalho das Guias de Anexos Clínicos 
• B4C - Itens das Guias de Anexos Clínicos
• BA0 - Cadastro de Operadoras

...