Histórico da Página

...

Painel

titleColor	Orange
borderStyle	solid
title	Classes - Retorna as classes de procedimentos

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

/totvsHealthPlans/procedure/v1/classes

GET

Nota

Expandir

title	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
health-insurer-code (query)	string	Código da operadora (BJE_CODINT)	*required
class-code (query)	string	Filtro de classes do pelo código no sistema (BJE_CODIGO)
is-medication (query)	string	Filtro de classes pelo tipo medicamento (BJE_ISMED), sendo: 0 = Não 1 = Sim
class-type (query)	string	Filtro de classes pelo tipo (BJE_TIPO), sendo: 0 = Não aplicável 1 = Medicamento 2 = Seriado
has-procedures (query)	string	Filtro de classes somente quando houver procedimento vinculado, sendo: 1 = Sim
is-beneficiary-portal (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 has-procedures 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

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

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

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "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"
                }
            ]
        },
		{
            "class-code": "000005",
            "description": "MEDICAMENTOS",
            "is-medication": "1",
            "class-type": "1",
            "standard-table-code": "04",
            "standard-procedure-code": "0490173961",
            "procedure-description": "DRAMIN 100 MG COM CT BL AL PLAS INC X 20",
            "links": [
                {
                    "rel": "procedures",
                    "href": "/totvsHealthPlans/procedure/v1/classes/000005/procedures"
                }
            ]
        }
    ],
    "hasNext": true,
    "remainingRecords": 6
}

Aviso

Expandir

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

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

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

Âncora

	procedures
	procedures

Painel

titleColor	Orange
borderStyle	solid
title	Procedures - Retorna os procedimento da classe

Retorna os procedimentos da tabela padrão vinculados a classe

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

GET

Nota

Expandir

title	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
is-beneficiary-portal (query)	string
procedure-code (query)	string
procedure-description (query)	string
check-refund-table (query)	string
health-insurer-code (query)	string
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

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

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

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "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"
                }
            ]
        },
		{
            "class-code": "000005",
            "description": "MEDICAMENTOS",
            "is-medication": "1",
            "class-type": "1",
            "standard-table-code": "04",
            "standard-procedure-code": "0490173961",
            "procedure-description": "DRAMIN 100 MG COM CT BL AL PLAS INC X 20",
            "links": [
                {
                    "rel": "procedures",
                    "href": "/totvsHealthPlans/procedure/v1/classes/000005/procedures"
                }
            ]
        }
    ],
    "hasNext": true,
    "remainingRecords": 6
}

Aviso

Expandir

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

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

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

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)

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão 3

Chave

03. TELA API CLASSES

04. TELA

API CLASSES

05. TABELAS UTILIZADAS