CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
    1. Classes - Retorna as classes de procedimentos
    2. Procedures - Retorna os procedimento da classe
  3. Tela api classes
    1. Outras Ações / Ações relacionadas
  4. Tela api classes
    1. Principais Campos e Parâmetros
  5. 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


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.

Para nome composto, as APIs utilizam o padrão camelCase 


02. EXEMPLO DE UTILIZAÇÃO

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

/totvsHealthPlans/procedure/v1/classes

GET

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)stringCódigo da operadora (BJE_CODINT)*required
classCode (query)stringFiltro 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

Body

Não possui body!

hasNextbooleanIndica se ainda existem registros a serem retornados
*required
remainingRecordsnumeric (integer)Quantidade de registros ainda existem para retorno
*required
itemsarrayLista de classes de procedimentos

items.classCodestringCódigo da classe no sistemaBJE_CODIGO*required
items.descriptionstringDescrição da classe de procedimentosBJE_DESCRI*required
items.isMedicationstring

Indica se a classe é de medicamentos, sendo:

  • 0 = Não
  • 1 = Sim
BJE_ISMEDI
items.classTypestring

Tipo da classe, sendo:

  • 0 = Não aplicável
  • 1 = Medicamento
  • 2 = Seriado
BJE_TIPO
items.standardTableCodestringCódigo da tabela do procedimento padrão da classeBJE_CODPAD
items.standardProcedureCodestringCódigo do procedimento padrão da classeBJE_CODPRO
items.procedureDescriptionstringDescrição do procedimento padrãoBR8_DESCRI
items.linksarray

Links relacionados ao recurso classes (Padrão HATEOAS):

  • rel: procedures

*required
{
    "items": [
        {
            "classCode": "000001",
            "description": "CONSULTAS",
            "isMedication": "",
            "classType": "",
            "standardTableCode": "",
            "standardProcedureCode": "",
            "procedureDescription": "",
            "links": [
                {
                    "rel": "procedures",
                    "href": "/totvsHealthPlans/procedure/v1/classes/000001/procedures"
                }
            ]
        }
        {
            "classCode": "000002",
            "description": "EXAMES E TERAPIAS",
            "isMedication": "",
            "classType": "",
            "standardTableCode": "",
            "standardProcedureCode": "",
            "procedureDescription": "",
            "links": [
                {
                    "rel": "procedures",
                    "href": "/totvsHealthPlans/procedure/v1/classes/000002/procedures"
                }
            ]
        }
    ],
    "hasNext": true,
    "remainingRecords": 6
}
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
{
    "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."
        }
    ]
}

Retorna os procedimentos da tabela padrão vinculados a classe

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

GET

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)stringCó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)stringFiltro de procedimentos pelo código (BR8_CODPSA)
procedureDescription (query)stringFiltro 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)stringCó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

Body

Não possui body!

hasNextbooleanIndica se ainda existem registros a serem retornados
*required
remainingRecordsnumeric (integer)Quantidade de registros ainda existem para retorno
*required
itemsarrayLista de procedimentos da classe

items.tableCodestringCódigo da tabela do procedimentoBR8_CODPAD*required
items.procedureCodestringCódigo do procedimentoBR8_CODPSA*required
items.procedureDescriptionstringDescrição do procedimentoBR8_DESCRI*required
items.activestring

Indica se o procedimento está ativo, sendo:

  • 0 = Não
  • 1 = Sim
BR8_BENUTL*required
{
    "items": [
        {
            "tableCode": "04",
            "procedureCode": "0490173961",
            "procedureDescription": "DRAMIN 100 MG COM CT BL AL PLAS INC X 20",
            "active": "1"
        }
    ],
    "hasNext": false,
    "remainingRecords": 0
}
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
{
    "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çãoDescrição
Não se aplicaNão se aplica

04. TELA API CLASSES

Principais Campos e Parâmetros

CampoDescrição
BJE_CODIGOCódigo da classe no sistema

05. TABELAS UTILIZADAS