Documentação / Guias

Registros e procedência

Um registro é uma entrada de uma única fonte oficial, tal como descrita pelo publicador, com a procedência de que você precisa para citá-la.

O objeto de registro

country string
Código de duas letras do país da fonte.
sourceId string
A fonte de onde vem o registro, como it.aifa.packages.
id string
A identidade do registro dentro da fonte. Estável entre coletas.
kind string
O tipo de registro dentro da fonte, como packages, ingredients ou veterinary-medicines.
name string
O nome de exibição do registro: o primeiro de seus nomes.
names string[]
Todos os nomes pelos quais o registro pode ser encontrado, extraídos dos seus próprios campos.
identifiers object[]
Identificadores tipados no formato { scheme, value }, como aic, cn, ndc-package ou din. Os valores são sempre strings.
data object
Os campos normalizados da fonte, além de useDomain e targetSpecies com suas evidências.
region string | null
Uma região subnacional quando a fonte é regional; caso contrário, null.
retrievedAt string
Data e hora, em ISO 8601, em que o registro foi coletado da fonte.
sourceUrl string
O conjunto de dados oficial do qual o registro foi coletado.
licence object
A licença da fonte: id, url e o texto de atribuição a exibir.
limitations string[]
O que a fonte não comprova, como a comercialização atual ou a elegibilidade do paciente.

As fontes permanecem independentes

Fontes diferentes podem descrever o mesmo medicamento. O Medifontis nunca mescla registros nem os relaciona pelo nome; relacione-os você mesmo por meio de identificadores, como um código ATC ou um código nacional, quando as fontes os publicarem.

Identificadores

Os identificadores são tipados: o esquema indica o que é o valor, e os valores são sempre strings, então os zeros à esquerda são preservados. Cada fonte publica seus próprios esquemas; o guia de busca lista os deste país.

Procedência

  • sourceUrl aponta para o conjunto de dados oficial do qual o registro foi coletado.
  • retrievedAt é o momento em que o Medifontis o coletou.
  • licence indica os termos do publicador e a atribuição a exibir.
  • limitations lista o que a fonte não comprova, como a disponibilidade atual.

O que um registro não informa

Obter um registro novamente

Para atualizar um registro que você salvou, leia-o pelo país, pelo sourceId e pelo id com GET /v1/drugs/record. Esse endpoint retorna 404 quando a fonte não publica mais o registro.

GET /v1/drugs/record
curl -G https://api.medifontis.com/v1/drugs/record \
  -H "Authorization: Bearer $MEDIFONTIS_API_KEY" \
  --data-urlencode "country=br" \
  --data-urlencode "sourceId=br.anvisa.cmed-prices" \
  --data-urlencode "id=br:cmed:presentations:528525010218907"