Guide API - Base de données en ligne des effets indésirables de Canada Vigilance (BDEI)
Table des matières
Introduction
La base de données en ligne des effets indésirables de Canada Vigilance renferme de l'information au sujet des effets indésirables soupçonnés (ou effets secondaires) associés à des produits de santé.
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ées en ligne des effets indésirables de Canada Vigilance (BDEI) est https://produits-sante.canada.ca/api/canada-vigilance/ et vous pouvez y ajouter des paramètres. Toute requête est effectuée par l'entremise de cette adresse URI.
Ingrédient actif et produit pharmaceutique
Fournit des renseignements sur les ingrédients actifs de tous les médicaments.
Paramètres
Il y a trois paramètres dans la requête: id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/canada-vigilance/drugproductingredient/?id= | Affiche l'ingrédient actif du produit selon l'identifiant de l'ingrédient actif d'un produit pharmaceutique spécifié dans la requête. |
|
Oui | |
api/canada-vigilance/drugproductingredient/?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/canada-vigilance/drugproductingredient/?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 actifs 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 actif contient les valeurs suivantes :
Code | Valeur |
---|---|
drug_product_ingredient_id | Identifiant du produit pharmaceutique – Ingrédient actif. |
drug_product_id | Identifiant du produit pharmaceutique. |
drug_name | Nom commercial. |
active_ingredient_id | Identifiant de l'ingrédient actif. |
active_ingredient_name | Nom de l'ingrédient actif. |
Exemple de résultat
{"drug_product_ingredient_id":242002322,"drug_product_id":2420,"product_id":14208,"drug_name":"INTROPIN INJECTION 40MG/ML","active_ingredient_id":2322,"active_ingredient_name":"dopamine hydrochloride"}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche un ingrédient actif selon l'identifiant de l'ingrédient actif d'un produit et la langue sélectionnée :
function getDrugProductIngredient(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/canada-vigilance/drugproductingredient/?lang=' + lang + '&id=' + id; $.ajax({ url:uri, type:'GET', Accept:"application/json", dataType: 'json', success:function(data){ console.log(data.active_ingredient_name); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var ActiveIngredientName = document.createTextNode(data.active_ingredient_name); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(ActiveIngredientName); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error:function(error){ }, }); return; };
Produit pharmaceutique
Fournit le nom de tous les médicaments et leurs codes.
Paramètres
Il y a trois paramètres dans la requête: id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/canada-vigilance/drugproduct/?id= | Affiche le produit pharmaceutique selon l'identifiant du produit spécifié dans la requête. |
|
Oui | |
api/canada-vigilance/drugproduct/?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/canada-vigilance/drugproduct/?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 produits pharamaceutiques peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet produit pharmaceutique contient les valeurs suivantes :
Code | Valeur |
---|---|
drug_product_id | Identifiant du produit pharmaceutique. |
drug_name | Nom commercial. |
Exemple de résultat
{"drug_product_id":1,"product_id":1643,"drug_name":"HERISAN ONT 150MG","cpd_flag":1}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche un produit pharmaceutique selon l'identifiant d'un produit pharmaceutique et la langue sélectionnée :
function getDrugProduct(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/canada-vigilance/drugproduct/?lang=' + lang + '&id=' + id; $.ajax({ url:uri, type:'GET', Accept:"application/json", dataType: 'json', success:function(data){ console.log(data.drug_name); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var DrugName = document.createTextNode(data.drug_name); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(DrugName); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error:function(error){ }, }); return; };
Sexe
Fournit des renseignements sur le sexe, accompagnés du code du sexe.
Paramètres
Il y a trois paramètres dans la requête: id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/canada-vigilance/gender/?id= | Affiche le sexe selon l'identifiant du sexe spécifié dans la requête. |
|
Oui | |
api/canada-vigilance/gender/?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/canada-vigilance/gender/?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 sexes peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet sexe contient les valeurs suivantes :
Code | Valeur |
---|---|
gender_id | Identifiant du sexe. |
gender_code | Code du sexe. |
gender_name | Sexe. |
Exemple de résultat
{"gender_id":41,"gender_code":"1","gender_name":"Homme"}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche un sexe selon l'identifiant d'un sexe et la langue sélectionnée :
function getGender(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/canada-vigilance/gender/?lang=' + lang + '&id=' + id; $.ajax({ url:uri, type:'GET', Accept:"application/json", dataType: 'json', success:function(data){ console.log(data.gender_name); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var GenderName = document.createTextNode(data.gender_name); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(GenderName); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error:function(error){ }, }); return; };
Résultat
Fournit des renseignements sur le résultat, accompagnés du code du résultat.
Paramètres
Il y a trois paramètres dans la requête: id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/canada-vigilance/outcome/?id= | Affiche le résultat selon l'identifiant du résultat de la déclaration spécifié dans la requête. |
|
Oui | |
api/canada-vigilance/outcome/?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/canada-vigilance/outcome/?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 résultats peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet résultat contient les valeurs suivantes :
Code | Valeur |
---|---|
outcome_id | Identifiant du résultat de la déclaration. |
outcome_code | Code du résultat de la déclaration. |
outcome_name | Résultat de la déclaration. |
Exemple de résultat
{"outcome_id":1906,"outcome_code":"06","outcome_name":"Inconnu"}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche un résultat selon l'identifiant d'un résultat de déclaration et la langue sélectionnée :
function getOutcome(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/canada-vigilance/outcome/?lang=' + lang + '&id=' + id; $.ajax({ url:uri, type:'GET', Accept:"application/json", dataType: 'json', success:function(data){ console.log(data.outcome_name); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var OutcomeName = document.createTextNode(data.outcome_name); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(OutcomeName); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error:function(error){ }, }); return; };
Réaction
Fournit des renseignements au sujet des réactions associées aux déclarations.
Paramètres
Il y a trois paramètres dans la requête: id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/canada-vigilance/reaction/?id= | Affiche la réaction selon l'identifiant de la réaction spécifié dans la requête. |
|
Oui | |
api/canada-vigilance/reaction/?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/canada-vigilance/reaction/?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 réactions peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet réaction contient les valeurs suivantes :
Code | Valeur |
---|---|
reaction_id | Identifiant de la réaction. |
report_id | Numéro de la déclaration d'effet indésirable (DEI) (6 chiffres ). |
duration | Durée de la réaction. |
duration_unit | Unité de durée de la réaction. |
pt_name | Terme des effets indésirables. |
soc_name | Classe par système et organe. |
meddra_version | Version de MedDRA. |
Exemple de résultat
{"reaction_id":5801,"report_id":58,"duration":0.0,"duration_unit":"","pt_name":"Conjonctivite","soc_name":"Infections et infestations","meddra_version":"v.18.1"}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche une réaction selon l'identifiant d'une réaction et la langue sélectionnée :
function getReaction(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/canada-vigilance/reaction/?lang=' + lang + '&id=' + id; $.ajax({ url:uri, type:'GET', Accept:"application/json", dataType: 'json', success:function(data){ console.log(data.duration); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var Duration = document.createTextNode(data.duration); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(Duration); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error:function(error){ }, }); return; };
Médicaments associés aux déclarations
Fournit des renseignements sur les médicaments associés aux déclarations.
Paramètres
Il y a trois paramètres dans la requête: id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/canada-vigilance/reportdrug/?id= | Affiche les médicaments selon l'identifiant de la déclaration d'un produit spécifié dans la requête. |
|
Oui | |
api/canada-vigilance/reportdrug/?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/canada-vigilance/reportdrug/?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 médicaments peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet médicament contient les valeurs suivantes :
Code | Valeur |
---|---|
report_drug_id | Identifiant de la déclaration - Produit pharmaceutique. |
report_id | Numéro de la déclaration d'effet indésirable (DEI) (6 chiffres). |
drug_product_id | Identifiant du produit pharmaceutique. |
drug_name | Nom commercial. |
drug_involv_name | Rôle du produit de santé. |
route_admin_name | Voie d'administration. |
unit_dose_qty | Dose. |
dose_unit_name | Unité de dose. |
frequency | Fréquence. |
freq_time | Temps fréquence. |
frequency_time | Temps fréquence. |
freq_time_unit | Unité de fréquence. |
therapy_duration | Durée de la thérapie. |
therapy_duration_unit | Unité de durée de la thérapie. |
dosage_form | Forme posologique. |
indication_name | Indication. |
Exemple de résultat
{"report_drug_id":1106349,"report_id":50,"drug_product_id":16876,"drug_name":"FORTICILLIN","drug_involv_name":"Suspect","route_admin":null,"route_admin_name":"Intramusculaire","unit_dose_qty":0.0,"dose_unit":"","dose_unit_name":null,"frequency":2,"freq_time":1.0,"frequency_time":"2 chaque 1 Jour(s)","freq_time_unit":"Jour(s)","therapy_duration":1.0,"therapy_duration_unit":"Jours","dosage_form":"NON PRÉCISÉE","indication_name":null}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche les médicaments selon l'identifiant d'une déclaration d'un produit et la langue sélectionnée :
function getReportDrug(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/canada-vigilance/reportdrug/?lang=' + lang + '&id=' + id; $.ajax({ url:uri, type:'GET', Accept:"application/json", dataType: 'json', success:function(data){ console.log(data.drug_name); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var DrugName = document.createTextNode(data.drug_name); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(DrugName); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error:function(error){ }, }); return; };
Déclarations liées
Fournit des renseignements sur les déclarations liées ou en double, accompagnés du code des déclarations.
Paramètres
Il y a trois paramètres dans la requête: id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/canada-vigilance/reportlink/?id= | Affiche la déclaration liée selon l'identifiant d'un numéro de déclaration spécifié dans la requête. |
|
Oui | |
api/canada-vigilance/reportlink/?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/canada-vigilance/reportlink/?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 déclarations liées peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet déclaration liée contient les valeurs suivantes :
Code | Valeur |
---|---|
report_link_id | Identifiant du numéro de la déclaration. |
report_id | Numéro de la déclaration d'effet indésirable (DEI) (6 chiffres). |
record_type | Type d'enregistrement. |
report_link_no | Numéro de la déclaration d'effet indésirable (DEI) en double ou de la déclaration liée. |
Exemple de résultat
{"report_link_id":1531151,"report_id":153115,"record_type":"Lié","report_link_no":"000153114"}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche une déclaration liée selon l'identifiant d'un numéro de déclaration et la langue sélectionnée :
function getReportLink(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/canada-vigilance/reportlink/?lang=' + lang + '&id=' + id; $.ajax({ url:uri, type:'GET', Accept:"application/json", dataType: 'json', success:function(data){ console.log(data.record_type); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var RecordLink = document.createTextNode(data.record_type); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(RecordLink); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error:function(error){ }, }); return; };
Type de déclaration
Fournit des renseignements sur le type de déclaration, accompagnés du code du type de déclaration.
Paramètres
Il y a trois paramètres dans la requête: id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/canada-vigilance/reporttype/?id= | Affiche le type de déclaration selon l'identifiant d'un type de déclaration spécifié dans la requête. |
|
Oui | |
api/canada-vigilance/reporttype/?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/canada-vigilance/reporttype/?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 types de déclaration peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet type de déclaration contient les valeurs suivantes :
Code | Valeur |
---|---|
report_type_id | Identifiant du type de déclaration. |
report_type_code | Code du type de déclaration. |
report_type | Type de déclaration. |
Exemple de résultat
{"report_type_id":70095007,"report_type_code":"5","report_type":"Publiée"}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche un type de déclaration selon l'identifiant d'un type de déclaration et la langue sélectionnée :
function getReportType(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/canada-vigilance/reporttype/?lang=' + lang + '&id=' + id; $.ajax({ url:uri, type:'GET', Accept:"application/json", dataType: 'json', success:function(data){ console.log(data.report_type); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var ReportType = document.createTextNode(data.report_type); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(ReportType); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error:function(error){ }, }); return; };
Déclaration
Fournit des renseignements au sujet des déclarations et des patients.
Paramètres
Il y a trois paramètres dans la requête: id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/canada-vigilance/report/?id= | Affiche la déclaration selon le numéro d'une déclaration d'effet indésirable spécifié dans la requête. |
|
Oui | |
api/canada-vigilance/report/?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/canada-vigilance/report/?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 déclarations peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet déclaration contient les valeurs suivantes :
Code | Valeur |
---|---|
report_id | Numéro de la déclaration d'effet indésirable (DEI) (6chiffres). |
report_no | Numéro de la déclaration d'effet indésirable (DEI) (9 chiffres). |
version_no | Numéro de version de la déclaration d'effet indésirable (DEI). |
date_received | Date de la dernière réception. |
date_int_received | Date de la réception initiale. |
mah_no | Numéro de la déclaration d'effet indésirable (DEI) du détenteur d'autorisation de mise en marché. |
report_type_code | Code du type de déclaration. |
report_type_name | Type de déclaration. |
gender_code | Code du sexe. |
gender_name | Sexe. |
age | Âge. |
age_y | Âge en années. |
age_unit | Unité de l'âge. |
outcome_code | Code du résultat de la déclaration. |
outcome | Résultat de la déclaration. |
weight | Poids. |
weight_unit_code | Code de l'unité de poids. |
weight_unit | Unité de poids. |
height | Taille. |
height_unit_code | Code de l'unité de taille. |
height_unit | Unité de taille. |
seriousness_code | Code de la gravité de la réaction indésirable. |
seriousness | Gravité de la réaction indésirable. |
death | Décès. |
disability | Invalidité. |
congenital_anomaly | Anomalie congénitale. |
life_threatening | Vie en danger. |
hosp_required | Hospitalisation. |
other_medically_imp_cond | Autre affection importante. |
reporter_type_code | Code du type de déclarant. |
reporter_type | Type de déclarant. |
source_code | Code de la source de la déclaration. |
source_name | Source de la déclaration. |
pt_name | Terme des effets indésirables. |
soc_name | Classe par système et organe. |
duration | Durée de la réaction. |
duration_unit | Unité de durée de la réaction. |
drug_name | Nom commercial. |
Exemple de résultat
{"report_id":97,"report_no":"000000097","version_no":0,"date_received":"1973-06-01","date_int_received":"1973-06-01","mah_no":"","report_type_code":null,"report_type_name":"Déclaration spontanée","gender_code":"1","gender_name":"Homme","age":49.0,"age_y":49.0,"age_unit_code":"07","age_unit":"Ans","age_group_code":"","age_group_name":"","outcome_code":"11","outcome":"Décès","weight":0.0,"weight_unit_code":"","weight_unit":"","height":0.0,"height_unit_code":"","height_unit":"","seriousness_code":"01","seriousness":"Oui","death":"1","disability":"","congenital_anomaly":"","life_threatening":"","hosp_required":"","other_medically_imp_cond":"","reporter_type_code":"9","reporter_type":"Professionnel de la santé","source_code":"","source_name":"","report_link_flg":0,"aer_id":90100078809,"pt_name":"Surdose accidentelle","soc_name":"Lésions, intoxications et complications liées aux procédures","duration":0.0,"duration_unit":"","drug_name":"ETHANOL, PMA","cpd_flag":0}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche une déclaration selon le numéro d'une déclaration d'effet indésirable et la langue sélectionnée :
function getReport(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/canada-vigilance/report/?lang=' + lang + '&id=' + id; $.ajax({ url:uri, type:'GET', Accept:"application/json", dataType: 'json', success:function(data){ console.log(data.report_no); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var ReportNo = document.createTextNode(data.report_no); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(ReportNo); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error:function(error){ }, }); return; };
Gravité de la réaction indésirable
Fournit des renseignements sur la gravité de la réaction, accompagnés du code de gravité.
Paramètres
Il y a trois paramètres dans la requête: id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/canada-vigilance/seriousness/?id= | Affiche la gravité d'une réaction selon l'identifiant de la gravité de la déclaration spécifié dans la requête. |
|
Oui | |
api/canada-vigilance/seriousness/?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/canada-vigilance/seriousness/?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 de gravité des réactions peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet gravité de la réaction contient les valeurs suivantes :
Code | Valeur |
---|---|
seriousness_id | Identifiant de la gravité de la déclaration. |
seriousness_code | Code de la gravité de la réaction indésirable. |
seriousness | Gravité de la réaction indésirable. |
Exemple de résultat
{"seriousness_id":2001,"seriousness_code":"01","seriousness":"Oui"}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche la gravité d'une réaction selon l'identifiant de la gravité de la déclaration et la langue sélectionnée :
function getSeriousness(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/canada-vigilance/seriousness/?lang=' + lang + '&id=' + id; $.ajax({ url:uri, type:'GET', Accept:"application/json", dataType: 'json', success:function(data){ console.log(data.seriousness); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var Seriousness = document.createTextNode(data.seriousness); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(Seriousness); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error:function(error){ }, }); return; };
Source de déclaration
Fournit des renseignements sur la source de déclaration, accompagnés du code de la source.
Paramètres
Il y a trois paramètres dans la requête: id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/canada-vigilance/source/?id= | Affiche la source d'une déclaration selon l'identifiant de la source de la déclaration spécifié dans la requête. |
|
Oui | |
api/canada-vigilance/source/?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/canada-vigilance/source/?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 sources de déclaration peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet source de déclaration contient les valeurs suivantes :
Code | Valeur |
---|---|
source_id | Identifiant de la source de la déclaration. |
source_code | Code de la source de la déclaration. |
source | Source de la déclaration. |
Exemple de résultat
{"source_id":1001,"source_code":"01","source":"Communauté"}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche une source de déclaration selon l'identifiant d'une source de déclaration et la langue sélectionnée :
function getSource(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/canada-vigilance/source/?lang=' + lang + '&id=' + id; $.ajax({ url:uri, type:'GET', Accept:"application/json", dataType: 'json', success:function(data){ console.log(data.source); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var Source = document.createTextNode(data.source); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(Source); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error:function(error){ }, }); return; };