API Medications - v1.000 (Procedure)

CONTEÚDO

Visão Geral
Exemplo de utilização
1. Medications - Retorna os medicamentos
Tela api medications
1. Outras Ações / Ações relacionadas
Tela api medications
1. Principais Campos e Parâmetros
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

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

Medications - Retorna os medicamentos

Retorna os procedimentos correspondente a classe de medicamentos.

/totvsHealthPlans/procedure/v1/medications

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

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 medicamentos
items.table_code	string	Código tabela do medicamento	BR8_CODPAD	*required
items.medication_code	string	Código do medicamento	BR8_CODPSA	*required
items.medication_description	string	Descrição do medicamento	BR8_DESCRI	*required
items.active	string	Indica de o medicamento está ativo, sendo: 0 = Não 1 = Sim	BR8_BENUTL	*required

Exemplo

{
    "items": [
        {
            "table_code": "04",
            "medication_code": "0490173961",
            "medication_description": "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ção	Descrição
Não se aplica	Não se aplica

04. TELA MEDICATIONS

Principais Campos e Parâmetros

Campo	Descrição
BR8_CODPAD	Código tabela do medicamento
BR8_CODPSA	Código do medicamento

05. TABELAS UTILIZADAS

Tabela Padrão (BR8)
Classes de Procedimentos (BJE)

Árvore de páginas