Histórico da Página

CONTEÚDO

Visão Geral
Exemplo de utilização
Tela Extrato de Autorizações
1. Outras Ações / Ações relacionadas
Tela Extrato de Autorizações
1. Principais Campos e Parâmetros
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:

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

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

Se o Login for realizado por CPF, o sistema irá listar as autorizações de todos os contratos vinculado aquele CPF.

Se o Login for realizado por matricula, o sistema irá listar somente as autorizações daquele contrato.

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

Url	Método	Header Content-Type	Descrição
https://<url>:<porta>/rest/mobileSaude/v1/guiaAutorizacoes	POST	application/json	Retorna uma lista com as guias de autorização

Parâmetros de Entrada do Método

Parâmetro	Obrigatório	Tipo	Descrição
chaveBeneficiario	Sim	Caracter	Chave do Beneficiário (CPF ou Matricula)
chaveBeneficiarioTipo	Sim	Caracter	Tipo de Login do Beneficiário (CPF ou Matricula)
multiContract	Sim	Lógico	Utilização de Multi Contratos pelo Beneficiário
dataInicial	Não	Caracter	Data inicial do extrato de autorizações
dataFinal	Não	Caracter	Data final do extrato de autorizações

Exemplo

Bloco de código

language	c#
theme	Midnight
title	Request body
linenumbers	true
collapse	true

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

Bloco de código

language	c#
theme	Midnight
title	API Retorno - Sucesso
linenumbers	true
collapse	true

{
    "status": true,
    "autorizacoes": [
        {
            "dataAutorizacao": "2022-02-04",
            "tipoTratamento": "SP/SADT",
            "numeroPedido": "20220200000005",
            "dataSolicitacao": "2022-02-04",
            "senha ": "",
            "beneficiarioMatricula": "00011007000001012",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusId": 3,
            "beneficiarioNome": "CATELYN STARK",
            "especialidade": "CLINICA MEDICA",
            "chaveAutorizacao": "BEA|000120220200000005"
        },
        {
            "dataAutorizacao": "2022-01-24",
            "tipoTratamento": "QUIMIOTERAPIA",
            "numeroPedido": "20220200000002",
            "dataSolicitacao": "2022-02-03",
            "senha ": "",
            "beneficiarioMatricula": "00011007000001012",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusId": 1,
            "beneficiarioNome": "CATELYN STARK",
            "especialidade": "CLINICA MEDICA",
            "chaveAutorizacao": "B4A|000120220200000002"
        },
        {
            "dataAutorizacao": "2022-01-24",
            "tipoTratamento": "RADIOTERAPIA",
            "numeroPedido": "20220200000003",
            "dataSolicitacao": "2022-02-03",
            "senha ": "",
            "beneficiarioMatricula": "00011007000001012",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusId": 1,
            "beneficiarioNome": "CATELYN STARK",
            "especialidade": "CLINICA MEDICA",
            "chaveAutorizacao": "B4A|000120220200000003"
        },
        {
            "dataAutorizacao": "2022-02-03",
            "tipoTratamento": "CONSULTA",
            "numeroPedido": "20220200000001",
            "dataSolicitacao": "2022-02-03",
            "senha ": "",
            "beneficiarioMatricula": "00011007000001012",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusId": 6,
            "beneficiarioNome": "CATELYN STARK",
            "especialidade": "CLINICA MEDICA",
            "chaveAutorizacao": "BEA|000120220200000001"
        },
        {
            "dataAutorizacao": "2022-01-24",
            "tipoTratamento": "OPME",
            "numeroPedido": "20220100000004",
            "dataSolicitacao": "2022-01-24",
            "senha ": "",
            "beneficiarioMatricula": "00011007000001012",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusId": 1,
            "beneficiarioNome": "CATELYN STARK",
            "especialidade": "CLINICA MEDICA",
            "chaveAutorizacao": "B4A|000120220100000004"
        },
        {
            "dataAutorizacao": "2022-01-24",
            "tipoTratamento": "PRORROGACAO DE INTERNACAO",
            "numeroPedido": "20220100000005",
            "dataSolicitacao": "2022-01-24",
            "senha ": "",
            "beneficiarioMatricula": "00011007000001012",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusId": 1,
            "beneficiarioNome": "CATELYN STARK",
            "especialidade": "CLINICA MEDICA",
            "chaveAutorizacao": "B4Q|000120220100000005"
        },
        {
            "dataAutorizacao": "2022-01-24",
            "tipoTratamento": "INTERNACAO",
            "numeroPedido": "20220100000001",
            "dataSolicitacao": "2022-01-24",
            "senha ": "9289259502119996",
            "beneficiarioMatricula": "00011007000001012",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusId": 1,
            "beneficiarioNome": "CATELYN STARK",
            "especialidade": "CLINICA MEDICA",
            "chaveAutorizacao": "BE4|000120220100000001"
        },
        {
            "dataAutorizacao": "2022-01-24",
            "tipoTratamento": "SP/SADT",
            "numeroPedido": "20220100000002",
            "dataSolicitacao": "2022-01-24",
            "senha ": "",
            "beneficiarioMatricula": "00019875000001011",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusId": 1,
            "beneficiarioNome": "CATELYN STARK",
            "especialidade": "CLINICA MEDICA",
            "chaveAutorizacao": "BEA|000120220100000002"
        },
        {
            "dataAutorizacao": "2022-01-24",
            "tipoTratamento": "SP/SADT",
            "numeroPedido": "20220100000003",
            "dataSolicitacao": "2022-01-24",
            "senha ": "",
            "beneficiarioMatricula": "00011007000001012",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusId": 1,
            "beneficiarioNome": "CATELYN STARK",
            "especialidade": "CLINICA MEDICA",
            "chaveAutorizacao": "BEA|000120220100000003"
        }
    ]
}

Bloco de código

language	c#
theme	Midnight
title	Retorno API - Falha
linenumbers	true
collapse	true

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

Estrutura de Retorno

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
autorizacoes	Array	Lista de objetos de “autorizacao“
chaveAutorizacao	Caracter	Chave de Identificação da Guia no sistema (Tabela + \| +Operadora + Ano + Mês + Numero)
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 guiaStatus. (Status da TISS)
dataSolicitacao	Caracter	Data da solicitação (Formato: YYYY-MM-DD)
dataAutorizacao	Caracter	Data da autorização (Formato: YYYY-MM-DD)
nomePrestador	Caracter	Nome da Rede de Atendimento
especialidade	Caracter	Descrição da especialidade vinculada
tipoTratamento	Caracter	Descrição do tipo do tratamento (sendo: CONSULTA, SP/SADT, INTERNACAO, QUIMIOTERAPIA, RADIOTERAPIA, OPME, PRORROGACAO DE INTERNACAO e ODONTOLOGIA)
numeroPedido	Caracter	Numero da Guia no sistema ( Ano + Mês + Numero)
senha	Caracter	Senha informada na Guia

Método guiaDetalhe

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

Endpoint

Url	Método	Header Content-Type	Descrição
https://<url>:<porta>/rest/mobileSaude/v1/guiaDetalhe	POST	application/json	Retorna eventos (itens) da guia de autorização

Parâmetros de Entrada do Método

Parâmetro	Obrigatório	Tipo	Descrição
chaveAutorizacao	Sim	Caracter	Chave única de identificação da guia de autorização

Exemplo

Bloco de código

language	c#
theme	Midnight
title	Request body
linenumbers	true
collapse	true

{
    "chaveAutorizacao": "BEA|000120220200000005"
}

Bloco de código

language	c#
theme	Midnight
title	API Retorno - Sucesso
linenumbers	true
collapse	true

{
    "status": true,
    "itens": [
        {
            "procedimentoDescricao": "SANGUE OCULTO, PESQUISA NAS FEZES",
            "quantidadeSolicitada": 1,
            "dataAutorizacao": "2022-02-04",
            "quantidadeAutorizada": 0,
            "itemId": "000120220200000005001",
            "statusId": 3,
            "procedimento": "40303136"
        }
    ]
}

Bloco de código

language	c#
theme	Midnight
title	Retorno API - Falha
linenumbers	true
collapse	true

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

Estrutura de Retorno

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“
itemId	Caracter	Chave única do item da guia de autorização (Operadora + Ano + Mês + Numero + Sequencial)
procedimento	Caracter	Código do procedimento
procedimentoDescricao	Caracter	Descrição do procedimento
statusId	Numérico	Código do status, conforme retorno do método guiaStatus. (Status da TISS)
quantidadeSolicitada	Numérico	Quantidade solicitada (Numérico com duas casas decimais)
quantidadeAutorizada	Numérico	Quantidade autorizada pela operadora (Numérico com duas casas decimais)
dataAutorizacao	Caracter	Data 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 guiaAutorizacoes. 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 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 BA0_MSPDFU o caminho para acessar pela internet.

Endpoint

Url	Método	Header Content-Type	Descrição
https://<url>:<porta>/rest/mobileSaude/v1/guiaPdf	POST	application/json	Retorna a guia completa em PDF

Parâmetros de Entrada do Método

Parâmetro	Obrigatório	Tipo	Descrição
chaveAutorizacao	Sim	Caracter	Chave única de identificação da guia de autorização

Exemplo

Bloco de código

language	c#
theme	Midnight
title	Request body
linenumbers	true
collapse	true

{
    "chaveAutorizacao": "BEA|000120220200000005"
}

Bloco de código

language	c#
theme	Midnight
title	API Retorno - Sucesso
linenumbers	true
collapse	true

{
    "status": true,
    "url": "c:\\protheus12127\\protheus_data\\web\\pp\\imagens-pls\\relatorios\\guisadtsc034810.pdf",
    "binario": ""
}

Bloco de código

language	c#
theme	Midnight
title	Retorno API - Falha
linenumbers	true
collapse	true

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

Estrutura de Retorno

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
binario	Caracter em base64	Conteúdo binário do tipo base64, do arquivo PDF da guia a ser impressa
url	Caracter	URL completo do arquivo PDF informado no cadastro da Operadora

Método guiaStatus

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

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

Url	Método	Header Content-Type	Descrição
https://<url>:<porta>/rest/mobileSaude/v1/guiaStatus	POST	application/json	Retorna os status de autorização

Parâmetros de Entrada do Método

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

Exemplo

Bloco de código

language	c#
theme	Midnight
title	Request body
linenumbers	true
collapse	true

{}

Bloco de código

language	c#
theme	Midnight
title	API Retorno - Sucesso
linenumbers	true
collapse	true

{
    "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

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
autorizacaoStatus	Array	Lista de objetos de “autorizacaoStatus“
chaveStatus	Caracter	Código de identificação do status da autorização
descricao	Caracter	Descrição do status

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

API Extrato de Autorizações

03. TELA EXTRATO DE AUTORIZAÇÕES

Outras Ações / Ações relacionadas

Ação	Descrição
Não se aplica	Não se aplica

04. TELA EXTRATO DE AUTORIZAÇÕES

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

Campo	Descrição
BA0_MSGUIA	Indica 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_MSTLOG	Informar 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_PLIMSAE	Permite realizar a reimpressão de Guias de Liberações que já foram executadas
MV_IGUINE	Permite 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

Árvore de páginas

Versões comparadas

Versão antiga 28

Nova versão 29

Chave

CONTEÚDO

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

Método guiaAutorizacoes

Regras de Negocio do Método

Endpoint

Parâmetros de Entrada do Método

Exemplo

Estrutura de Retorno

Método guiaDetalhe

Regras de Negocio do Método

Endpoint

Parâmetros de Entrada do Método

Exemplo

Estrutura de Retorno

Método guiaPdf

Regras de Negocio do Método

Endpoint

Parâmetros de Entrada do Método

Exemplo

Estrutura de Retorno

Método guiaStatus

Regras de Negocio do Método

Endpoint

Parâmetros de Entrada do Método

Exemplo

Estrutura de Retorno

03. TELA EXTRATO DE AUTORIZAÇÕES

04. TELA EXTRATO DE AUTORIZAÇÕES

05. TABELAS UTILIZADAS