Árvore de páginas


CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
    1. Método extratoAutorizacao
      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 detalheAutorizacao
      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 statusAutorizacao
      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

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

Segue os métodos utilizados na API:

  • extratoAutorizacao: Retorna uma lista com todas as guias de autorização do beneficiário e do seu grupo familiar, conforme regra de negócio.
  • detalheAutorizacao: Retorna eventos (itens) da guia de autorização.
  • guiaPdf: Retorna a URL ou a string BASE64 do arquivo PDF da guia completa.
  • statusAutorizacao: Retorna os status das guias de autorização, 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 extratoAutorizacao

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

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). 

Se os parâmetros Data Inicial e  Data Final não forem informados, será retornado uma lista de autorizações 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 as suas autorizações e de todo o grupo familiar.

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

Endpoint

UrlMétodoHeader Content-TypeDescrição
https://<url>:<porta>/rest/mobileSaude/v1/extratoAutorizacaoPOSTapplication/jsonRetorna uma lista com as guias de autorização

Parâmetros de Entrada do Método

ParâmetroObrigatórioTipoDescrição
chaveBeneficiarioNãoCaracterChave do Beneficiário (CPF ou Matricula)
chaveBeneficiarioTipoNãoCaracterTipo de Login do Beneficiário (CPF ou Matricula)
multiContractNãoLógicoUtilização de Multi Contratos pelo Beneficiário
dataInicialNãoCaracterData inicial do extrato de autorizações
dataFinalNãoCaracterData final do extrato de autorizações

matriculaContrato

SimCaracterMatricula do Beneficiário

Exemplo

Request body
{
    "chaveBeneficiarioTipo": "CPF",
    "multiContract": false,
    "chaveBeneficiario": "82737323800",
    "dataInicial": "2022-07-01",
    "dataFinal": "2022-07-04",
	"matriculaContrato": "00011008000019017" 
}
API Retorno - Sucesso
{
    "status": true,
    "autorizacoes": [
        {
            "chaveAutorizacao": "BEA|000120220700000002",
            "beneficiarioMatricula": "00011008000019017",
            "beneficiarioNome": "RUAN CAUA DA COSTA",
            "statusId": 1,
            "dataSolicitacao": "2022-07-04",
            "dataAutorizacao": "2022-07-04",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "especialidade": "CLINICA MEDICA",
            "tipoTratamento": "CONSULTA",
            "numeroPedido": "20220700000002",
            "senha ": ""
        }
    ]
}
Retorno API - Falha
{
    "status": false,
    "motivoCritica": "Um atributo obrigatório não foi informado."
}

Estrutura de Retorno

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
autorizacoesArrayLista de objetos de “autorizacao“
chaveAutorizacaoCaracterChave de Identificação da Guia no sistema (Tabela + | +Operadora + Ano + Mês + Numero)
beneficiarioMatriculaCaracterMatricula do Beneficiário (Operadora + Empresa + Matricula + Tipo Registro + Digito)
beneficiarioNomeCaracterNome do Beneficiário
statusIdNuméricoCódigo do status, conforme retorno do método statusAutorizacao. (Status da TISS)
dataSolicitacaoCaracterData da solicitação (Formato: YYYY-MM-DD)
dataAutorizacaoCaracterData da autorização (Formato: YYYY-MM-DD)
nomePrestadorCaracterNome da Rede de Atendimento
especialidadeCaracterDescrição da especialidade vinculada
tipoTratamentoCaracter

Descrição do tipo do tratamento (sendo: CONSULTA, SP/SADT, INTERNACAO, QUIMIOTERAPIA,

RADIOTERAPIA, OPME, PRORROGACAO DE INTERNACAO e ODONTOLOGIA)

numeroPedido CaracterNumero da Guia no sistema ( Ano + Mês + Numero)
senhaCaracterSenha informada na Guia

Método detalheAutorizacao

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

Regras de Negocio do Método

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 extratoAutorizacao. A Chave deverá conter a tabela do cabeçalho e o numero da guia.

Endpoint

UrlMétodoHeader Content-TypeDescrição
https://<url>:<porta>/rest/mobileSaude/v1/detalheAutorizacaoPOSTapplication/jsonRetorna eventos (itens) da guia de autorização

Parâmetros de Entrada do Método

ParâmetroObrigatórioTipoDescrição
chaveAutorizacaoSimCaracterChave única de identificação da guia de autorização

Exemplo

Request body
{
    "chaveAutorizacao": "BEA|000120220200000005"
}
API Retorno - Sucesso
{
    "status": true,
    "itens": [
        {
            "procedimentoDescricao": "SANGUE OCULTO, PESQUISA NAS FEZES",
            "quantidadeSolicitada": 1,
            "dataAutorizacao": "2022-02-04",
            "quantidadeAutorizada": 0,
            "itemId": "000120220200000005001",
            "statusId": 3,
            "procedimento": "40303136"
        }
    ]
}
Retorno API - Falha
{
    "status": false,
    "motivoCritica": "Não existem itens a serem visualizados"
}

Estrutura de Retorno

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“
itemIdCaracterChave única do item da guia de autorização (Operadora + Ano + Mês + Numero + Sequencial)
procedimentoCaracterCódigo do procedimento
procedimentoDescricaoCaracterDescrição do procedimento
statusIdNuméricoCódigo do status, conforme retorno do método statusAutorizacao. (Status da TISS)
quantidadeSolicitadaNuméricoQuantidade solicitada (Numérico com duas casas decimais)
quantidadeAutorizadaNuméricoQuantidade autorizada pela operadora (Numérico com duas casas decimais)
dataAutorizacaoCaracterData da autorização do procedimento (Formato: YYYY-MM-DD)

Método guiaPdf

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

Regras de Negocio do Método

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).

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

O sistema não irá gerar o PDF para o seguintes casos: guia cancelada, guia não autorizada ou guia em analise. Nos casos da guia não autorizada e também em analise é possível habilitar a impressão pelo parâmetro MV_IGUINE, exceto em guias de anexo clínico.

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

UrlMétodoHeader Content-TypeDescrição
https://<url>:<porta>/rest/mobileSaude/v1/guiaPdfPOSTapplication/jsonRetorna a guia completa em PDF

Parâmetros de Entrada do Método

ParâmetroObrigatórioTipoDescrição
chaveAutorizacaoSimCaracterChave única de identificação da guia de autorização

Exemplo

Request body
{
    "chaveAutorizacao": "BEA|000120220200000005"
}
API Retorno - Sucesso
{
    "status": true,
    "url": "c:\\protheus12127\\protheus_data\\web\\pp\\imagens-pls\\relatorios\\guisadtsc034810.pdf",
    "binario": ""
}
Retorno API - Falha
{
    "status": false,
    "motivoCritica": "Não foi possível gerar o PDF da Guia"
}

Estrutura de Retorno

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
binarioCaracter em base64Conteúdo binário do tipo base64, do arquivo PDF da guia a ser impressa
urlCaracterURL completo do arquivo PDF informado no cadastro da Operadora

Método statusAutorizacao

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

Regras de Negocio do Método

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

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

Parâmetros de Entrada do Método

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

Exemplo

Request body
{}
API Retorno - Sucesso
{
    "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

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
autorizacaoStatusArrayLista de objetos de “autorizacaoStatus“
chaveStatusCaracterCódigo de identificação do status da autorização
descricaoCaracterDescrição do status

03. TELA EXTRATO DE AUTORIZAÇÕES

Outras Ações / Ações relacionadas

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

04. TELA EXTRATO DE AUTORIZAÇÕES

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 as guias de autorizações. Por exemplo: valor 6, será verificado as guias dos últimos 6 meses 
BA0_MSTLOGInformar o tipo de acesso de login na API da mobile saúde
BA0_MSMULT

Indica se o acesso a Mobile Saúde é Multi Contrato

BA0_MSPDFM

Informe se o download dos PDF´s das API´s Mobile Saúde será via download através de um URL HTTP ou o arquivo será transmitido via Base 64 no JSON de resposta.

BA0_MSPDFU

Informe a URL HTTP para download dos arquivos PDF´s na integração com a Mobile Saúde quando selecionado a opção via URL.

MV_PLIMSAEPermite realizar a reimpressão de Guias de Liberações que já foram executadas
MV_IGUINEPermite a impressão de guias em análise ou não autorizadas

05. TABELAS UTILIZADAS

  • 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