Recursos

Endpoints
MÉTODO ENPOINT AÇÃO EXEMPLO
GET /v1/principios-ativos/ Lista todos os princípios ativos /v1/principios-ativos/
GET /v1/principios-ativos/{id}/ Retorna um princípio ativo /v1/principios-ativos/1/
GET /v1/principios-ativos/{id}/interacoes/ Retorna todas as interações do princípio ativo /v1/principios-ativos/1/interacoes/
/v1/principios-ativos/
Parâmetro Tipo Valor Exemplo
search string Opcional. Pesquisa por uma determinada string. Aplica-se aos atributos: [nome] ?search=trim
ordering string Opcional. Orderna resultado em ordem crescente ou descrente. Aplica-se aos atributos: [id, nome] ?ordering=-nome
exclude_id inteiro Opcional. Não mostra nos resultados os princípios ativos com os ids especificados. Aceita mais de um parâmetro separado por vírgula. exclude_id=0,1
exclude_nome string Opcional. Não mostra nos resultados os princípios ativos com os nomes especificados. Aceita mais de um parâmetro separado por vírgula. exclude_nome=cidofovir
page inteiro Opcional. Valor correspondente a uma determinada página. Default: 1. ?page=2
page_size inteiro Opcional. Número máximo de resultados apresentados por página. Default: 100. Mínimo: 1. Máximo: 200. ?page_size=50

/v1/principios-ativos/id/interacoes/
Parâmetro Tipo Valor Exemplo
principios_ativos inteiro Opcional. Filtra as interações de acordo com os princípios ativos especificados. Máximo: 20. ?principios_ativos=765&principios_ativos=648
gravidade string Opcional. Filtra interações pelo atributo gravidade. Opções: ['grave', 'nada+esperado', 'leve', 'moderada', 'gravidade+desconhecida']. ?gravidade=moderada
evidencia string Opcional. Filtra interações pelo atributo evidencia. Opções: ['ajustar', 'monitorar', 'informar', 'nenhuma', 'evitar']. ?evidencia=teórica
acao string Opcional. Filtra interações pelo atributo acao. Opções: ['teórica', 'extensa', 'caso', 'estudo']. ?acao=informar
ordering string Opcional. Orderna resultado em ordem crescente ou descrente. Aplica-se aos atributos: [id] ?ordering=-id
page inteiro Opcional. Valor correspondente a uma determinada página. Default: 1. ?page=1
page_size inteiro Opcional. Número máximo de resultados apresentados por página. Default: 100. Mínimo: 1. Máximo: 200. ?page_size=50
Princípio Ativo
Atributo Tipo Descrição
id inteiro Identificador do objeto.
url string Link do endpoint que fornece detalhes do objeto.
nome string Nome do princípio ativo.
Endpoints
MÉTODO ENPOINT AÇÃO EXEMPLO
GET /v1/medicamentos/ Lista todos os medicamentos /v1/medicamentos/
GET /v1/medicamentos/{id}/ Retorna um medicamento /v1/medicamentos/1/
/v1/medicamentos/
Parâmetro Tipo Valor Exemplo
principios_ativos inteiro Opcional. Retorna os medicamentos que possuem os princípios ativos especificados. É possível passar mais de um princípio ativo. ?principios_ativos=340&principios_ativos=882
search string Opcional. Pesquisa por uma determinada string. Aplica-se aos atributos: [nome] ?search=clo
ordering string Opcional. Orderna resultado em ordem crescente ou descrente. Aplica-se aos atributos: [id, nome] ?ordering=-nome
exclude_id inteiro Opcional. Não mostra nos resultados os medicamentos com os ids especificados. Aceita mais de um parâmetro separado por vírgula. exclude_id=0,1
exclude_nome string Opcional. Não mostra nos resultados os medicamentos com os nomes especificados. Aceita mais de um parâmetro separado por vírgula. exclude_nome=abc
page inteiro Opcional. Valor correspondente a uma determinada página. Default: 1. ?page=2
page_size inteiro Opcional. Número máximo de resultados apresentados por página. Default: 100. Mínimo: 1. Máximo: 200. ?page_size=50
Medicamento
Atributo Tipo Descrição
id inteiro Identificador do objeto.
url string Link do endpoint que fornece detalhes do objeto.
nome string Nome comercial do medicamento.
principios_ativos_anvisa array Nome dos princípios ativos que compõe o medicamento de acordo com a Anvisa. Esse campo difere de principios_ativos pois pode ocorrer algumas variações no nome. Ex. nome na Anvisa -> Cloridrato de Ofenadrina e nome do princípio ativo -> Ofenadrina.
principios_ativos array Princípios ativos que compõem o medicamento.
Endpoints
MÉTODO ENPOINT AÇÃO EXEMPLO
GET /v1/apresentacao-medicamentos/ Lista todas as apresentações de medicamentos /v1/apresentacao-medicamentos/
GET /v1/apresentacao-medicamentos/{id}/ Retorna uma apresentação de medicamento /v1/apresentacao-medicamentos/1/
/v1/apresentacao-medicamentos/
Parâmetro Tipo Valor Exemplo
medicamento inteiro Opcional. Retorna as apresentações de medicamentos que possuem os medicamentos especificados. É possível passar mais de um medicamento. ?medicamento=3&medicamento=32
search string Opcional. Pesquisa por uma determinada string. Aplica-se aos atributos: [nome] ?search=abel
ordering string Opcional. Orderna resultado em ordem crescente ou descrente. Aplica-se aos atributos: [id, nome] ?ordering=-nome
exclude_id inteiro Opcional. Não mostra nos resultados as apresentações de medicamentos com os ids especificados. Aceita mais de um parâmetro separado por vírgula. exclude_id=0,1
exclude_nome string Opcional. Não mostra nos resultados as apresentações de medicamentos com os nomes especificados. Aceita mais de um parâmetro separado por vírgula. exclude_nome=abelcet 5mg/ml
page inteiro Opcional. Valor correspondente a uma determinada página. Default: 1. ?page=2
page_size inteiro Opcional. Número máximo de resultados apresentados por página. Default: 100. Mínimo: 1. Máximo: 200. ?page_size=50
Apresentação do Medicamento
Atributo Tipo Descrição
id inteiro Identificador do objeto.
url string Link do endpoint que fornece detalhes do objeto.
nome string Nome de apresentação do medicamento. É formado pelo nome do medicamento combinado com sua concentração.
medicamento objeto Medicamento referente à apresentação.
detentor string Empresa responsável pelo medicamento.
concentracao string Concentração em que o medicamento é comercializado.
forma_farmaceutica string Estado em que as substâncias são comercializadas. Exemplo: comprimido, solução oral etc.
Endpoints
MÉTODO ENPOINT AÇÃO EXEMPLO
GET /v1/interacoes/ Lista as interações entre os princípios especificados. Requer no mínimo dois princípios ativos. /v1/interacoes/?principios_ativos=17&principios_ativos=443&principios_ativos=681
GET /v1/interacoes/{id}/ Retorna uma interação /v1/interacoes/1/
GET /v1/interacoes/metadados/ Retorna informações sobre os campos de uma interação /v1/interacoes/metadados/
/v1/interacoes/
Parâmetro Tipo Valor Exemplo
principios_ativos inteiro/string Parcialmente obrigatório. Retorna as interações entre os princípios ativos especificados. Este parâmetro aceita o id ou o nome do princípio ativo. Minímo: 2. Máximo: 20. ?principios_ativos=10&principios_ativos=12&principios_ativos=22
ean string Parcialmente obrigatório. Retorna as interações entre os princípios ativos dos medicamentos que possuem os códigos EAN especificados. Minímo: 2. Máximo: 20.
É possível também utilizar este parâmetro em conjunto com o parâmetro principios_ativos. 		?ean=7893736013764&ean=7896112194347
gravidade string Opcional. Filtra interações pelo atributo gravidade. Opções: ['grave', 'nada+esperado', 'leve', 'moderada', 'gravidade+desconhecida']. ?gravidade=moderada
evidencia string Opcional. Filtra interações pelo atributo evidencia. Opções: ['teórica', 'extensa', 'caso', 'estudo']. ?evidencia=teórica
acao string Opcional. Filtra interações pelo atributo acao. Opções: ['ajustar', 'monitorar', 'informar', 'nenhuma', 'evitar']. ?acao=informar
ordering string Opcional. Orderna resultado em ordem crescente ou descrente. Aplica-se aos atributos: [id] ?ordering=-id
page inteiro Opcional. Valor correspondente a uma determinada página. Default: 1. ?page=1
page_size inteiro Opcional. Número máximo de resultados apresentados por página. Default: 100. Mínimo: 1. Máximo: 200. ?page_size=2
Interação
Atributo Tipo Descrição
id inteiro Identificador do objeto.
url string Link do endpoint que fornece detalhes do objeto.
gravidade string Severidade da interação. Possíveis valores: ['Grave', 'Nada esperado', 'Leve', 'Moderada', 'Gravidade desconhecida'].
evidencia string Forma de constatação da interação. Possíveis valores: ['Teórica', 'Extensa', 'Caso', 'Estudo'].
acao string Sugestão de ação a ser tomada. Possíveis valores: ['Ajustar', 'Monitorar', 'Informar', 'Nenhuma', 'Evitar'].
explicacao string Efeitos da interação.
principios_ativos array Princípios ativos que causam a interação.