Histórico da Página

...

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.

...

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

...

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

...

Parâmetro	Obrigatório	Tipo	Descrição
chaveBeneficiario	SimNão	Caracter	Chave do Beneficiário (CPF ou Matricula)
chaveBeneficiarioTipo	SimNão	Caracter	Tipo de Login do Beneficiário (CPF ou Matricula)
multiContract	SimNão	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

...

matriculaContrato

...

Sim

Caracter

Matricula do Beneficiário

Exemplo Âncora
DECLARACAOEXEMPLO
DECLARACAOEXEMPLO DECLARACAOEXEMPLO

Bloco de código

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

{
    "chaveBeneficiarioTipo": "CPF",
    "multiContract": truefalse,
    "chaveBeneficiario": "7646163309082737323800",
    "dataInicial": "2022-0107-01",
    "dataFinal": "2022-0207-04",
	"matriculaContrato": "00011008000019017" 
}

Bloco de código

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

{
    "status": true,
    "autorizacoes": [
        {
            "dataAutorizacaochaveAutorizacao": "2022-02-04BEA|000120220700000002",
            "tipoTratamentobeneficiarioMatricula": "SP/SADT00011008000019017",
            "numeroPedidobeneficiarioNome": "20220200000005RUAN CAUA DA COSTA",
            "dataSolicitacaostatusId": "2022-02-04"1,
            "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-24dataSolicitacao": "2022-07-04",
            "senha dataAutorizacao": "",
            "beneficiarioMatricula": "00011007000001012"2022-07-04",
            "nomePrestador": "HOSPITAL BOM CLIMA",
            "statusIdespecialidade": 1"CLINICA MEDICA",
            "beneficiarioNometipoTratamento": "CATELYN STARKCONSULTA",
            "especialidadenumeroPedido": "CLINICA MEDICA20220700000002",
            "chaveAutorizacaosenha ": "BEA|000120220100000003"
        }
    ]
}

Bloco de código

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

{
    "status": false,
    "motivoCritica": "NãoUm existematributo autorizaçõesobrigatório anão seremfoi visualizadasinformado."
}

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

...

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.

...

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

...

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

...

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.

...

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 guiaAutorizacoes extratoAutorizacao e guiaDetalhe detalheAutorizacao.

Regras de Negocio do Método Âncora
STATUSREGRA
STATUSREGRA

...

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

...

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 Image Removed

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

...

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

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

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

...

Árvore de páginas

Versões comparadas

Versão antiga 34

Nova versão Atual

Chave

Parâmetros de Entrada do Método

Exemplo

Estrutura de Retorno

Parâmetros de Entrada do Método

Exemplo

Estrutura de Retorno

Parâmetros de Entrada do Método

Exemplo

Estrutura de Retorno

Parâmetros de Entrada do Método

Exemplo

Estrutura de Retorno

Método

extratoAutorizacao
Âncora
AUTORIZACAO
AUTORIZACAO

Exemplo Âncora
DECLARACAOEXEMPLO
DECLARACAOEXEMPLO DECLARACAOEXEMPLO

Estrutura de Retorno Âncora
AUTORIZACAORETORNO
AUTORIZACAORETORNO

Método

detalheAutorizacao
Âncora
DETALHE
DETALHE

Método

statusAutorizacao
Âncora
STATUS
STATUS

Regras de Negocio do Método Âncora
STATUSREGRA
STATUSREGRA

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

05. TABELAS UTILIZADAS Âncora
TABELAS
TABELAS

Árvore de páginas

Histórico da Página

Versões comparadas

Chave

Método

extratoAutorizacao ÂncoraAUTORIZACAOAUTORIZACAO

Exemplo ÂncoraDECLARACAOEXEMPLODECLARACAOEXEMPLODECLARACAOEXEMPLO

Estrutura de Retorno ÂncoraAUTORIZACAORETORNOAUTORIZACAORETORNO

Método

detalheAutorizacao ÂncoraDETALHEDETALHE

Método

statusAutorizacao ÂncoraSTATUSSTATUS

Regras de Negocio do Método ÂncoraSTATUSREGRASTATUSREGRA

03. TELA EXTRATO DE AUTORIZAÇÕES ÂncoraTELAAUTORIZACOES1TELAAUTORIZACOES1

05. TABELAS UTILIZADAS ÂncoraTABELASTABELAS

extratoAutorizacao
Âncora
AUTORIZACAO
AUTORIZACAO

Exemplo Âncora
DECLARACAOEXEMPLO
DECLARACAOEXEMPLO DECLARACAOEXEMPLO

Estrutura de Retorno Âncora
AUTORIZACAORETORNO
AUTORIZACAORETORNO

detalheAutorizacao
Âncora
DETALHE
DETALHE

statusAutorizacao
Âncora
STATUS
STATUS

Regras de Negocio do Método Âncora
STATUSREGRA
STATUSREGRA

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

05. TABELAS UTILIZADAS Âncora
TABELAS
TABELAS