Este documento tem como objetivo orientar a utilização da API Extrato de Autorizações para utilizar na 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, por status, e possibilitar a visualização dos itens da guia e imprimir a guia completa em PDF.
A API utilizará o padrão REST.
Lista de métodos utilizados na API:
A autenticação dos métodos listados abaixo é realizado através da Api /token, onde será retornado a chave e token a ser adicionado no header de cada método.
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.
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).
Login realizado por CPF, o sistema irá listar as autorizações de todos os contratos vinculado aquele CPF.
Login 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.
| 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âmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| chaveBeneficiario | Sim | String | Chave do Beneficiário (CPF ou Matricula) |
| chaveBeneficiarioTipo | Sim | String | Tipo de Login do Beneficiário (CPF ou Matricula) |
| multiContract | Sim | Boolean | Utilização de Multi Contratos pelo Beneficiário |
| dataInicial | Não | String | Data inicial do extrato de autorizações |
| dataFinal | Não | String | Data final do extrato de autorizações |
{
"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.
{
"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"
}
]
} |
{
"status": false,
"motivoCritica": "Não existem autorizações a serem visualizadas"
} |
| 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 + Guia) |
| beneficiarioMatricula | String | Matricula do Beneficiário. |
| beneficiarioNome | String | Nome do Beneficiário. |
| statusId | Integer |
Este método irá retornar os detalhes (itens) de uma guia de autorização.
As itens das guias que o sistema irá retornar são: SP/SADT, Consulta e 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 contem a tabela cabeçalho e o numero da guia.
| 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âmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| chaveAutorizacao | Sim | String | Chave única de identificação da guia de autorização |
{
"chaveAutorizacao": "BEA|000120220200000005"
} |
{
"status": true,
"itens": [
{
"procedimentoDescricao": "SANGUE OCULTO, PESQUISA NAS FEZES",
"quantidadeSolicitada": 1,
"dataAutorizacao": "2022-02-04",
"quantidadeAutorizada": 0,
"itemId": "000120220200000005001",
"statusId": 3,
"procedimento": "40303136"
}
]
} |
{
"status": false,
"motivoCritica": "Não existem itens a serem visualizados"
} |
Este método irá retornar uma URL ou uma string BASE64 do arquivo PDF da guia completa.
| 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âmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| chaveAutorizacao | Sim | String | Chave única de identificação da guia de autorização |
{
"chaveAutorizacao": "BEA|000120220200000005"
} |
{
"status": true,
"url": "c:\\protheus12127\\protheus_data\\web\\pp\\imagens-pls\\relatorios\\guisadtsc034810.pdf",
"binario": ""
} |
{
"status": false,
"motivoCritica": "Não foi possível gerar o PDF da Guia"
} |
Retorna a tabela de domínio dos status da autorização, para que possamos montar as legendas da listagem.
| Url | Método | Header Content-Type | Descrição |
|---|---|---|---|
| https://<url>:<porta>/rest/mobileSaude/v1/guiaStatus | POST | application/json | Retorna os status de autorização |
Não é necessário enviar parâmetros para este método.
{} |
{
"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"
}
]
} |
Veja um exemplo de como a comunicação com a API é feita na prática:
Outras Ações / Ações relacionadas
| Ação | Descrição |
|---|---|
| Inclua a ação | Inclua a descrição relacionada |
| Inclua a ação | Inclua a descrição relacionada |
| Inclua a ação | Inclua a descrição relacionada |
Principais Campos e Parâmetros
| Campo | Descrição |
|---|---|
| Inclua o campo | Inclua a descrição relacionada |
| Inclua o campo | Inclua a descrição relacionada |
| Inclua o campo | Inclua a descrição relacionada |
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