À propos de la spécification technique; version 20191210
La présente spécification technique présente les fichiers de données pour distribuer l’information que renferme le Répertoire canadien des médicaments (RCM). Un tableau pour chaque fichier du RCM présente le format et la description des attributs dans chacun des fichiers.
Les fichiers sont accesibles du « Infoway Terminology Gateway » (https://tgateway.infoway-inforoute.ca/ccdd.html), et sont fournis en quatre formats : CSV, Excel, XML et JSON. Des guillemets doubles servent d’identificateurs de texte, mais les guillemets doubles ne sont pas utilisés pour les titres d’attribut . Toutes les chaînes sont encodées en UTF-8, et dans le format CSV les caractères de fin de ligne utilisés pour tous les fichiers seront d’Unix (LF). L’ordre des colonnes dans les fichiers pourrait ne pas correspondre à l’ordre dans le tableau ci-dessous.
Les formats CSV et Excel sont les formats privilégiés qui s'harmonisent avec les renseignements supplémentaires contenus dans la présente spécification technique et les directives éditoriales du RCM.
Les formats XML et JSON disponibles sur la passerelle de terminologie de l’Inforoute fournissent un attribut supplémentaire l’« État de la passerelle de terminologie » qui n'est pas présent dans les formats Excel ou CSV.
Les valeurs autorisées pour l’« État de la passerelle de terminologie » en format XML sont les suivantes :
« vrai »; représenté par « <active>true</ active> ». Les concepts ayant cette valeur peuvent avoir un état de cycle de vie RCM (c.-à-d., un mp_status, un ntp_status ou un tm_status en tant que propriété) de « Active (actif), Inactive (inactif) ou Deprec (déprécié) » et doivent être pris en compte par les processus et systèmes utilisant ce format.
« faux »; représenté par « <active>false</ active> ». Les concepts ayant cette valeur doivent être ignorés par les systèmes et processus utilisant ce format. Ils ne sont plus présents dans le RCM.
Les valeurs autorisées pour l’« État de la passerelle de terminologie » en format JSON sont les suivantes :
« vrai »; représenté par « “active”: true ». Les concepts ayant cette valeur peuvent avoir un état de cycle de vie RCM (c.-à-d., un mp_status, un ntp_status ou un tm_status en tant que propriété) de « Active (actif), Inactive (inactif) ou Deprec (déprécié) » et doivent être pris en compte par les processus et systèmes utilisant ce format.
« faux »; représenté par « “active”: false ». Les concepts ayant cette valeur doivent être ignorés par les systèmes et processus utilisant ce format. Ils ne sont plus présents dans le RCM.
Notes sur les nouvelles versions; version 20191210
Sommaire des changements importants :
Les attributs de description en français ont été modifiés pour préciser le type de description.
Un attribut de description en français a été ajouté aux fichiers de la FT et au fichier d’attribut codé.
Un nouveau fichier a été ajouté qui indique le lien PM, PTC et FT avec des descriptions en français.
La longueur de caractère de l’attribut « attribute_value » dans le fichier d’attributs codés est passée de 50 à 500 pour prendre en charge les descriptions en français et les exigences futures.
Les formats disponibles du RCM sur la passerelle de terminologie ont été clarifiés.
La date d’effet du statut des fichiers FT, PTC et PM a été mise à jour pour s’aligner sur ce qui est réellement publié.
RCM Version complète
Produit thérapeutique commun, version complète; (nom du fichier: ntp_full_release_yyyymmdd)
Une représentation de produit (thérapeutique) manufacturé, indépendante de toute marque et axée sur des travaux cliniques. La version « complète » intègre une entrée pour chaque concept ayant fait l’objet d’une version et du nouveau contenu ajouté pour cette version.
Colonne | Type de données | Longueur | Description |
|---|---|---|---|
ntp_code | Chaîne | 7 | L’identificateur unique sans valeur du produit thérapeutique commun |
ntp_formal_name | Chaîne | 500 | La description sans ambiguïté du produit thérapeutique commun qui comprend les détails nécessaires pour le distinguer d’autres concepts semblables. |
ntp_en_description | Chaîne | 500 | La description conviviale en anglais qui peut servir aux fins d’applications Web ou de l’interface utilisateur de tout système. Remarque : Cette description est actuellement absente des fichiers. |
ntp_fr_description | Chaîne | 500 | La description en français du nom officiel du produit thérapeutique commun. |
ntp_status | Chaîne | 8 | L’état du cycle de vie du produit. Les valeurs permises pour l’état sont « Active » (actif), « Inactive » (inactif) et « Deprec » (déprécié). |
ntp_status_effective_time | Chaîne (date) | 8 | La date du « ntp_status » dans ce fichier a été déduite en fonction des Produits Manufacturés associés avec le PTC. Format = AAAAMMJJ |
ntp_type | Chaîne | 8 | L’attribut sert à différencier les produits mixtes. Valeurs = « COMB » ou « NA ». |
Fraction thérapeutique, version complète; (nom du fichier: tm_full_release_yyyymmdd)
La représentation de la partie fonctionnelle et importante sur le plan clinique de la ou des substances actives présentes dans un produit médicinal; la catégorie FT est donc une représentation abstraite d’un produit médicinal ne faisant pas référence à la concentration et à la forme pharmaceutique et ciblant uniquement la ou les substances actives. La version « complète » intègre une entrée pour chaque concept ayant fait l’objet d’une version et du nouveau contenu ajouté pour cette version.
Colonne | Type de données | Longueur | Description |
|---|---|---|---|
tm_code | Chaîne | 7 | L’identificateur unique sans valeur de la fraction thérapeutique |
tm_formal_name | Chaîne | 500 | La description sans ambiguïté de la fraction thérapeutique qui comprend les détails nécessaires pour le distinguer d’autres concepts semblables. |
tm_fr_description | Chaîne | 500 | La description en français de la fraction thérapeutique. |
tm_status | Chaîne | 8 | L’état du cycle de vie du produit. Les valeurs permises pour l’état sont « Active » (actif), « Inactive » (inactif) et « Deprec » (Déprécié). |
tm_status_effective_time | Chaîne (date) | 8 | La date du « tm_status » dans ce fichier a été déduite en fonction des Produits Manufacturés associés avec la FT. Format = AAAAMMJJ |
Produit manufacturé, version complète; (nom du fichier: mp_full_release_yyyymmdd)
La représentation d’un médicament commercialisé offert sur le marché pour ordonnance et délivrance au Canada. La version « complète » intègre une entrée pour chaque concept ayant fait l’objet d’une version et du nouveau contenu ajouté pour cette version.
Colonne | Type de données | Longeur | Description |
|---|---|---|---|
mp_code | Chaîne | 8 | L’identificateur unique d’un produit manufacturé (PM), soit un numéro DIN ou NPN attribué par Santé Canada, soit un identificateur du Répertoire canadien des médicaments. |
mp_formal_name | Chaîne | 500 | La description sans ambiguïté du produit manufacturé qui comprend les détails nécessaires pour le distinguer d’autres concepts semblables. |
mp_en_description | Chaîne | 500 | La description conviviale en anglais qui peut servir aux fins d’applications Web ou de l’interface utilisateur de tout système. Remarque : Cette description est actuellement absente des fichiers. |
mp_fr_description | Chaîne | 500 | La description en français du nom officiel du produit manufacturé. |
mp_status | Chaîne | 8 | L’état du cycle de vie du produit. Les valeurs permises pour l’état sont « Active » (actif), « Inactive » (inactif) et « Deprec » (déprécié).
|
mp_status_effective _time | Chaîne (date) | 8 | La date du « mp_status » est basée en fonction de l'état réglementaire sous-jacent dans la BDPP. Format = AAAAMMJJ |
mp_type | Chaîne | 8 | Le code PM (mp_type) permet de distinguer entre un code PM qui correspond à une identification numérique de drogue (DIN) dans la BDPP, à un numéro de produit naturel (NPN ou à un identificateur créé aux fins du RCM. Les valeurs permises pour mp_type sont « DIN », « NPN » et « RCM ». |
Health_Canada_identifier | Chaîne | 8 | Il s’agit du numéro DIN ou NPN attribué par Santé Canada au produit médicinal autorisé.
|
Health_Canada_product name | Chaîne | 200 | Le nom du produit approuvé par Santé Canada (tel qu’il apparaît dans la BDPP ou la Base de données sur les produits de santé naturels homologués [BDPSNH]) sous lequel le produit peut être commercialisé.
|
Relation entre un produit manufacturé, son produit thérapeutique commun et sa fraction thérapeutique; (nom du fichier: mp_ntp_tm_relationship_yyyymmdd)
Chaque ligne représente la relation entre un PM, son PTC et sa FT (le cas échéant). Le contenu actif et inactif des fichiers de la version complète pour le PM, le PTC et la FT sera intégré. Le contentu déprécié ne sera pas intégré. Ce fichier contient les codes du PM, PtC et FT (mp_code, ntp_code et tm_code), et leurs noms officiels (mp_formal name, ntp_formal name et tm_formal name).
Colonne | Type de donnés | Longueur | Description |
|---|---|---|---|
mp_code | Chaîne | 8 | L’Identificateur unique d’un produit manufacturé, soit un numéro DIN ou NPN attribué par Santé Canada, soit un identificateur du Répertoire canadien des médicaments. |
mp_formal_name | Chaîne | 500 | La description sans ambiguïté du produit manufacturé qui comprend les détails nécessaires pour le distinguer d’autres concepts semblables. |
ntp_code | Chaîne | 7 | L’identificateur unique sans valeur du produit thérapeutique commun. |
ntp_formal_name | Chaîne | 500 | La description sans ambiguïté du produit thérapeutique commun (PTC) qui comprend les détails nécessaires pour le distinguer d’autres concepts semblables. |
tm_code | Chaîne | 7 | L’identificateur unique sans valeur de la fraction thérapeutique. |
tm_formal_name | Chaîne | 500 | La description sans ambiguïté de la fraction thérapeutique qui comprend les détails nécessaires pour le distinguer d’autres concepts semblables. |
Relation entre un produit manufacturé, son produit thérapeutique commun et sa fraction thérapeutique, avec descriptions en français; (nom du fichier: mp_ntp_tm_relationship_fr_yyyymmdd)
Chaque ligne représente la relation entre un PM, son PTC et sa FT (le cas échéant). Le contenu actif et inactif des fichiers de la version complète pour le PM, le PTC et la FT sera intégré, ainsi que les descriptions en français. Le contenu déprécié ne sera pas intégré.
Colonne | Type de donnés | Longueur | Description |
mp_code | Chaîne
| 8 | L’identificateur unique d’un produit manufacturé, soit un numéro DIN ou NPN attribué par Santé Canada, soit un identificateur du Répertoire canadien des médicaments. |
mp_fr_description | Chaîne | 500 | La description en français du nom officiel du produit manufacturé. |
ntp_code | Chaîne | 7 | L’identificateur unique du produit thérapeutique commun. |
ntp_fr_description | Chaîne | 500 | La description en français du nom officiel du produit thérapeutique commun. |
tm_code | Chaîne | 7 | Identificateur unique sans valeur de la fraction thérapeutique. |
tm_fr_description | Chaîne | 500 | La description en français du nom officiel de la fraction thérapeutique. |
Instrument de produit thérapeutique commun, version complète; (nom du fichier: device- ntp_full_release_yyyymmdd)
Une représentation d’un instrument de soins de la santé manufacturé, indépendante de toute marque et axée sur des travaux cliniques. La version « complète » intègre une entrée pour chaque concept ayant fait l’objet d’une version et du nouveau contenu ajouté pour cette version.
Colonne | Type de données | Longueur | Description |
|---|---|---|---|
device_ntp_code | Chaîne | 7 | L’identificateur unique sans valeur d’un instrument de produit thérapeutique commun. |
device_ntp_formal_name | Chaîne | 500 | La description sans ambiguïté de l’instrument du produit thérapeutique commun qui comprend les détails nécessaires pour le distinguer d’autres concepts semblables.
|
device_ntp_en_description | Chaîne | 500 | La description conviviale en anglais qui peut servir aux fins d’applications Web ou de l’interface utilisateur de tout système. Remarque : Cette description est actuellement absente des fichiers. |
device_ntp_fr_description | Chaîne | 500 | La description en français du nom officiel de l’instrument. |
device_ntp_status | Chaîne | 8 | L’état du cycle de vie pour le concept de ce fichier. Les valeurs permises pour l’état sont « Active » (actif), « Inactive » (inactif) et « deprec » (déprécié). |
device_ntp_status_effective_time | Chaîne (date) | 8 | La date de l’état dans ce fichier. Format = AAAAMMJJ. |
Regroupements spéciaux; (nom du fichier: special_groupings_yyyymmdd)
Ce fichier indique des concepts dans le Répertoire canadien des médicaments (RCM) et fournit les liens entre eux et les politiques qui s’appliquent aux produits de ces concepts. Le fichier fournit également de l’information sur l’état de la relation pour que l’information historique puisse être maintenue (p. ex., pour un produit dont l’information sur la politique a évolué avec le temps).
Colonne | Type de données | Longueur | Description |
|---|---|---|---|
ccdd_code | Chaîne | 8 | L’identificateur unique sans valeur d’un concept dans le Répertoire canadien des médicaments. Il pourrait s’agir d’un code de FT (tm_code), d’un code de PTC (ntp_code) ou d’un code de PM (mp_code). |
ccdd_formal name | Chaîne | 500 | La description sans ambiguïté du concept dans le Répertoire canadien des médicaments. Il pourrait s’agir d’un nom officiel de FT (tm_formal_name), d’un nom officiel de PTC (ntp_formal_name) ou d’un nom officiel de PM (mp_formal_name). |
ccdd_type | Chaîne | 15 | L’identification du type de concept en particulier (PM, PTC ou FT) dans le Répertoire canadien des médicaments. |
policy_type | Chaîne | 250 | Un code représentant la politique régissant le concept décrit dans ccdd_code. Les détails sur le code peuvent être consultés dans le fichier coded_attributes. |
policy_reference | Chaîne | 250 | Une référence pour faire avancer l’information sur la politique. Il pourrait s’agir d’une adresse URL. |
special_groupings_status | Chaîne | 8 | L’état du cycle de vie de la relation entre le concept décrit dans ccdd_code et la politique décrite dans policy_type. Les valeurs permises pour l’état sont « Active » (actif), « Inactive » (inactif) et « Deprec (déprécié).
|
special_groupings_effective_time | Chaîne (date) | 8 | Pour les entrées d’état « actif », il s’agit de la date à laquelle l’information a été intégrée au fichier. Pour les entrées d’état « inactif », il s’agit de la date à laquelle l’information sur la politique dans ce fichier n’est plus applicable. Format = AAAAMMJJ |
Attribut codé; (nom du fichier: coded_attribute_yyyymmdd)
Le fichier fournit les valeurs codées utilisées dans un champ d’attribut au sein du RCM.
Colonne | Type de données | Longueur | Description |
|---|---|---|---|
attribute | Chaîne | 50 | Le nom de l’attribut codé en particulier du type de fichier du RCM. |
attribute_code | Chaîne | 8 | L’identificateur unique d’une valeur d’attribut dans le Répertoire canadien des médicaments. |
attribute_value | Chaîne | 50 | La description sans ambiguïté d’un attribut dans le Répertoire canadien des médicaments. |
fr_attribute_value | Chaîne | 500 | La description en français de la valeur de l’attribut dans le RCM. Au cas où une description en français n’est pas disponible, la valeur sera « NA ». |
CCDD_file_type | Chaîne | 200 | Le nom du type de fichier du RCM d’où vient l’attribut. |
attribute_status | Chaîne | 8 | L’état du cycle de vie pour le concept de ce fichier. Les valeurs permises pour l’état sont « Active » (actif), « Inactive » (inactif) et « Deprec » (déprécié). |
attribute_status_effective_time | Chaîne (date) | 8 | La date de l’état dans ce fichier. Format = AAAAMMJJ. |
RCM Delta Release
Produit thérapeutique commun, version delta; (nom du fichier: ntp_ delta_release_yyyymmdd)
Une représentation des modifications depuis la version précédente de ntp_full_release. Seuls les concepts de PTC qui ont changé seront fournis dans ce fichier. La version « delta » renferme seulement les concepts ajoutés ou modifiés depuis la version précédente.
Colonne | Type de données | Longuer | Description |
|---|---|---|---|
ntp_code | Chaîne | 7 | L’identificateur unique sans valeur du produit thérapeutique commun. |
ntp_formal_name | Chaîne | 500 | La description sans ambiguïté du produit thérapeutique commun qui comprend les détails nécessaires pour le distinguer d’autres concepts semblables. |
ntp_en_description | Chaîne | 500 | La description conviviale en anglais qui peut servir aux fins d’applications Web ou de l’interface utilisateur de tout système. Remarque : Cette description est actuellement absente des fichiers. |
ntp_fr_description | Chaîne | 500 | La description en français du nom officiele du produit thérapeutique commun. |
ntp_status | Chaîne | 8 | L’état du cycle de vie du produit. Les valeurs permises pour l’état sont « Active » (actif), « Inactive » (inactif) et « Deprec » (déprécié). |
ntp_status_effective_time | Chaîne (date) | 8 | La date du « ntp_status » dans ce fichier a été déduite en fonction des Produits Manufacturés associés avec le PTC. Format = AAAAMMJJ |
change-type | Chaîne | 10 | Cet attribut fournit les types de modifications appliquées à tout élément du concept ou des attributs applicables. Les types de modifications comprennent « Added » (ajouté) ou « Changed » (modifié). |
Fraction thérapeutique, version delta; (nom du fichier: tm_delta_release_yyyymmdd)
Une représentation des modifications depuis la version précédente de tm_full_release. Seuls les concepts de FT qui ont changé seront fournis dans ce fichier. La version « delta » renferme seulement les concepts ajoutés ou modifiés depuis la version précédente.
Colonne | Type de données |
| Longueur | Description |
|---|---|---|---|---|
tm_code | Chaîne |
| 7 | L’identificateur unique sans valeur de la fraction thérapeutique. |
tm_formal_name | Chaîne |
| 500 | La description sans ambiguïté de la fraction thérapeutique qui comprend les détails nécessaires pour le distinguer d’autres concepts semblables. |
tm_status | Chaîne |
| 8 | L’état du cycle de vie du produit. Les valeurs permises pour l’état sont « Active » (actif), « Inactive » (inactif), et « Deprec » (déprécié). |
tm_status_effective_time | Chaîne (date) |
| 8 | La date du « tm_status » dans ce fichier a été déduite en fonction des Produits Manufacturés associés avec la FT. Format = AAAAMMJJ |
change_type | Chaîne |
| 10 | Cet attribut fournit les types de modifications appliquées à tout élément du concept ou des attributs applicables. Les types de modifications comprennent « Added » (ajouté) ou « Changed » (modifié). |
Produit manufacturé, version delta; (nom du fichier: mp_delta_release_yyyymmdd)
Une représentation des modifications depuis la version précédente de mp_full_release. Seuls les concepts de PM qui ont changé seront fournis dans ce fichier. La version « delta » renferme seulement les concepts ajoutés ou modifiés depuis la version précédente. Les types de modifications comprendraient les inactivations et toute modification à une description.
Colonne | Type de données | Longueur | Description |
|---|---|---|---|
mp_code | Chaîne | 8 | L’identificateur unique d’un produit manufacturé, soit un numéro DIN ou NPN attribué par Santé Canada, soit un identificateur du Répertoire canadien des médicaments |
mp_formal_name | Chaîne | 500 | La description sans ambiguïté du produit manufacturé qui comprend les détails nécessaires pour le distinguer d’autres concepts semblables. |
mp_en_description | Chaîne | 500 | La description conviviale en anglais qui peut servir aux fins d’applications Web ou de l’interface utilisateur de tout système. Remarque : Cette description est actuellement absente des fichiers. |
mp_fr_description | Chaîne | 500 | La description du nom officiel du produit manufacturé. |
mp_status | Chaîne | 8 | L’état du cycle de vie du produit. Les valeurs permises pour l’état sont « Active » (actif), « inactive » (inactif) et « Deprec » (déprécié). |
mp_status_effective_time | Chaîne (date) | 8 | La date du « mp_status » dans ce fichier est basée sur l'état réglementaire sous-jacent dans la BDPP. Format = AAAAMMJJ |
change_type | Chaîne | 10 | Cet attribut fournit les types de modifications appliquées à tout élément du concept ou des attributs applicables. Les types de modifications comprennent « Added » (ajouté) ou « Changed » (modifié). |
Instrument de produit thérapeutique commun, version delta; (nom du fichier: device- ntp_delta_release_yyyymmdd)
Une représentation des modifications depuis la version précédente de Device- ntp_full_release. Seuls les concepts d’instrument de PTC qui ont changé seront fournis dans ce fichier. La version « delta » renferme seulement les concepts ajoutés ou modifiés depuis la version précédente. Les types de modifications comprendraient les inactivations et toute modification à une description.
Colonne | Type de données | Longueur | Description |
|---|---|---|---|
device_ntp_code | Chaîne | 7 | L’identificateur unique sans valeur d’un instrument de produit thérapeutique commun.
|
device_ntp_formal_name | Chaîne | 500 | La description sans ambiguïté de l’instrument de produit thérapeutique commun qui comprend les détails nécessaires pour le distinguer d’autres concepts semblables. |
device_ntp_en_description | Chaîne | 500 | La description conviviale en anglais qui peut servir aux fins d’applications Web ou de l’interface utilisateur de tout système. Remarque : Cette description est actuellement absente des fichiers. |
device_ntp_fr_decription | Chaîne | 500 | La description en français de l’instrument de produit thérapeutique commun. |
device_ntp_status | Chaîne | 8 | L’état du cycle de vie pour le concept de ce fichier. Les valeurs permises pour l’état sont « Active » (actif), « Inactive » (inactif) et « Deprec » (déprécié). |
device-ntp_status_effective-time | Chaîne (date) | 8 | La date de l’état dans ce fichier. Format = AAAAMMJJ. |
change_type | Chaîne | 10 | Cet attribut fournit les types de modifications appliquées à tout élément du concept ou des attributs applicables. Les types de modifications comprennent « Added » (ajouté) ou « Changed » (modifié).
|