Guide API - Base de données des essais cliniques (BDEC)
Table des matières
Introduction
La base de données sur les essais cliniques donne à la population une liste de renseignements précis sur les essais cliniques des phases I, II et III chez les patients. Gérée par Santé Canada, la base de données constitue une source d'information sur les essais cliniques effectués au Canada avec les médicaments pharmaceutiques et biologiques à usage humain.
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 les produits pharmaceutiques est https://produits-sante.canada.ca/api/essais-clinique/ et vous pouvez y ajouter des paramètres. Toute requête est effectuée par l'entremise de cette adresse URI.
Promoteur
Un promoteur d'essai clinique est un particulier, une entreprise, une institution ou un organisme qui mène un essai clinique. Le promoteur est responsable de tous les aspects d'un essai clinique, dont celui de veiller à ce que l'essai soit mené selon les bonnes pratiques cliniques à chaque lieu d'essai clinique. Il doit y avoir un chercheur qualifié, comme un médecin habilité ou un dentiste, à chacun des lieux d'essai choisis. Le chercheur qualifié est la personne responsable auprès du promoteur de la conduite de l'essai clinique à un lieu d'essai clinique.
Paramètres
Il y a trois paramètres dans la requête : id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/essais-clinique/sponsor/?id= | Affiche le promoteur selon le numéro d'identification du promoteur spécifié dans la requête. |
|
Oui | |
api/essais-clinique/sponsor/?lang=fr | Modifie la langue du résultat affiché. |
|
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/essais-clinique/sponsor/?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 promoteurs peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet promoteur contient les valeurs suivantes :
Code | Valeur |
---|---|
manufacturer_id | Le numéro d'identification attribué à un promoteur. |
manufacturer_name | Le nom du promoteur. |
Exemple de résultat
{"manufacturer_id":1118,"manufacturer_name":"ST JOSEPHS HEALTH CENTRE LONDON"}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche un promoteur selon le numéro d'identification d'un promoteur et la langue sélectionnée :
function getSponsor(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/essais-clinique/sponsor/?lang=' + lang + '&id=' + id; $.ajax({ url:uri, type:'GET', Accept:"application/json", dataType: 'json', success:function(data){ console.log(data.manufacturer_name); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var Sponsor = document.createTextNode(data.manufacturer_name); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(Sponsor); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error:function(error){ }, }); return; };
Condition médicale
La maladie ou une description de l'indication recherchée qui est à l'étude dans le cadre de l'essai clinique.
Paramètres
Il y a trois paramètres dans la requête : id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/essais-clinique/medicalcondition/?id= | Affiche la condition médicale selon le numéro d'identification de la condition médicale spécifié dans la requête. |
|
Oui | |
api/essais-clinique/medicalcondition/?lang=fr | Modifie la langue du résultat affiché. |
|
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/essais-clinique/medicalcondition/?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 conditions médicales peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet condition médicale contient les valeurs suivantes :
Code | Valeur |
---|---|
med_condition_id | Le numéro d'identification attribué à une condition médicale. |
med_condition | La condition médicale. |
Exemple de résultat
{"med_condition_id":154,"med_condition":"MÉLANOME"}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche une condition médicale selon le numéro d'identification d'une condition médicale et la langue sélectionnée :
function GetAllMedicalCondition(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/essais-clinique/medicalcondition/?lang=' + lang + '&id=' + id; $.ajax({ url:uri, type:'GET', Accept:"application/json", dataType: 'json', success:function(data){ console.log(data.med_condition); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var MedicalCondition = document.createTextNode(data.med_condition); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(MedicalCondition); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error:function(error){ }, }); return; };
Produit pharmaceutique
Information sur le produit pharmaceutique, telles que le nom donné au médicament utilisé dans le cadre de l'essai clinique. Il peut s'agir d'un nom de code, du nom chimique de l'ingrédient actif, d'une dénomination commune ou d'une marque nominative.
Paramètres
Il y a trois paramètres dans la requête : id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/essais-clinique/drugproduct/?id= | Affiche le produit pharmaceutique selon le numéro d'identification d'une marque spécifié dans la requête. |
|
Oui | |
api/essais-clinique/drugproduct/?lang=fr | Modifie la langue du résultat affiché. |
|
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/essais-clinique/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 phamaceutiques peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet produit phamaceutique contient les valeurs suivantes :
Code | Valeur |
---|---|
protocol_id | Le numéro d'identification attribué à un protocole. |
submission_no | Le numéro de contrôle. |
brand_id | Le numéro d'identification attribué à une marque. |
manufacturer_id | Le numéro d'identification attribué à un promoteur. |
manufacturer_name | Le nom du promoteur. |
brand_name | Le nom commercial du produit pharmaceutique. |
Exemple de résultat
{"protocol_id":35778,"submission_no":"173436","brand_id":155817,"manufacturer_id":4794,"manufacturer_name":"GOVERNORS OF THE UNIVERSITY OF ALBERTA","brand_name":"TRANSPLANTATION DE MICROBIOTES FÉCALES"}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche un produit pharmaceutique selon le numéro d'identification d'une marque et la langue sélectionnée :
function getDrugProduct(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/essais-clinique/drugproduct/?lang=' + lang + '&id=' + id; $.ajax({ url:uri, type:'GET', Accept:"application/json", dataType: 'json', success:function(data){ console.log(data.brand_name); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var DrugProduct = document.createTextNode(data.brand_name); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(DrugProduct); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error:function(error){ }, }); return; };
Protocole
Document qui décrit le ou les objectifs, la conception, la méthodologie, les considérations d'ordre statistique et l'organisation d'un essai clinique.
Paramètres
Il y a trois paramètres dans la requête : id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/essais-clinique/protocol/?id= | Affiche le protocole selon le numéro d'identification du protocole spécifié dans la requête. |
|
Oui | |
api/essais-clinique/protocol/?lang=fr | Modifie la langue du résultat affiché. |
|
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/essais-clinique/protocol/?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 protocoles peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet protocole contient les valeurs suivantes :
Code | Valeur |
---|---|
protocol_id | Le numéro d'identification attribué à un protocole. |
protocol_no | Le numéro du protocole. |
submission_no | Le numéro de contrôle. |
status_id | Le numéro d'identification attribué à un statut. |
start_date | La date de début de l'étude. |
end_date | La date de fin de l'étude. |
nol_date | La date de la lettre de non-objection. |
protocol_title | Titre du protocole. |
medConditionList | La liste des conditions médicales propres à un protocole. |
med_condition_id | Le numéro d'identification attribué à une condition médicale. |
med_condition | La condition médicale. |
studyPopulationList | La liste des populations à l'étude propres à un protocole. |
study_population_id | Le numéro d'identification attribué à une population de l'étude. |
study_population | La population de l'étude. |
Exemple de résultat
{"protocol_id":27351,"protocol_no":"AMB116457","submission_no":"165540","status_id":1,"start_date":"2013-10-30","end_date":null,"nol_date":"2013-07-05", "protocol_title":"ÉTUDE DE PROLONGATION OUVERTE SUR L'INNOCUITÉ, LA TOLÉRABILITÉ ET L'EFFICACITÉ À LONG TERME D'AMBRISENTAN CHEZ LES SUJETS ATTEINTS D'HYPERTENSION PULMONAIRE THROMBOEMBOLIQUE CHRONIQUE (HPTC) INOPÉRABLE", "medConditionList":[{"med_condition_id":326,"med_condition":"HYPERTENSION THROMBOEMBOLIQUE CHRONIQUE PULMONAIRE"}, {"med_condition_id":260,"med_condition":"TROUBLES PULMONAIRES"}], "studyPopulationList":[{"study_population_id":1,"study_population":"ADULTE MASCULINE"}, {"study_population_id":2,"study_population":"ADULTE FÉMININE"}]}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche un protocole selon le numéro d'identification d'un protocole et la langue sélectionnée :
function getProtocol(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/essais-clinique/protocol/?lang=' + lang + '&id=' + id; $.ajax({ url:uri, type:'GET', Accept:"application/json", dataType: 'json', success:function(data){ console.log(data.protocol_title); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var Protocol = document.createTextNode(data.protocol_title); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(Protocol); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error:function(error){ }, }); return; };
Statut de l'essai
« EN ATTENTE » signifie que Santé Canada attend de recevoir du promoteur l'information selon laquelle l'essai est commencé. « EN COURS » signifie que Santé Canada a reçu du promoteur l'information indiquant la date proposée pour le début de l'essai, et « TERMINÉ » signifie que Santé Canada a reçu du promoteur l'information selon laquelle l'essai clinique est terminé.
Paramètres
Il y a trois paramètres dans la requête : id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/essais-clinique/status/?id= | Affiche le statut selon le numéro d'identification du statut spécifié dans la requête. |
|
Oui | |
api/essais-clinique/status/?lang=fr | Modifie la langue du résultat affiché. |
|
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/essais-clinique/status/?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 statuts peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet statut contient les valeurs suivantes :
Code | Valeur |
---|---|
status_id | Le numéro d'identification attribué à un statut. |
Statut | Le statut de l'essai. |
Exemple de résultat
{"status_id":1,"status":"En cours"}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche un statut d'essai selon le numéro d'identification d'un statut et la langue sélectionnée :
function getStatus(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/essais-clinique/status/?lang=' + lang + '&id=' + id; $.ajax({ url:uri, type:'GET', Accept:"application/json", dataType: 'json', success:function(data){ console.log(data.status); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var Status = document.createTextNode(data.status); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(Status); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error:function(error){ }, }); return; };
Population à l'étude
Caractéristiques des sujets admissibles à l'essai clinique, p. ex. hommes et femmes adultes, enfants, etc.
Paramètres
Il y a trois paramètres dans la requête : id, lang et type.
Paramètre | Définition | Valeur | Requis? | Note |
---|---|---|---|---|
api/essais-clinique/studypopulation/?id= | Affiche la population à l'étude selon le numéro d'identification d'une population à l'étude spécifié dans la requête.. |
|
Oui | |
api/essais-clinique/studypopulation/?lang=fr | Modifie la langue du résultat affiché. |
|
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/essais-clinique/studypopulation/?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 populations à l'étude peut être accédée aux adresses URI suivantes :
Contenu du résultat
Le résultat contient un ou plusieurs objets.
Chaque objet population à l'étude contient les valeurs suivantes :
Code | Valeur |
---|---|
study_population_id | Le numéro d'identification attribué à une population à l'étude. |
study_population | La population à l'étude. |
Exemple de résultat
{"study_population_id":3,"study_population":"PÉDIATRIQUE"}
Exemple de jQuery
Exemple d'une fonctionnalité qui recherche une population à l'étude selon le numéro d'identification d'une population à l'étude et la langue sélectionnée :
function getStudyPopulation(id, lang) { var base = 'https://produits-sante.canada.ca'; var uri = base + '/api/essais-clinique/studypopulation/?lang=' + lang + '&id=' + id; $.ajax({ url:uri, type:'GET', Accept:"application/json", dataType: 'json', success:function(data){ console.log(data.study_population); var frag = document.createDocumentFragment(); var h2 = document.createElement("h2"); var StudyPopulation = document.createTextNode(data.study_population); var p = document.createElement("p"); var text = document.createTextNode(data.panels[0].text); h2.appendChild(StudyPopulation); p.appendChild(text); frag.appendChild(h2); frag.appendChild(p); $("#responses")[0].appendChild(frag); }, error:function(error){ }, }); return; };