API Classes - v1.000 - (Procedure)

CONTEÚDO

Visão Geral
Exemplo de utilização
1. Classes - Retorna as classes de procedimentos
2. Procedures - Retorna os procedimento da classe
Tela api classes
1. Outras Ações / Ações relacionadas
Tela api classes
1. Principais Campos e Parâmetros
Tabelas utilizadas

01. VISÃO GERAL

API para a entidade professionals (Profissionais de saúde) 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

Classes - Retorna as classes de procedimentos

Retorna as classes de procedimentos cadastradas pela operadora de saúde

/totvsHealthPlans/procedure/v1/classes

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
healthInsurerCode (query)	string	Código da operadora (BJE_CODINT)	*required
classCode (query)	string	Filtro de classes do pelo código no sistema (BJE_CODIGO)
isMedication (query)	string	Filtro de classes pelo tipo medicamento (BJE_ISMED), sendo: 0 = Não 1 = Sim
classType (query)	string	Filtro de classes pelo tipo (BJE_TIPO), sendo: 0 = Não aplicável 1 = Medicamento 2 = Seriado
hasProcedures (query)	string	Filtro de classes somente quando houver procedimento vinculado, sendo: 1 = Sim
isBeneficiaryPortal (query)	string	Filtro de medicamentos para somente o portal do beneficiário (BR8_EXPBEN), sendo: 0 - Medicamentos para não mostrar no portal do beneficiário 1 - Medicamentos para mostrar no portal do beneficiário Param utilizando somente quando hasProcedures for igual a 1
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 classes de procedimentos
items.class_code	string	Código da classe no sistema	BJE_CODIGO	*required
items.description	string	Descrição da classe de procedimentos	BJE_DESCRI	*required
items.is_medication	string	Indica se a classe é de medicamentos, sendo: 0 = Não 1 = Sim	BJE_ISMEDI
items.class_type	string	Tipo da classe, sendo: 0 = Não aplicável 1 = Medicamento 2 = Seriado	BJE_TIPO
items.standard_table_code	string	Código da tabela do procedimento padrão da classe	BJE_CODPAD
items.standard_procedure_code	string	Código do procedimento padrão da classe	BJE_CODPRO
items.procedure_description	string	Descrição do procedimento padrão	BR8_DESCRI
items.links	array	Links relacionados ao recurso classes (Padrão HATEOAS): rel: procedures		*required

Exemplo

{
    "items": [
        {
            "class_code": "000001",
            "description": "CONSULTAS",
            "is_medication": "",
            "class_type": "",
            "standard_table_code": "",
            "standard_procedure_code": "",
            "procedure_description": "",
            "links": [
                {
                    "rel": "procedures",
                    "href": "/totvsHealthPlans/procedure/v1/classes/000001/procedures"
                }
            ]
        }
        {
            "class_code": "000002",
            "description": "EXAMES E TERAPIAS",
            "is_medication": "",
            "class_type": "",
            "standard_table_code": "",
            "standard_procedure_code": "",
            "procedure_description": "",
            "links": [
                {
                    "rel": "procedures",
                    "href": "/totvsHealthPlans/procedure/v1/classes/000002/procedures"
                }
            ]
        }
    ],
    "hasNext": true,
    "remainingRecords": 6
}

(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 healthInsurerCode obrigatória",
            "detailedMessage": "Não foi informado no queryParams da requisição a chave healthInsurerCode."
        }
    ]
}

Procedures - Retorna os procedimento da classe

Retorna os procedimentos da tabela padrão vinculados a classe

/totvsHealthPlans/procedure/v1/classes/{classId}/procedures

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
classId (path)	string	Código da classe de procedimentos (BR8_CLASSE)	*required
isBeneficiaryPortal (query)	string	Filtro de medicamentos para somente o portal do beneficiário (BR8_EXPBEN), sendo: 0 - Medicamentos para não mostrar no portal do beneficiário 1 - Medicamentos para mostrar no portal do beneficiário
procedureCode (query)	string	Filtro de procedimentos pelo código (BR8_CODPSA)
procedureDescription (query)	string	Filtro de procedimentos pela descrição (BR8_DESCRI)
checkRefundTable (query)	string	Define se irá filtrar pelas tabelas de reembolso cadastradas da operadora (BA0_TBRFRE e tabela B7T), sendo: 0 = Não 1 = Sim
healthInsurerCode (query)	string	Código da operadora no sistema (B7T_CODINT), utilizado junto com o query param checkRefundTable
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 procedimentos da classe
items.table_code	string	Código da tabela do procedimento	BR8_CODPAD	*required
items.procedure_code	string	Código do procedimento	BR8_CODPSA	*required
items.procedure_description	string	Descrição do procedimento	BR8_DESCRI	*required
items.active	string	Indica se o procedimento está ativo, sendo: 0 = Não 1 = Sim	BR8_BENUTL	*required

Exemplo

{
    "items": [
        {
            "table_code": "04",
            "procedure_code": "0490173961",
            "procedure_description": "DRAMIN 100 MG COM CT BL AL PLAS INC X 20",
            "active": "1"
        }
    ],
    "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 classId obrigatória",
            "detailedMessage": "Não foi informado no pathParams da requisição a chave classId."
        }
    ]
}

03. TELA API CLASSES

Outras Ações / Ações relacionadas

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

04. TELA API CLASSES

Principais Campos e Parâmetros

Campo	Descrição
BJE_CODIGO	Código da classe no sistema

05. TABELAS UTILIZADAS

Classes de Procedimentos (BJE)
Tabela Padrão (BR8)
Operadora de Saúde (BA0)
Tabelas de Honorários (BF8)
Operadora x Tde Reembolso (B7T)

Árvore de páginas

API Classes - v1.000 - (Procedure)

CONTEÚDO

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

03. TELA API CLASSES

04. TELA API CLASSES

05. TABELAS UTILIZADAS