Á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. Método guiaAutorizacoesextratoAutorizacao
      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 guiaDetalhedetalheAutorizacao
      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 guiaStatusstatusAutorizacao
      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:

  • guiaAutorizacoesextratoAutorizacao: Retorna uma lista com todas as guias de autorização do beneficiário e do seu grupo familiar, conforme regra de negócio.
  • guiaDetalhedetalheAutorizacao: Retorna eventos (itens) da guia de autorização.
  • guiaPdf: Retorna a URL ou a string BASE64 do arquivo PDF da guia completa.
  • guiaStatusstatusAutorizacao: Retorna os status das guias de autorização, para montagem das legendas da listagem.

...

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.

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

beneficiário solicitado for o titular, será retornado as suas autorizações e de todo o grupo familiar.

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

Endpoint
Âncora
AUTORIZACAOENDPOINT
AUTORIZACAOENDPOINT

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

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

ParâmetroObrigatórioTipoDescrição
chaveBeneficiarioSimNãoCaracterChave do Beneficiário (CPF ou Matricula)
chaveBeneficiarioTipoSimNãoCaracterTipo de Login do Beneficiário (CPF ou Matricula)
multiContractSimNã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

...

Sim

...

CaracterMatricula do Beneficiário

Exemplo
Âncora
DECLARACAOEXEMPLO
DECLARACAOEXEMPLO

Bloco de código
languagec#
c#themeMidnight
titleRequest body
linenumberstrue
collapsetrue
{
    "chaveBeneficiarioTipo": "CPF",
    "multiContract": truefalse,
    "chaveBeneficiario": "7646163309082737323800",
    "dataInicial": "2022-0107-01",
    "dataFinal": "2022-0207-04",
	"matriculaContrato": "00011008000019017" 
}
Bloco de código
languagec#
themeMidnight
titleAPI Retorno - Sucesso
linenumberstrue
collapsetrue
{
    "status": true,
    "autorizacoes": [
        {
            "dataAutorizacaochaveAutorizacao": "2022-02-04BEA|000120220700000002",
            "tipoTratamentobeneficiarioMatricula": "SP/SADT00011008000019017",
            "numeroPedidobeneficiarioNome": "20220200000005RUAN CAUA DA COSTA",
            "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"statusId": 1,
            "senha dataSolicitacao": "2022-07-04",
            "beneficiarioMatriculadataAutorizacao": "000110070000010122022-07-04",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusIdespecialidade": 1"CLINICA MEDICA",
            "beneficiarioNometipoTratamento": "CATELYN STARKCONSULTA",
            "especialidadenumeroPedido": "CLINICA MEDICA20220700000002",
            "chaveAutorizacaosenha ": "BEA|000120220100000003"
        }
    ]
}
Bloco de código
languagec#
themeMidnight
titleRetorno API - Falha
linenumberstrue
collapsetrue
{
    "status": false,
    "motivoCritica": "NãoUm existematributo autorizaçõesobrigatório anão seremfoi visualizadasinformado."
}

Estrutura de Retorno
Âncora
AUTORIZACAORETORNO
AUTORIZACAORETORNO

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

Endpoint
Âncora
DETALHEENDPOINT
DETALHEENDPOINT

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

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

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

Exemplo
Âncora
DETALHEEXEMPLO
DETALHEEXEMPLO

Bloco de código
languagec#
themeMidnight
titleRequest body
linenumberstrue
collapsetrue
{
    "chaveAutorizacao": "BEA|000120220200000005"
}

...

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

Estrutura de Retorno
Âncora
DETALHERETORNO
DETALHERETORNO

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

...

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 MSPDFU) o caminho para acessar pela internet.

Endpoint
Âncora
PDFENDPOINT
PDFENDPOINT

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

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

Exemplo
Âncora
PDFEXEMPLO
PDFEXEMPLO

Bloco de código
languagec#
themeMidnight
titleRequest body
linenumberstrue
collapsetrue
{
    "chaveAutorizacao": "BEA|000120220200000005"
}

...

Bloco de código
languagec#
themeMidnight
titleRetorno API - Falha
linenumberstrue
collapsetrue
{
    "status": false,
    "motivoCritica": "Não foi possível gerar o PDF da Guia"
}

Estrutura de Retorno
Âncora
PDFRETORNO
PDFRETORNO

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

Retorna os status da autorização, para montagem das legendas da listagem referente aos métodos guiaAutorizacoes extratoAutorizacao e guiaDetalhe 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

UrlMétodoHeader Content-TypeDescrição
https://<url>:<porta>/rest/mobileSaude/v1/guiaStatusstatusAutorizacaoPOSTapplication/jsonRetorna 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
languagec#
themeMidnight
titleRequest body
linenumberstrue
collapsetrue
{}
Bloco de código
languagec#
themeMidnight
titleAPI Retorno - Sucesso
linenumberstrue
collapsetrue
{
    "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

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

...

API Extrato de AutorizaçõesImage Removed

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

Outras Ações / Ações relacionadas

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

04. TELA EXTRATO DE AUTORIZAÇÕES
Âncora
TELAAUTORIZACOES2
TELAAUTORIZACOES2

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

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

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

...