Histórico da Página

...

As guias que o sistema irá retornar são: SP/SADT, Consulta e 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 Final não forem informados, será retornado uma lista de autorizações de acordo com a quantidade de meses 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.

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

...

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

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, caso o campo não seja encontrado na base de dados, será utilizado o período de verificação dos últimos 12 meses.

Bloco de código

language	c#
theme	Midnight

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	Boolean	True: Indica que a requisição foi bem-sucedida False: Indica que a requisição foi mal sucedida
motivoCritica	String	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	String	Chave de Identificação da Guia no sistema (Tabela

+ GuiabeneficiarioNome

+ \| +Operadora + Ano + Mês + Numero)
beneficiarioMatricula	String	Matricula do Beneficiário

.

(Operadora + Empresa + Matricula + Tipo Registro + Digito)

beneficiarioNome

String

Nome do Beneficiário

.


statusId	Integer	Código do status, conforme retorno do método guiaStatus. (Status da TISS)
dataSolicitacao	String	Data da

solicitação -

solicitação (Formato: YYYY-MM-DD)
dataAutorizacao	String	Data da autorização

-

(Formato: YYYY-MM-DD)
nomePrestador	String	Nome da Rede de Atendimento
especialidade	String	Descrição da especialidade vinculada
tipoTratamento	String	Descrição do tipo do tratamento

,

(sendo: CONSULTA, SP/SADT, INTERNACAO, QUIMIOTERAPIA,

RADIOTERAPIA, OPME, PRORROGACAO DE INTERNACAO e ODONTOLOGIA)

numeroPedido

String

Numero da Guia no sistema

: ano, mês e numero.

( Ano + Mês + Numero)
senha	String	Senha informada na Guia

Método guiaDetalhe

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

...

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

Método guiaPdf

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

Regras de Negocio do Método

Endpoint

...

Estrutura de Retorno

Atributo	Tipo	Descrição
status	Boolean	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	Numeric	Código do status, conforme retorno do método guiaStatus. (Status da TISS)
quantidadeSolicitada	Numeric	Quantidade solicitada
quantidadeAutorizada	Numeric	Quantidade autorizada pela operadora
dataAutorizacao	Caracter	Data da autorização do procedimento (Formato: YYYY-MM-DD)

Método guiaPdf

Este método irá retornar uma URL ou uma string 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 e 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 contem a tabela 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 permite a geração quando não houver saldo.

Endpoint

Parâmetros de Entrada do Método

...

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

Método guiaStatus

Retorna a tabela de domínio dos status da autorização, para que possamos montar as legendas da listagem.

Regras de Negocio do Método

Endpoint

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

Parâmetros de Entrada do Método

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

Exemplo

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

Exemplo

Bloco de código

theme
language	c#

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,
    "autorizacaoStatusurl": ["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

    {
            "chaveStatus"status": "1"false,
            "descricaomotivoCritica": "Autorizado"
Não foi possível gerar o PDF da Guia"
}

Estrutura de Retorno

Atributo	Tipo	Descrição
status	Boolean	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 do arquivo PDF informado no cadastro da Operadora

Método guiaStatus

Retorna a tabela de domínio dos status da autorização, para que possamos montar as legendas da listagem.

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": "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": "61",
            "descricao": "Solicitação canceladaAutorizado"
        },
        {
            "chaveStatus": "72",
            "descricao": "AutorizadoEm parcialmente"
        }
    ]
}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	Boolean	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

Não se aplica

04. TELA EXTRATO DE AUTORIZAÇÕES

Outras Ações / Ações relacionadas

...

Principais Campos e Parâmetros
Campo Descrição
...

05. TABELAS UTILIZADAS

BEA - Cabeçalho das Guias de Autorizações

...

Árvore de páginas

Versões comparadas

Versão antiga 19

Nova versão 20

Chave

Estrutura de Retorno

Método guiaDetalhe

Método guiaPdf

Regras de Negocio do Método

Endpoint

Estrutura de Retorno

Método guiaPdf

Regras de Negocio do Método

Endpoint

Parâmetros de Entrada do Método

Exemplo

Método guiaStatus

Regras de Negocio do Método

Endpoint

Parâmetros de Entrada do Método

Exemplo

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

Principais Campos e Parâmetros
Campo Descrição
...

05. TABELAS UTILIZADAS

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 19

Nova versão 20

Chave

Estrutura de Retorno

Método guiaDetalhe

Método guiaPdf

Regras de Negocio do Método

Endpoint

Estrutura de Retorno

Método guiaPdf

Regras de Negocio do Método

Endpoint

Parâmetros de Entrada do Método

Exemplo

Método guiaStatus

Regras de Negocio do Método

Endpoint

Parâmetros de Entrada do Método

Exemplo

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

Principais Campos e ParâmetrosCampoDescrição...

05. TABELAS UTILIZADAS

Principais Campos e Parâmetros
Campo Descrição
...