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

*required*required*requiredBB0_DATBLO

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 profissionaisprocedimentos

items.id-on-health-insurerclass-code

string

Código do profissional da classe no sistema

BB0_CODIGO

items.namedescription

string

Nome do profissional

BB0_NOME

Descrição da classe de procedimentos

items.professionalis-councilmedication

string

Sigla Conselho Regional

BB0_CODSIG

Indica se a classe é de medicamentos, sendo:

0 = Não
1 = Sim

items.professionalclass-council-numbertype

string

Numero Conselho Regional

BB0_NUMCR

*required

items.state-abbreviation

string

Estado Conselho Regional

BB0_ESTADO

*required

Tipo da classe, sendo:

0 = Não aplicável
1 = Medicamento
2 = Seriado

items.standard-table-code

items.professional-identifier

string

CPF/CNPJ do profissional

BB0_CGC

items.health-insurer-code-origem

string

Código da operadora origem do profissional

BB0_CODORI

items.is-part-attendance-network

string

Identifica se o profissional faz parte da rede de atendimento, sendo:

1 = Faz parte da Rede de Atendimento
2 = Não faz parte da Rede de Atendimento

BB0_VINC

*required

tabela do procedimento padrão da classe

items.standard-procedure-code

string

Código do procedimento padrão da classe

items.procedure-description

string

Descrição do procedimento padrão

items.links

array

items.blocking-reason

string

Código do bloqueio do profissional

BB0_CODBLO

items.blocking-date

string (date)

Data do bloqueio do profissional

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "id-on-health-insurerclass-code": "000052000001",
            "namedescription": "RDA CRUZEIROCONSULTAS",
            "professionalis-councilmedication": "CRM",
            "professionalclass-council-numbertype": "2165465454",
            "state-abbreviation": "SP",
            "professional-identifierstandard-table-code": "34622099000185",
            "healthstandard-insurerprocedure-code-origem": "",
            "is-part-attendance-networkprocedure-description": "1",
            "blocking-reasonlinks": "",[
            "blocking-date": ""
        },{
        {
            "id-on-health-insurerrel": "000055procedures",
            "name": "W RDA XML EXECUTANTE",
            "professional-councilhref": "CRM",/totvsHealthPlans/procedure/v1/classes/000001/procedures"
            "professional-council-number": "1111",
   }
         "state-abbreviation": "SP",
  ]
          "professional-identifier": "31233647040",}
            "health-insurer-code-origem": "",{
            "is-part-attendance-networkclass-code": "1000002",
            "blocking-reasondescription": "EXAMES E TERAPIAS",
            "blockingis-datemedication": ""
        },
        {
            "id-on-health-insurer"class-type": "000058",
            "namestandard-table-code": "W WANDERLEY RODRIGUES MOREIRA",
            "professionalstandard-procedure-councilcode": "CRM",
            "professionalprocedure-council-numberdescription": "17611",
            "state-abbreviationlinks": "SP",[
            "professional-identifier": "33325820620",
    {
        "health-insurer-code-origem": "",
            "is-part-attendance-networkrel": "1procedures",
            "blocking-reason": "",
            "blocking-datehref": "/totvsHealthPlans/procedure/v1/classes/000002/procedures"
        },
        {}
            "id-on-health-insurer": "000059",]
            "name": "PROFISSIONAL TESTE",},
		{
            "professionalclass-councilcode": "CRM000005",
            "professional-council-numberdescription": "697041MEDICAMENTOS",
            "stateis-abbreviationmedication": "SP1",
            "professionalclass-identifiertype": "288457443371",
            "healthstandard-insurertable-code-origem": "04",
            "isstandard-partprocedure-attendance-networkcode": "20490173961",
            "blockingprocedure-reasondescription": "",
DRAMIN 100 MG COM CT BL AL PLAS INC    "blocking-date": ""
        },
        {X 20",
            "id-on-health-insurerlinks": "000062",[
            "name": "PLS DSAUPC RDA NIVEL B29",{
            "professional-council": "CRM",
            "professional-council-number"rel": "123456procedures",
            "state-abbreviation": "SP",
            "professional-identifierhref": "47782412587",/totvsHealthPlans/procedure/v1/classes/000005/procedures"
            "health-insurer-code-origem": "",
            "is-part-attendance-network": "1",}
            "blocking-reason": "",
  ]
          "blocking-date": ""
        }
    ],
    "hasNext": true,
    "remainingRecords": 296
}

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

...

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave