API Authorizations - v1.000 (Attendance)

CONTEÚDO

Visão Geral
Exemplo de utilização
Tela api authorizations
1. Outras Ações / Ações relacionadas
Tela api authorizations
1. Principais Campos e Parâmetros
Tabelas utilizadas

01. VISÃO GERAL

API para a entidade authorizations (Autorizações) do produto TOTVS Saúde Planos Linha Protheus.

Clique aqui para detalhes sobre como habilitar o serviço de APIs

Autenticação das APIs

API para obtenção do token de acesso às API’s REST no Protheus

De posse então do access_token obtido na api token, basta fazer a requisição à API desejada incluindo no cabeçalho o parâmetro Authorization com o valor Bearer mais o token de acesso.

02. EXEMPLO DE UTILIZAÇÃO

Protocols - Inclusão de protocolo de autorização

Realiza a inclusão de um protocolo de solicitação de autorização para operadora.

/totvsHealthPlans/attendance/v1/authorizations/protocols

POST

Parameters

Authorization (header)	string	Cabeçalho usado para autorização das requisições (Bearer token)	*required
Content-Type (header)	string	'application/json' é o formato do conteúdo	*required

Request

subscriberId	string	Matricula do beneficiário solicitante do protocolo de autorização (obtido através da API Beneficiaries - v1.000 (Family Contract))	BKU_MATUSR	*required
stateAbbreviation	string	Estado do conselho regional do profissional de saúde solicitante	BKU_UF
professionalCouncil	string	Sigla do conselho regional do profissional de saúde solicitante (obtido através da API RegionalCouncils - v1.000 (Attendance Network))	BKU_SIGLA
professionalCouncilNumber	string	Numero do conselho regional do profissional de saúde solicitante	BKU_REGSOL
professionalName	string	Nome do profissional de saúde solicitante (obtido através da API Professionals - v1.000 (Attendance Network))	BKU_NOMSOL	*required
attachments	array	Anexos da solicitação de autorização		*required
attachments.href	string	Url do arquivo para que seja realizado o download		*required

Exemplo

{
	"subscriberId" : "00011008000027010",
	"stateAbbreviation" : "SP",
	"professionalCouncil" : "CRM",
	"professionalCouncilNumber" : "1234567",
	"professionalName" : "VINICIUS",
	"attachments" : [
        {
            "href" : "https://img.olhardigital.com.br/wp-content/uploads/2019/01/20190115163721.jpg"
        }
	]
}

(201) - Operação realizada com sucesso

protocol	string	Numero do protocolo gerado para a solicitação de autorização	BKU_NRPRO	*required
name	string	Nome do beneficiário solicitante	BKU_NOMUSR	*required
subscriberId	string	Matricula do beneficiário solicitante	BKU_MATUSR	*required
professionalName	string	Nome do profissional solicitante	BKU_NOMSOL	*required
stateAbbreviation	string	Estado do conselho regional do profissional solicitante	BKU_UF
professionalCouncil	string	Sigla do conselho regional do profissional solicitante	BKU_SIGLA
professionalCouncilNumber	string	Numero do conselho regional do profissional solicitante	BKU_REGSOL
status	string	Status do protocolo de solicitação de autorização, sendo: 1 = Autorizada 2 = Autorizada Parcialmente 3 = Não Autorizada 6 = Em auditoria 7 = Solicitação em analise 8 = Negado 9 = Aguardando Documento	BKU_STATUS
idOnHealthInsurer	string	Numero da autorização gerada pelo sistema depois de aprovada a solicitação.	BKU_NUMAUT
authType	string	Tipo da solicitação, sendo: 2 = SADT 3 = Internação 4 = Odontológico	BKU_TIPO

Exemplo

{
    "protocol": "41750520230620000003",
    "name": "HERNANDES ALVES DA SILVA",
    "subscriberId": "00011008000027010",
    "professionalName": "VINICIUS",
    "stateAbbreviation": "SP",
    "professionalCouncil": "CRM",
    "professionalCouncilNumber": "1234567",
    "status": "7",
    "idOnHealthInsurer": "",
    "authType": ""
}

(406) - Json do body invalido

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required

Exemplo

{
    "code": "E001",
    "message": "JSON inválido",
    "detailedMessage": "Json Error: >>\"professionalCouncilNumber\" : \"1234567\",\r\n\t\"professionalName\" : \"VINICIUS\",\r\n\t\"attachments\" : [\r\n        {\r\n            \"href\" : \"https://img.olhardigital.com.br/wp-content/uploads/2019/01/20190115163721.jpg\"\r\n        }\r\n\t]\r\n}<<"
}

(406) - Campos inválidos

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Exemplo

{
    "code": "E002",
    "message": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E002D-406",
            "message": "Tipo inválido para o campo professionalCouncilNumber",
            "detailedMessage": "O valor do campo professionalCouncilNumber deve ser do tipo (C)."
        },
        {
            "code": "E002B-406",
            "message": "Campo professionalName obrigatório",
            "detailedMessage": "Não foi informado valor do campo professionalName."
        }
    ]
}

(404) - Beneficiário não encontrado

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required

Exemplo

{
    "code": "E003",
    "message": "Beneficiário não encontrado",
    "detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000027011"
}

(400) - Dados inválidos

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Exemplo

{
    "code": "E004",
    "message": "Erro ao incluir protocolo de autorização",
    "detailedMessage": "Verifique a lista de erros para mais detalhes",
    "details": [
        {
            "code": "E004-1",
            "message": "Erro ao realizar download do arquivo.",
            "detailedMessage": "Status code: 404; Erro: Not Found\r\n; Url: https://img.olhardigital.com.br/wp-content/ploads/2019/01/20190115163721.jpg"
        }
    ]
}

Protocols - Retorna os protocolos de autorização do beneficiário

Retorna os protocolos de solicitação de autorização do beneficiário.

/totvsHealthPlans/attendance/v1/authorizations/{subscriberId}/protocols

GET

Parameters

Authorization (header)	string	Cabeçalho usado para autorização das requisições (Bearer token)	*required
Content-Type (header)	string	'application/json' é o formato do conteúdo	*required
subscriberId (path)	string	Matricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO) (obtido através da API Beneficiaries - v1.000 (Family Contract))	*required
protocol (query)	string	Filtro pelo numero do protocolo (BKU_NRPRO)
protocolOrAuthorization (query)	string	Filtro pelo numero do protocolo (BKU_NRPOP) ou numero da autorização (BKU_NUMAUT)
solicitationDate (query)	string	Filtro pela data de solicitação (BKU_DATSOL)
status (query)	string	Filtro pelo status do protocolo de autorização, sendo: 1 = Autorizada 2 = Autorizada Parcialmente 3 = Não Autorizada 6 = Em auditoria 7 = Solicitação em analise 8 = Negado 9 = Aguardando Documento pode ser enviado mais de um status. Exemplo: 1,2,3
page (query)	string	Valor numérico (maior que zero) representando a página solicitada
pageSize (query)	string	Valor numérico (maior que zero) representando o total de registros retornados na consulta
order (query)	string	Lista de campos para ordenação, separada por virgula (,).
fields (query)	string	Lista com o nome das propriedades JSON que serão retornadas.
filter (query)	string	Filtros seguindo o padrão ODATA

Request

Body

Não possui body!

(200) - Operação realizada com sucesso

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	numeric (integer)	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de protocolos de autorizações
items.protocol	string	Numero do protocolo gerado para a solicitação de autorização	BKU_NRPRO	*required
items.name	string	Nome do beneficiário solicitante	BKU_NOMUSR	*required
items.subscriber_id	string	Matricula do beneficiário solicitante	BKU_MATUSR	*required
items.professional_name	string	Nome do profissional solicitante	BKU_NOMSOL	*required
items.professional_council	string	Sigla do conselho regional do profissional solicitante	BKU_SIGLA
items.professional_council_number	string	Numero do conselho regional do profissional solicitante	BKU_REGSOL
items.status	string	Status do protocolo de solicitação de autorização, sendo: 1 = Autorizada 2 = Autorizada Parcialmente 3 = Não Autorizada 6 = Em auditoria 7 = Solicitação em analise 8 = Negado 9 = Aguardando Documento	BKU_STATUS
items.id_on_health_insurer	string	Numero da autorização gerada pelo sistema depois de aprovada a solicitação	BKU_NUMAUT
items.auth_type	string	Tipo da solicitação, sendo: 2 = SADT 3 = Internação 4 = Odontológico	BKU_TIPO
items.solicitation_date	string	Data da Solicitação	BKU_DATSOL
items.analysis_date	string	Data de Análise da Solicitação	BKU_DATANA

Exemplo

{
    "items": [
        {
            "protocol": "41750520230601000030",
            "name": "HERNANDES ALVES DA SILVA",
            "subscriber_id": "00011008000027010",
            "professional_name": "ANDRE",
            "professional_council": "CRM",
            "professional_council_number": "334455",
            "status": "7",
            "id_on_health_insurer": "",
            "auth_type": "",
			"solicitation_date": "",
			"analysis_date": ""
        }
    ],
    "hasNext": true,
    "remainingRecords": 3
}

(406) - Parâmetros obrigatórios

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Exemplo

{
    "code": "E001",
    "message": "Existem chaves obrigatórias que não foram informadas.",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001-406",
            "message": "Chave subscriberId obrigatória",
            "detailedMessage": "Não foi informado no pathParams da requisição a chave subscriberId."
        }
    ]
}

(404) - Beneficiário não encontrado

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required

Exemplo

{
    "code": "E001",
    "message": "Usuário não encontrado",
    "detailedMessage": "Não foi possível retornar os dados do beneficiário através da matrícula informada."
}

Protocols/interactions - Retorna as interações do protocolo de autorização

Retorna as interações do protocolo de autorização com o beneficiário

/totvsHealthPlans/attendance/v1/authorizations/protocols/{protocolId}/interactions

GET

Parameters

Authorization (header)	string	Cabeçalho usado para autorização das requisições (Bearer token)	*required
Content-Type (header)	string	'application/json' é o formato do conteúdo	*required
protocolId (path)	string	Numero do protocolo de autorização (BKU_NRPRO)	*required
page (query)	string	Valor numérico (maior que zero) representando a página solicitada
pageSize (query)	string	Valor numérico (maior que zero) representando o total de registros retornados na consulta
order (query)	string	Lista de campos para ordenação, separada por virgula (,).
fields (query)	string	Lista com o nome das propriedades JSON que serão retornadas.
filter (query)	string	Filtros seguindo o padrão ODATA

Request

Body

Não possui body!

(200) - Operação realizada com sucesso

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	numeric (integer)	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de interações do protocolo
items.sector	string	Setor do usuário da interação	BBR_SETOR	*required
items.name	string	Nome do beneficiário	BKU_NOMUSR	*required
items.interaction_date	string (date)	Data da interação	BBR_DTITER	*required
items.default_reason	string	Motivo padrão da interação	BBP_DESMOT	*required
items.observation	string	Observação da interação	BBP_OBSERV	*required

Exemplo

{
    "items": [
        {
            "sector": "DEPARTAMENTO PADRAO",
            "name": "HERNANDES ALVES DA SILVA",
            "interaction_date": "2023-06-20",
            "default_reason": "FALTA DE DOCUMENTAÇÃO DO BENEFICIÁRIO",
            "observation": "Encaminhar a documentação do beneficiário"
        }
    ],
    "hasNext": false,
    "remainingRecords": 0
}

(406) - Parâmetros obrigatórios

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Exemplo

{
    "code": "E001",
    "message": "Existem chaves obrigatórias que não foram informadas.",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001-406",
            "message": "Chave protocolId obrigatória",
            "detailedMessage": "Não foi informado no pathParams da requisição a chave protocolId."
        }
    ]
}

(404) - Protocolo não encontrado

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required

Exemplo

{
    "code": "E002",
    "message": "Protocolo não encontrado",
    "detailedMessage": "Não foi possível retornar os dados da interação através do protocolo informado."
}

Protocols/attachments - Inclusão de anexos no protocolo de autorização

Realiza a inclusão de anexos no protocolo de autorização

/totvsHealthPlans/attendance/v1/authorizations/protocols/attachments

POST

Parameters

Authorization (header)	string	Cabeçalho usado para autorização das requisições (Bearer token)	*required
Content-Type (header)	string	'application/json' é o formato do conteúdo	*required

Request

protocol	string	Numero do protocolo de autorização	BKU_NRPRO	*required
attachments	array	Anexos		*required
attachments.href	string	Url do arquivo para que seja realizado o download		*required

Exemplo

{
    "protocol" : "41750520230620000004",
    "attachments" : [
        {
            "href" : "https://img.olhardigital.com.br/wp-content/uploads/2019/01/20190115163721.jpg"
        }
    ]
}

(201) - Operação realizada com sucesso

protocol	string	Numero do protocolo da solicitação de autorização	BKU_NRPRO	*required
name	string	Nome do beneficiário solicitante	BKU_NOMUSR	*required
subscriberId	string	Matricula do beneficiário solicitante	BKU_MATUSR	*required
professionalName	string	Nome do profissional solicitante	BKU_NOMSOL	*required
stateAbbreviation	string	Estado do conselho regional do profissional solicitante	BKU_UF
professionalCouncil	string	Sigla do conselho regional do profissional solicitante	BKU_SIGLA
professionalCouncilNumber	string	Numero do conselho regional do profissional solicitante	BKU_REGSOL
status	string	Status do protocolo de solicitação de autorização, sendo: 1 = Autorizada 2 = Autorizada Parcialmente 3 = Não Autorizada 6 = Em auditoria 7 = Solicitação em analise 8 = Negado 9 = Aguardando Documento	BKU_STATUS	*required
idOnHealthInsurer	string	Numero da autorização gerada pelo sistema depois de aprovada a solicitação.	BKU_NUMAUT
authType	string	Tipo da solicitação, sendo: 2 = SADT 3 = Internação 4 = Odontológico	BKU_TIPO

Exemplo

{
    "protocol": "41750520230620000003",
    "name": "HERNANDES ALVES DA SILVA",
    "subscriberId": "00011008000027010",
    "professionalName": "VINICIUS",
    "stateAbbreviation": "SP",
    "professionalCouncil": "CRM",
    "professionalCouncilNumber": "1234567",
    "status": "7",
    "idOnHealthInsurer": "",
    "authType": ""
}

(406) - Json do body invalido

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required

Exemplo

{
    "code": "E001",
    "message": "JSON inválido",
    "detailedMessage": "Json Error: >>\"attachments\" : [\r\n        {\r\n            \"href\" : \"https://img.olhardigital.com.br/wp-content/uploads/2019/01/20190115163721.jpg\"\r\n        }\r\n    ]\r\n}<<"
}

(406) - Campos inválidos

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Exemplo

{
    "code": "E002",
    "message": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E002D-406",
            "message": "Tipo inválido para o campo protocol",
            "detailedMessage": "O valor do campo protocol deve ser do tipo (C)."
        },
        {
            "code": "E002B-406",
            "message": "Campo attachments obrigatório",
            "detailedMessage": "Não foi informado valor do campo attachments."
        }
    ]
}

(404) - Protocolo não encontrado

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required

Exemplo

{
    "code": "E004",
    "message": "Protocolo nâo encontrado",
    "detailedMessage": "Não foi encontrado nenhum protocolo, informe um protocolo válido"
}

(400) - Status não permitido

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required

Exemplo

{
    "code": "E003",
    "message": "Status inválido",
    "detailedMessage": "O Status do protocolo não permite o envio de anexos"
}

(400) - Dados inválidos

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Exemplo

{
    "code": "E007",
    "message": "Erro ao incluir um anexo",
    "detailedMessage": "Verifique a lista de erros para mais detalhes",
    "details": [
        {
            "code": "E006-1",
            "message": "Erro ao realizar download do arquivo.",
            "detailedMessage": "Status code: 404; Erro: Not Found\r\n; Url: https://img.olhardigital.com.br/wp-content/uploads/2019/01/2019011516321.jpg"
        }
    ]
}

03. TELA AUTHORIZATIONS

Outras Ações / Ações relacionadas

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

04. TELA AUTHORIZATIONS

Principais Campos e Parâmetros

Campo	Descrição
BKU_NRPRO	Numero do protocolo gerado para a solicitação de autorização
BKU_STATUS	Status do protocolo de solicitação de autorização
BKU_NUMAUT	Numero da autorização gerada pelo sistema depois de aprovada a solicitação.

05. TABELAS UTILIZADAS

Beneficiários (BA1)
Upload de Guia Beneficiário (BKU)
Bancos de Conhecimentos (ACB)
Relação de Objetos x Entidades (AC9)
Controle de Interações (BBR)
Motivo Padrão (BBP)

Árvore de páginas

API Authorizations - v1.000 (Attendance)

CONTEÚDO

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

03. TELA AUTHORIZATIONS

04. TELA AUTHORIZATIONS

05. TABELAS UTILIZADAS