CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
    1. Medications - Retorna os medicamentos
  3. Tela api medications 
    1. Outras Ações / Ações relacionadas
  4. Tela api medications
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas


01. VISÃO GERAL

API para a entidade medications (Medicamentos) 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 os procedimentos correspondente a classe de medicamentos.

/totvsHealthPlans/procedure/v1/medications

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)stringFiltro de medicamentos pelo código da operadora (BJE_CODINT)
tableCode (query)stringFiltro de medicamentos pelo código da tabela (BR8_CODPAD)
medicationCode (query)stringFiltro de medicamentos pelo código do medicamento (BR8_CODPSA)
medicationDescription (query)string

Filtro de medicamentos pela descrição (BR8_DESCRI)


active (query)string

Filtro de medicamentos pelo status de ativo (BR8_BENUTL), sendo: 

  • 0 = Inativo
  • 1 = Ativo

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

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 medicamentos

items.tableCodestringCódigo tabela do medicamentoBR8_CODPAD*required
items.medicationCodestringCódigo do medicamentoBR8_CODPSA*required
items.medicationDescriptionstringDescrição do medicamentoBR8_DESCRI*required
items.activestring

Indica de o medicamento está ativo, sendo:

  • 0 = Não
  • 1 = Sim
BR8_BENUTL*required
{
    "items": [
        {
            "tableCode": "04",
            "medicationCode": "0490173961",
            "medicationDescription": "DRAMIN 100 MG COM CT BL AL PLAS INC X 20",
            "active": "1"
        }
    ],
    "hasNext": false,
    "remainingRecords": 0
}

03. TELA MEDICATIONS

Outras Ações / Ações relacionadas

AçãoDescrição
Não se aplicaNão se aplica

04. TELA MEDICATIONS

Principais Campos e Parâmetros

CampoDescrição
BR8_CODPADCódigo tabela do medicamento
BR8_CODPSACódigo do medicamento

05. TABELAS UTILIZADAS