Guide API - Base de donnée de produits de santé naturels homologués (BDPSNH)
Table des matières
Introduction
La Base de données des produits de santé naturels homologués (BDPSNH) contient des renseignements sur les produits de santé naturels (PSN) ayant reçu une licence de mise en marché de Santé Canada.
Cette interface de programmation d'applications (API) permet aux concepteurs d'accéder à ces renseignements en format JSON et XML afin de les utiliser dans leurs propres applications. L'adresse URI de base sur la Base de donnée de produits de santé naturels homologués (BDPSNH) est https://produits-sante.canada.ca/api/homologations-naturel/ et vous pouvez y ajouter des paramètres. Toute requête est effectuée par l'entremise de cette adresse URI.
Ingredient médicinal
Contribue à l'activité thérapeutique associée à l'utilisation ou au but recommandé.
Paramètres
Il y a trois paramètres dans la requête : id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/homologations-naturel/medicinalingredient/?id= | Affiche les ingrédients médicinaux selon l'identificateur unique de produit spécifiée dans la requête. |
|
Non | Si le code n’est pas fourni, une réponse paginée de tous les ingrédients médicinaux sera retournée commençant à la page 1. |
api/natural-licences/medicinalingredient/?page= | Retourne un résultat donné des résultats paginés. |
|
Non | Les paramètres peuvent être utilisés que si la recherche par code n’est pas faite. |
api/homologations-naturel/medicinalingredient/?lang=fr | Modifie la langue du résultat. |
|
Non, mais l'anglais est la langue par défaut si elle n'est pas spécifiée. | Détermine si le résultat est affiché en anglais ou en français. |
api/homologations-naturel/medicinalingredient/?type=json | Modifie le format du résultat. |
|
Non, mais JSON est le format par défaut s'il n'est pas spécifié. | Détermine si le résultat est en format JSON ou XML. |
La liste des ingrédients médicinaux peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet ingrédient médicinal contient les valeurs suivantes :
Code | Valeur |
---|---|
lnhpd_id | Identificateur unique de produit. |
ingredient_name | Le nom de l'ingrédient médicinal. |
potency_amount | La quantité par unité de dose posologique du composant standardisé qui caractérise la quantité de l'ingrédient. |
potency_unit of_measure | Unité de mesure décrivant la puissance. |
potency_constituent | Composant actif de l'ingrédient médicinal. |
quantity | Quantité d'ingrédient médicinal / unité de dose posologique. |
quantity_minimum | Quantité minimum le cas échéant. |
quantity_maximum | Quantité maximale le cas échéant. |
quantity_unit_of_measure | Unité de mesure décrivant la quantité. |
ratio_numerator | Numérateur de rapport d'extrait. |
ratio_denominator | Dénominateur de rapport d'extrait. |
dried_herb_equivalent | La quantité d'ingrédient brut utilisée dans un extrait, exprimée par unité de dosage. |
dhe_unit of_measure | Unité de mesure décrivant la quantité. |
extract_type_desc | Type d'extrait. |
source_material | La substance à partir de laquelle l'ingrédient médicinal a été dérivé. Il peut y avoir plusieurs sources pour un seul ingrédient médicinal. |
Exemple de résultat
-
https://produits-sante.canada.ca/api/homologations-naturel/medicinalingredient?lang=fr&type=json
{ "metadata": { "pagination": { "limit": 100, "page": 1, "total": 467758, "next": "medicinalingredient/?page=2&lang=fr&type=json", "previous": null }, "dateReceived": "2018-11-30" }, "data": [ { "lnhpd_id": 3894657, "ingredient_name": "Valériane officinale", "ingredient_Text": null, "potency_amount": 0.0, "potency_constituent": "", "potency_unit_of_measure": "", "quantity": 80.0, "quantity_minimum": 0, "quantity_maximum": 0, "quantity_unit_of_measure": "mg", "ratio_numerator": "5", "ratio_denominator": "1", "dried_herb_equivalent": "400", "dhe_unit_of_measure": "mg", "extract_type_desc": "", "source_material": "Racine" }, ... ] }
-
https://produits-sante.canada.ca/api/homologations-naturel/medicinalingredient?lang=fr&type=json&id=3894657
{ "metadata": { "pagination": null, "dateReceived": "2018-11-28" }, "data": [ { "lnhpd_id": 3894657, "ingredient_name": "Valériane officinale", "ingredient_Text": null, "potency_amount": 0, "potency_constituent": "", "potency_unit_of_measure": "", "quantity": 80, "quantity_minimum": 0, "quantity_maximum": 0, "quantity_unit_of_measure": "mg", "ratio_numerator": "5", "ratio_denominator": "1", "dried_herb_equivalent": "400", "dhe_unit_of_measure": "mg", "extract_type_desc": "", "source_material": "Racine" } ] }
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche les ingrédients médicinaux selon l'identificateur unique de produit et la langue sélectionnée :function getIngredient(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/homologations-naturel/medicinalingredient/?lang=' + lang + '&id=' + id; $.ajax({ url: uri, type: 'GET', Accept: "application/json", dataType: 'json', success: function(data) { console.log(data.ingredient_name); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var IngredientName = document.createTextNode(data.ingredient_name); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(IngredientName); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error: function(error) {}, }); return; };
Ingrédient non médicinal
Toute substance ajoutée à un PSN pour conférer une consistance ou une forme appropriée aux ingrédients médicinaux.
Paramètres
Il y a trois paramètres dans la requête : id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/homologations-naturel/nonmedicinalingredient/?id= | Affiche les ingrédients non médicinaux selon l'identificateur unique de produit spécifié dans la requête. |
|
Oui | |
api/homologations-naturel/nonmedicinalingredient/?lang=fr | Modifie la langue du résultat. |
|
Non, mais l'anglais est la langue par défaut si elle n'est pas spécifiée. | Détermine si le résultat est affiché en anglais ou en français. |
api/homologations-naturel/nonmedicinalingredient/?type=json | Modifie le format du résultat. |
|
Non, mais JSON est le format par défaut s'il n'est pas spécifié. | Détermine si le résultat est en format JSON ou XML. |
La liste des ingrédients non médicinaux peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet ingrédient non médicinal contient les valeurs suivantes :
Code | Valeur |
---|---|
lnhpd_id | Identificateur unique de produit. |
ingredient_name | Le nom de l'ingrédient non médicinal. |
Exemple de résultat
[{"lnhpd_id":3894852,"ingredient_name":"Rocou"}, {"lnhpd_id":3894852,"ingredient_name":"Artificial Orange Flavor"}, {"lnhpd_id":3894852,"ingredient_name":"cellulose"}, {"lnhpd_id":3894852,"ingredient_name":"Dextrose"}, {"lnhpd_id":3894852,"ingredient_name":"Fructose"}, {"lnhpd_id":3894852,"ingredient_name":"Stéarate de magnésium"}, {"lnhpd_id":3894852,"ingredient_name":"Acide stéarique"}]
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche les ingrédients non médicinaux selon l'identificateur unique de produit et la langue sélectionnée :
function getNonIngredient(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/homologations-naturel/nonmedicinalingredient/?lang=' + lang + '&id=' + id; $.ajax({ url: uri, type: 'GET', Accept: "application/json", dataType: 'json', success: function(data) { console.log(data.ingredient_name); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var NonIngredientName = document.createTextNode(data.ingredient_name); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(NonIngredientName); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error: function(error) {}, }); return; };
Dose recommandée
La quantité de produit fini sous forme posologique utilisée aux fins recommandées, y compris les instructions d'utilisation. La dose est représentée par la quantité d'unités posologiques, la fréquence d'utilisation et les directives d'utilisation, le cas échéant, par un sous-groupe de population.
Paramètres
Il y a trois paramètres dans la requête : id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/homologations-naturel/productdose/?id= | Affiche la dose recommandée selon l'identificateur unique de produit spécifié dans la requête. |
|
Oui | |
api/homologations-naturel/productdose/?lang=fr | Modifie la langue du résultat. |
|
Non, mais l'anglais est la langue par défaut si elle n'est pas spécifiée. | Détermine si le résultat est affiché en anglais ou en français. |
api/homologations-naturel/productdose/?type=json | Modifie le format du résultat. |
|
Non, mais JSON est le format par défaut s'il n'est pas spécifié. | Détermine si le résultat est en format JSON ou XML. |
La liste des doses recommandées peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet dose recommandée contient les valeurs suivantes :
Code | Valeur |
---|---|
lnhpd_id | Identificateur unique de produit. |
dose_id | Identificateur unique de la dose. |
population_type_desc | Sous-population, le groupe ciblé par le PSN (un ou plusieurs) qui peut nécessiter une posologie différente de la norme. |
age | Âge recommandé. |
age_minimum | Âge minimum le cas échéant. |
age_maximum | Âge maximum le cas échéant. |
uom_type_desc_age | Unité de mesure pour l'âge. |
quantity_dose | Quantité de l'ingrédient médicinal / unité de dose posologique. |
quantity_dose_minimum | Quantité minimale d'ingrédient médicinal/unité posologique le cas échéant. |
quantity_dose_maximum | Quantité maximale d'ingrédient médicinal/unité posologique le cas échéant. |
uom_type_desc_quantity_dose | Unité de mesure décrivant le dosage. |
frequency | Fréquence à laquelle le produit doit être pris dans un intervalle de temps ou un temps donné. |
frequency_minimum | Fréquence minimale le cas échéant. |
frequency_maximum | Fréquence maximale le cas échéant. |
uom_type_desc_frequency | Unité de mesure décrivant la fréquence. |
Exemple de résultat
{"lnhpd_id":3909594,"dose_id":36781,"population_type_desc":"Adultes","age":0,"age_minimum":0.0,"age_maximum":0.0,"uom_type_desc_age":"", "quantity_dose":2.0,"quantity_dose_minimum":0.0,"quantity_dose_maximum":0.0,"uom_type_desc_quantity_dose":"Capsule", "frequency":2.0,"frequency_minimum":0.0,"frequency_maximum":0.0,"uom_type_desc_frequency":"Tous les jours"}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche une dose selon l'identificateur unique de produit et la langue sélectionnée :
function getProductDose(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/homologations-naturel/productdose/?lang=' + lang + '&id=' + id; $.ajax({ url: uri, type: 'GET', Accept: "application/json", dataType: 'json', success: function(data) { console.log(data.quantity_dose); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var ProductDose = document.createTextNode(data.quantity_dose); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(ProductDose); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error: function(error) {}, }); return; };
Homologation du produit
Un code numérique de huit (8) chiffres assigné à chaque produit de santé naturel approuvé pour être commercialisé en vertu du Règlement sur les produits de santé naturels (RPSN).
Paramètres
Il y a trois paramètres dans la requête : id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/homologations-naturel/productlicence/?id= | Affiche l'homologation selon le code numérique du produit spécifié dans la requête. |
|
Oui | |
api/homologations-naturel/productlicence/?lang=fr | Modifie la langue du résultat. |
|
Non, mais l'anglais est la langue par défaut si elle n'est pas spécifiée. | Détermine si le résultat est affiché en anglais ou en français. |
api/homologations-naturel/productlicence/?type=json | Modifie le format du résultat. |
|
Non, mais JSON est le format par défaut s'il n'est pas spécifié. | Détermine si le résultat est en format JSON ou XML. |
La liste des homologations peut êtres accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet homologation contient les valeurs suivantes :
Code | Valeur |
---|---|
lnhpd_id | Identificateur unique de produit. |
licence_number | Un code numérique de huit (8) chiffres assigné à chaque produit de santé naturel approuvé pour être commercialisé en vertu du RPSN. |
licence_date | Date d'émission initiale. |
revised_date | Date de la dernière révision. |
time_receipt | Date de soumission reçue à la Direction des produits de santé naturels et sans ordonnance. |
date_start | Date à laquelle le processus a débuté. |
product_name_id | Identificateur de valeur clé pour nom de marque. |
product_name | Nom de marque. |
dosage_form | La forme finale du produit de santé naturel pouvant être utilisé par le consommateur sans nécessiter de modifications supplémentaires. |
company_id | Identificateur de valeur clé de compagnie. |
company_name_id | Identificateur de valeur clé de nom de compagnie. |
company_name | Titulaire de licence. |
sub_submission_type_code | Identificateur sous-type de présentations. |
sub_submission_type_desc | Valeur de texte ou le sous-type de présentations. |
flag_primary_name | Signal activé - nom de marque primaire. |
flag_product_status | Produit actif / non actif. |
flag_attested_monograph | Attesté à une monographie Oui / Non. |
Exemple de résultat
{"lnhpd_id":3894930,"licence_number":"02096870","licence_date":"2004-10-15","revised_date":null,"time_receipt":"2004-01-13", "date_start":"2004-01-19","product_name_id":170030,"product_name":"Primanol","dosage_form":"Capsule","company_id":10152,"company_name_id":9141709,"company_name":"Jamieson Laboratories Ltd.", "sub_submission_type_code":5,"sub_submission_type_desc":"DIN de transition","flag_primary_name":1,"flag_product_status":1,"flag_attested_monograph":0}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche une homologation selon le code numérique d'un produit et la langue sélectionnée :
function getProductLicence(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/homologations-naturel/productlicence/?lang=' + lang + '&id=' + id; $.ajax({ url: uri, type: 'GET', Accept: "application/json", dataType: 'json', success: function(data) { console.log(data.licence_number); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var ProductLicence = document.createTextNode(data.licence_number); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(ProductLicence); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error: function(error) {}, }); return; };
Objectif du produit
Déclaration indiquant l'effet bénéfique prévu d'un PSN lorsqu'il est utilisé selon la dose recommandée, la durée d'utilisation et la voie d'administration.
Paramètres
Il y a trois paramètres dans la requête : id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/homologations-naturel/productpurpose/?id= | Affiche les objectif du produit selon l'identificateur unique de produit spécifiée dans la requête. |
|
Non | Si le code n’est pas fourni, une réponse paginée de tous les objectifs du produit sera retournée commençant à la page 1. |
api/natural-licences/productpurpose/?page= | Retourne un résultat donné des résultats paginés. |
|
Non | Les paramètres peuvent être utilisés que si la recherche par code n’est pas faite. |
api/homologations-naturel/productpurpose/?lang=fr | Modifie la langue du résultat. |
|
Non, mais l'anglais est la langue par défaut si elle n'est pas spécifiée. | Détermine si le résultat est affiché en anglais ou en français. |
api/homologations-naturel/productpurpose/?type=json | Modifie le format du résultat. |
|
Non, mais JSON est le format par défaut s'il n'est pas spécifié. | Détermine si le résultat est en format JSON ou XML. |
La liste des objectifs peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet objectif contient les valeurs suivantes :
Code | Valeur |
---|---|
text_id | Identificateur unique pour but. |
lnhpd_id | Identificateur unique de produit. |
purpose | Déclaration de but. |
Exemple de résultat
-
https://produits-sante.canada.ca/api/homologations-naturel/productpurpose?lang=fr&type=json
{ "metadata": { "pagination": { "limit": 100, "page": 1, "total": 84787, "next": "productpurpose?page=2&lang=fr&type=json", "previous": null }, "dateReceived": "2018-12-05T19:19:01.1094580Z" }, "data": [ { "text_id": 67880, "lnhpd_id": 3931278, "purpose": "Helps to rebuild cartilage and aids to relieve osteoarthritic symptoms and joint pain." }, ... ] }
-
https://produits-sante.canada.ca/api/homologations-naturel/productpurpose?lang=fr&type=json&id=3931278
{ "metadata": { "pagination": null, "dateReceived": "2018-12-05T19:16:16.0624846Z" }, "data": [ { "text_id": 67880, "lnhpd_id": 3931278, "purpose": "Helps to rebuild cartilage and aids to relieve osteoarthritic symptoms and joint pain." } ] }
Risque du produit
Toutes mises en garde, réactions indésirables et information contradictoire associées à l'utilisation du PSN.
Paramètres
Il y a trois paramètres dans la requête : id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/homologations-naturel/productrisk/?id= | Affiche les risque du produit selon l'identificateur unique de produit spécifiée dans la requête. |
|
Non | Si le code n’est pas fourni, une réponse paginée de tous les risques du produit sera retournée commençant à la page 1. |
api/natural-licences/productrisk/?page= | Retourne un résultat donné des résultats paginés. |
|
Non | Les paramètres peuvent être utilisés que si la recherche par code n’est pas faite. |
api/homologations-naturel/productrisk/?lang=fr | Modifie la langue du résultat. |
|
Non, mais l'anglais est la langue par défaut si elle n'est pas spécifiée. | Détermine si le résultat est affiché en anglais ou en français. |
api/homologations-naturel/productrisk/?type=json | Modifie le format du résultat. |
|
Non, mais JSON est le format par défaut s'il n'est pas spécifié. | Détermine si le résultat est en format JSON ou XML. |
La liste des risques associés au produit peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet risque contient les valeurs suivantes :
Code | Valeur |
---|---|
lnhpd_id | Identificateur unique de produit. |
risk_id | Identificateur de valeur de risques principaux. |
risk_type_desc | Mises en garde, contre-indications, réactions indésirables connues. |
sub_risk_type_desc | Sous-types de risques s'il y a lieu. |
risk_text | Énoncé de l'étiquette de risque. |
Exemple de résultat
-
https://produits-sante.canada.ca/api/homologations-naturel/productrisk?lang=fr&type=json
{ "metadata": { "pagination": { "limit": 100, "page": 1, "total": 130334, "next": "productrisk/?page=2&lang=fr&type=json", "previous": null }, "dateReceived": "2018-11-30" }, "data": [ { "lnhpd_id": 3898401, "risk_id": 12855, "risk_type_desc": "Précautions et mises en garde", "sub_risk_type_desc": "", "risk_text": "Consult a health care provider prior to use if: you have clotting disorders and/or you are taking blood thinners. Consult a health care provider prior to use if you are taking any oral medication. Consult a health care provider if symptoms persist." }, ... ] }
-
https://produits-sante.canada.ca/api/homologations-naturel/productrisk?lang=fr&type=json&id=3894657
{ "metadata": null, "data": [ { "lnhpd_id": 3898401, "risk_id": 12855, "risk_type_desc": "Précautions et mises en garde", "sub_risk_type_desc": "", "risk_text": "Consult a health care provider prior to use if: you have clotting disorders and/or you are taking blood thinners. Consult a health care provider prior to use if you are taking any oral medication. Consult a health care provider if symptoms persist." }, { "lnhpd_id": 3898401, "risk_id": 12861, "risk_type_desc": "Contre-indications", "sub_risk_type_desc": "", "risk_text": "Do not use if pregnant or breastfeeding. Do not use if you have acute abdominal pain and/or intestinal obstruction." } ] }
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche un risque associé au produit selon l'identificateur unique de produit et la langue sélectionnée :
function getProductRisk(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/homologations-naturel/productrisk/?lang=' + lang + '&id=' + id; $.ajax({ url: uri, type: 'GET', Accept: "application/json", dataType: 'json', success: function(data) { console.log(data.risk_type_desc); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var ProductRiskName = document.createTextNode(data.risk_type_desc); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(ProductRiskName); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error: function(error) {}, }); return; };
Voie d'administration
La méthode par laquelle le PSN doit être livré à l'organisme.
Paramètres
Il y a trois paramètres dans la requête : id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/homologations-naturel/productroute/?id= | Affiche la voie d'administration selon l'identificateur unique de produit spécifié dans la requête. |
|
Oui | |
api/homologations-naturel/productroute/?lang=fr | Modifie la langue du résultat. |
|
Non, mais l'anglais est la langue par défaut si elle n'est pas spécifiée. | Détermine si le résultat est affiché en anglais ou en français. |
api/homologations-naturel/productroute/?type=json | Modifie le format du résultat. |
|
Non, mais JSON est le format par défaut s'il n'est pas spécifié. | Détermine si le résultat est en format JSON ou XML. |
La liste des voies d'administration peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet voie d'administration contient les valeurs suivantes :
Code | Valeur |
---|---|
lnhpd_id | Identificateur unique de produit. |
route_id | Indicateur de valeur-clés de type de voie d'administration. |
route_type_desc | La méthode par laquelle le PSN doit être livré à l'organisme. |
Exemple de résultat
{"lnhpd_id":3894930,"route_id":170060,"route_type_desc":"Orale"}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche une voie d'administration selon l'identificateur unique de produit et la langue sélectionnée :
function getProductRoute(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/homologations-naturel/productroute/?lang=' + lang + '&id=' + id; $.ajax({ url: uri, type: 'GET', Accept: "application/json", dataType: 'json', success: function(data) { console.log(data.route_type_desc); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var ProductRouteName = document.createTextNode(data.route_type_desc); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(ProductRouteName); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error: function(error) {}, }); return; };