Documentation / Référence de l’API

Compter les fiches portant un nom

GET/v1/drugs/overview

Compte les fiches d’un pays qui portent un nom exact, par exemple celui d’une substance active ou d’une marque : leur nombre, leurs types, leurs titulaires, ainsi que leurs statuts administratifs et leurs catégories de prescription. Le nom est comparé en entier, sans tenir compte des accents ni de la casse : une association qui ne fait que le contenir n’est donc pas comptée. Pour lister les fiches elles-mêmes, effectuez une recherche avec match=exact.

Paramètres

country string Obligatoire
Code pays ISO 3166-1 à deux lettres, en minuscules. Chaque recherche porte sur un seul pays.
name string Obligatoire
Le nom exact à compter, de 3 à 120 caractères. Les accents et la casse sont ignorés.
kinds string
Ne compte que ces types de fiches, sous forme de paires sourceId:kind du pays demandé, séparées par des virgules, 12 au maximum.

Renvoie

country string
Le pays de la recherche.
name string
Le nom compté, sous la forme utilisée pour la comparaison.
records integer
Nombre de fiches qui portent ce nom.
truncated boolean
Vrai lorsque plus de 20 000 fiches portent ce nom ; chaque décompte porte alors sur les 20 000 premières.
holders integer
Nombre de titulaires distincts cités par ces fiches, dans le champ holder, labeler ou sponsor publié par leur source.
kinds object[]
Les fiches par source et par type, sous la forme { sourceId, kind, records }, les plus nombreuses en premier.
administrativeStatuses object[]
Les fiches par statut administratif, sous la forme { value, records }, dans les termes mêmes de la source ; unknown lorsqu’elle n’en indique aucun.
prescriptionCategories object[]
Les fiches par catégorie de prescription, sous la forme { value, records }.
topHolders object[]
Les 25 titulaires comptant le plus de fiches, sous la forme { name, records }, orthographiés comme dans la source.

Erreurs

400 401 403 429 503 · Erreurs et limites de requêtes

GET /v1/drugs/overview
curl -G https://api.medifontis.com/v1/drugs/overview \
  -H "Authorization: Bearer $MEDIFONTIS_API_KEY" \
  --data-urlencode "country=ca" \
  --data-urlencode "name=metformin"
Réponse
{
  "country": "ca",
  "name": "metformin",
  "records": 17,
  "truncated": false,
  "holders": 10,
  "kinds": [
    {
      "sourceId": "ca.health-canada.dpd",
      "kind": "products",
      "records": 17
    }
  ],
  "administrativeStatuses": [
    {
      "value": "cancelled",
      "records": 9
    },
    {
      "value": "authorised",
      "records": 8
    }
  ],
  "prescriptionCategories": [
    {
      "value": "prescription-or-restricted",
      "records": 17
    }
  ],
  "topHolders": [
    {
      "name": "APOTEX INC",
      "records": 2
    },
    {
      "name": "COBALT PHARMACEUTICALS COMPANY",
      "records": 2
    },
    {
      "name": "MARCAN PHARMACEUTICALS INC",
      "records": 2
    },
    {
      "name": "MELIAPHARM INC",
      "records": 2
    },
    {
      "name": "MYLAN PHARMACEUTICALS ULC",
      "records": 2
    },
    {
      "name": "SANIS HEALTH INC",
      "records": 2
    },
    {
      "name": "SIVEM PHARMACEUTICALS ULC",
      "records": 2
    },
    {
      "name": "BDH INC.",
      "records": 1
    },
    {
      "name": "LABORATOIRES CONFAB INC",
      "records": 1
    },
    {
      "name": "SORRES PHARMA INC",
      "records": 1
    }
  ]
}