Histórico da Página

CONTEÚDO

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

guiaAutorizacoesextratoAutorizacao: retorna Retorna uma lista com todos os protocolos todas as guias de autorização do beneficiário e do seu grupo familiar, conforme regra de negócio da sua operadora.
guiaDetalhedetalheAutorizacao: retorna Retorna eventos (itens) da guia de autorização (método opcional).
guiaPdf: retorna Retorna a URL ou a string BASE64 do arquivo PDF da guia completa.
guiaStatus: retorna a tabela de domínio dos status statusAutorizacao: Retorna os status das guias de autorização, para que possamos montar as 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
Â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).

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 Âncora
AUTORIZACAOENDPOINT
AUTORIZACAOENDPOINT

Url	Método	Header Content-Type	Descrição
https://<url>:<porta>/rest/mobileSaude/v1/

guiaAutorizacoes

extratoAutorizacao

POST

application/json

Retorna uma lista com as guias de autorização

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

Parâmetro	Obrigatório	Tipo	Descrição
chaveBeneficiario

Sim

Não

String

Caracter	Chave do Beneficiário (CPF ou Matricula)
chaveBeneficiarioTipo

Sim

Não

String

Caracter	Tipo de Login do Beneficiário (CPF ou Matricula)
multiContract

Sim

Não

Boolean

Lógico	Utilização de Multi Contratos pelo Beneficiário
dataInicial	Não

String

Caracter	Data inicial do extrato de autorizações
dataFinal	Não

String

Caracter	Data final do extrato de autorizações
matriculaContrato	Sim	Caracter	Matricula do Beneficiário

Exemplo Âncora
DECLARACAOEXEMPLO
DECLARACAOEXEMPLO

Bloco de código

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

{
    "chaveBeneficiarioTipo": "CPF",
    "multiContract": truefalse,
    "chaveBeneficiario": "5301789589082737323800",
    "dataInicial": "2022-07-01-27",
    "dataFinal",
    "dataFinal": "2022-07-04",
	"matriculaContrato": "00011008000019017" 
}

Bloco de código

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

{
    "status": true,
    "autorizacoes": [
        {
            "chaveAutorizacao": "BEA|000120220700000002",
            "beneficiarioMatricula": "00011008000019017",
            "beneficiarioNome": "RUAN CAUA DA COSTA",
            "statusId": 1,
            "dataSolicitacao": "2022-07-04",
            "dataAutorizacao": "2022-0207-04",
            "nomePrestador": "HOSPITAL BOM CLIMA",
}

Se os parâmetros Data Inicial e Final não forem informados, será retornado uma lista de autorizações de acordo com a quantidade de meses no campo BA0_MSGUIA (Campo do tipo numérico), caso o campo não seja encontrado na base de dados, será utilizado o período de verificação dos últimos 12 meses.

...

            "especialidade": "CLINICA MEDICA",
            "tipoTratamento": "CONSULTA",
            "numeroPedido": "20220700000002",
            "senha ": ""
        }
    ]
}

Bloco de código

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

{
    "status": false,
    "motivoCritica": "Um atributo obrigatório não foi informado."
}

Estrutura de Retorno Âncora
AUTORIZACAORETORNO
AUTORIZACAORETORNO

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

Endpoint Âncora
DETALHEENDPOINT
DETALHEENDPOINT

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

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

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

Exemplo Âncora
DETALHEEXEMPLO
DETALHEEXEMPLO

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 Âncora
DETALHERETORNO
DETALHERETORNO

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 statusAutorizacao. (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
Â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).

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 Âncora
PDFENDPOINT
PDFENDPOINT

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 Âncora
PDFPARAMETRO
PDFPARAMETRO

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

Exemplo Âncora
PDFEXEMPLO
PDFEXEMPLO

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 Âncora
PDFRETORNO
PDFRETORNO

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 statusAutorizacao
Âncora
STATUS
STATUS

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

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

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

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 Âncora
STATUSRETORNO
STATUSRETORNO

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

03. TELA EXTRATO DE AUTORIZAÇÕES Âncora
TELAAUTORIZACOES1
TELAAUTORIZACOES1

Outras Ações / Ações relacionadas

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

04.

...

TELA EXTRATO DE AUTORIZAÇÕES Âncora
TELAAUTORIZACOES2
TELAAUTORIZACOES2

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_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 Â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

Árvore de páginas

Histórico da Página

Versões comparadas

Chave

CONTEÚDO

01. VISÃO GERAL ÂncoraVISAOVISAO

02. EXEMPLO DE UTILIZAÇÃO

ÂncoraEXEMPLOEXEMPLO

Método

extratoAutorizacao ÂncoraAUTORIZACAOAUTORIZACAO

Regras de Negocio do Método ÂncoraAUTORIZACAOREGRAAUTORIZACAOREGRA

Endpoint ÂncoraAUTORIZACAOENDPOINTAUTORIZACAOENDPOINT

Parâmetros de Entrada do Método ÂncoraDECLARACAOPARAMETRODECLARACAOPARAMETRO

Exemplo ÂncoraDECLARACAOEXEMPLODECLARACAOEXEMPLO

Estrutura de Retorno ÂncoraAUTORIZACAORETORNOAUTORIZACAORETORNO

Método detalheAutorizacao ÂncoraDETALHEDETALHE

Regras de Negocio do Método ÂncoraDETALHEREGRADETALHEREGRA

Endpoint ÂncoraDETALHEENDPOINTDETALHEENDPOINT

Parâmetros de Entrada do Método ÂncoraDETALHEPARAMETRODETALHEPARAMETRO

Exemplo ÂncoraDETALHEEXEMPLODETALHEEXEMPLO

Estrutura de Retorno ÂncoraDETALHERETORNODETALHERETORNO

Método guiaPdf ÂncoraPDFPDF

Regras de Negocio do Método ÂncoraPDFREGRAPDFREGRA

Endpoint ÂncoraPDFENDPOINTPDFENDPOINT

Parâmetros de Entrada do Método ÂncoraPDFPARAMETROPDFPARAMETRO

Exemplo ÂncoraPDFEXEMPLOPDFEXEMPLO

Estrutura de Retorno ÂncoraPDFRETORNOPDFRETORNO

Método statusAutorizacao ÂncoraSTATUSSTATUS

Regras de Negocio do Método ÂncoraSTATUSREGRASTATUSREGRA

Endpoint ÂncoraSTATUSENDPOINTSTATUSENDPOINT

Parâmetros de Entrada do Método ÂncoraSTATUSPARAMETROSTATUSPARAMETRO

Exemplo ÂncoraSTATUSEXEMPLOSTATUSEXEMPLO

Estrutura de Retorno ÂncoraSTATUSRETORNOSTATUSRETORNO

03. TELA EXTRATO DE AUTORIZAÇÕES ÂncoraTELAAUTORIZACOES1TELAAUTORIZACOES1

04.

TELA EXTRATO DE AUTORIZAÇÕES ÂncoraTELAAUTORIZACOES2TELAAUTORIZACOES2

05. TABELAS UTILIZADAS ÂncoraTABELASTABELAS

01. VISÃO GERAL Âncora
VISAO
VISAO

Âncora
EXEMPLO
EXEMPLO

extratoAutorizacao
Âncora
AUTORIZACAO
AUTORIZACAO

Regras de Negocio do Método Âncora
AUTORIZACAOREGRA
AUTORIZACAOREGRA

Endpoint Âncora
AUTORIZACAOENDPOINT
AUTORIZACAOENDPOINT

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

Exemplo Âncora
DECLARACAOEXEMPLO
DECLARACAOEXEMPLO

Estrutura de Retorno Âncora
AUTORIZACAORETORNO
AUTORIZACAORETORNO

Método detalheAutorizacao
Âncora
DETALHE
DETALHE

Regras de Negocio do Método Âncora
DETALHEREGRA
DETALHEREGRA

Endpoint Âncora
DETALHEENDPOINT
DETALHEENDPOINT

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

Exemplo Âncora
DETALHEEXEMPLO
DETALHEEXEMPLO

Estrutura de Retorno Âncora
DETALHERETORNO
DETALHERETORNO

Método guiaPdf
Âncora
PDF
PDF

Regras de Negocio do Método Âncora
PDFREGRA
PDFREGRA

Endpoint Âncora
PDFENDPOINT
PDFENDPOINT

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

Exemplo Âncora
PDFEXEMPLO
PDFEXEMPLO

Estrutura de Retorno Âncora
PDFRETORNO
PDFRETORNO

Método statusAutorizacao
Âncora
STATUS
STATUS

Regras de Negocio do Método Âncora
STATUSREGRA
STATUSREGRA

Endpoint Âncora
STATUSENDPOINT
STATUSENDPOINT

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

Exemplo Âncora
STATUSEXEMPLO
STATUSEXEMPLO

Estrutura de Retorno Âncora
STATUSRETORNO
STATUSRETORNO

03. TELA EXTRATO DE AUTORIZAÇÕES Âncora
TELAAUTORIZACOES1
TELAAUTORIZACOES1

TELA EXTRATO DE AUTORIZAÇÕES Âncora
TELAAUTORIZACOES2
TELAAUTORIZACOES2

05. TABELAS UTILIZADAS Âncora
TABELAS
TABELAS