Technical Specification, Version 20191210
Release Notes
Here is a summary of the key changes with this release:
The French description attributes have been edited to clarify the type of description
A French description attribute has been added to the TM files and the coded attribute file.
A new file has been added that provides the MP, NTP and TM relationship with French descriptions
The character length for the attribute_value attribute in the Coded Attributes file has been increased from 50 to 500 to accommodate the French descriptions and future requirements.
The available formats of the CCDD on the Terminology Gateway have been clarified
The status effective date for the TM, NTP and MP files has been updated to align with what is actually being published
CCDD File Types
CCDD Full Release File Types
Non-proprietary Therapeutic Product Full Release;
(FILE NAME; ntp_full_release_yyyymmdd)
A representation of a brand independent and clinically oriented representation of a manufactured (therapeutic) drug product. The 'Full' release contains one entry for every concept that has ever been released and new content added for that release.
Column | Data Type | Length | Description |
|---|---|---|---|
ntp_code | String | 7 | Unique meaningless Non-proprietary Therapeutic Product identifier. |
ntp_formal_name | String | 500 | The unambiguous description of the Non-proprietary Therapeutic Product that includes details necessary to distinguish it from other similar concepts. |
ntp_en_description | String | 500 | The user-friendly English description that may be used for web applications or the user interface for any system. NB: Not present in the files currently. |
ntp_fr_description | String | 500 | The French description of the Non-proprietary Therapeutic Product formal name. |
ntp_status | String | 8 | The lifecycle state for the product. Allowable values for status are “Active”, “Inactive” and "Deprec" (deprecated). |
ntp_status_effective_time | String (Date) | 8 | The date of the ntp_status in this file has been inferred based on the Manufactured Products associated with the ntp. Format = YYYYMMDD |
ntp_type | String | 8 | This attribute is used to differentiate combination products. Values = "Comb" or "NA". |
Therapeutic Moiety Full Release;
(FILE NAME; tm_full_release_yyyymmdd)
The representation of the functional and clinically significant part of the active ingredient substance(s) present in a medicinal product, and as such the TM class is an abstract representation of a medicinal product without reference to strength and dose form, focusing only on active ingredient substance(s). The 'Full' release contains one entry for every concept that has ever been released and new content added for that release.
Column | Data Type | Length | Description |
|---|---|---|---|
tm_code | String | 7 | Unique meaningless Therapeutic Moiety identifier. |
tm_formal_name | String | 500 | The unambiguous description of the Therapeutic Moiety that includes details necessary to distinguish it from other similar concepts. |
tm_fr_description | String | 500 | The French description of the Therapeutic Moiety formal name. |
tm_status | String | 8 | The lifecycle state for the product. Allowable values for status are “Active”, “Inactive” and "Deprec" (deprecated). |
tm_status_effective_time | String (Date) | 8 | The date of the tm_status in this file has been inferred based on the Manufactured Products associated with the tm. Format = YYYYMMDD |
Manufactured Product Full Release;
(FILE NAME; mp_full_release_yyyymmdd)
The representation of a brand specific drug that is available for prescribing and dispensing in Canada. The 'Full' release contains one entry for every concept that has ever been released and new content added for that release.
Column | Data Type | Length | Description |
|---|---|---|---|
mp_code | String | 8 | The unique Manufactured Product identifier, that may be a Health Canada assigned DIN or NPN, or an identifier specific to the Canadian Clinical Drug Data Set. |
mp_formal_name | String | 500 | The unambiguous description of the Manufactured Product that includes details necessary to distinguish it from other similar concepts. |
mp_en_description | String | 500 | The user-friendly English description that may be used for web applications or the user interface for any system. NB: Not present in the files currently. |
mp_fr_description | String | 500 | The French description of the Manufactured Product formal name. |
mp_status | String | 8 | The lifecycle state for the product. Allowable values for status are “Active”, “Inactive” and "Deprec" (deprecated). |
mp_status_effective_time | String (Date) | 8 | The date of the mp_status in this file is based on the underlying regulatory status data in the DPD. Format = YYYYMMDD |
mp_type | String | 8 | The mp_type distinguishes whether the MP code corresponds to the DPD medicinal product (DIN) identifier, the natural health product (NPN) identifier or is a code created for the CCDD. Allowable values for mp_type are “DIN”, “NPN”, and “CCDD”. |
Health_Canada_ identifier | String | 8 | The DIN or NPN identifier assigned to an authorized medicinal product by Health Canada. |
Health_Canada_product_name | String | 200 | The product name (as present in the DPD or Licensed Natural Health Products Database (LNHPD) approved by Health Canada, under which the drug product may be marketed. |
Manufactured Product, Non-proprietary Therapeutic Product, Therapeutic Moiety Relationship;
(FILE NAME; mp_ntp_tm_relationship_yyyymmdd)
Each row represents the relationship between an MP and its NTP, and its TM (where one exists). It will include both active and inactive content from the full release files for the MP, NTP and TM. It will not include deprecated content. As well as the mp_,ntp_ and tm_codes, it contains the mp, ntp_ and tm_formal names.
Column | Data Type | Length | Description |
|---|---|---|---|
mp_code | String | 8 | The unique Manufactured Product identifier, that may be a Health Canada assigned DIN or NPN, or an identifier specific to the Canadian Clinical Drug Data Set. |
mp_formal_name | String | 500 | The unambiguous description of the Manufactured Product that includes details necessary to distinguish it from other similar concepts. |
ntp_code | String | 7 | Unique meaningless Non-proprietary Therapeutic Product identifier. |
ntp_formal_name | String | 500 | The unambiguous description of the Non-proprietary Therapeutic Product that includes details necessary to distinguish it from other similar concepts. |
tm_code | String | 7 | Unique meaningless Therapeutic Moiety identifier. |
tm_formal_name | String | 500 | The unambiguous description of the Therapeutic Moiety that includes details necessary to distinguish it from other similar concepts. |
Manufactured Product, Non-proprietary Therapeutic Product, Therapeutic Moiety Relationship with French descriptions;
(FILE NAME; mp_ntp_tm_relationship_fr_yyyymmdd)
Each row represents the relationship between an MP and its NTP, and its TM (where one exists). It will include both active and inactive content with mp_, ntp_and tm_codes and French descriptions from the full release files for the MP, NTP and TM. It will not include deprecated content.
Column | Data Type | Length | Description |
|---|---|---|---|
mp_code | String | 8 | The unique Manufactured Product identifier, that may be a Health Canada assigned DIN or NPN, or an identifier specific to the Canadian Clinical Drug Data Set. |
mp_fr_description | String | 500 | The French description of the Manufactured Product formal name. |
ntp_code | String | 7 | Unique meaningless Non-proprietary Therapeutic Product identifier. |
ntp_fr_description | String | 500 | The French description of the Non-proprietary Therapeutic Product formal name. |
tm_code | String | 7 | Unique meaningless Therapeutic Moiety identifier. |
tm_fr_description | String | 500 | The French description of the Therapeutic Moiety formal name. |
Device Non-proprietary Therapeutic Product Full Release;
(FILE NAME; device-ntp_full_release_yyyymmdd)
A brand independent and clinically oriented representation of a healthcare device. The 'Full' release contains one entry for every concept that has ever been released and new content added for that release.
Column | Data Type | Length | Description |
|---|---|---|---|
device_ntp_code | String | 7 | Unique meaningless Device Non-proprietary Therapeutic Product identifier. |
device_ntp_formal_name | String | 500 | The unambiguous description of the Device Non-proprietary Therapeutic Product that includes details necessary to distinguish it from other similar concepts. |
device_ntp_en_description | String | 500 | The user-friendly English description that may be used for web applications or the user interface for any system. NB: Not present in the files currently. |
device_ntp_fr_description | String | 500 | The French description of the Device Non-proprietary Therapeutic Product formal name. |
device_ntp_status | String | 8 | The lifecycle status for the concept in this file. Allowable values for status are “Active”, “Inactive” and "Deprec" (deprecated). |
device_ntp_status_effective_time | String (Date) | 8 | The date of the status in this file. Format = YYYYMMDD. |
Special Groupings;
(FILE NAME; special_groupings_yyyymmdd)
This file identifies and provides relationships between concepts in the Canadian Clinical Drug Data Set (CCDD) and policies that apply to those products.
The file also provides information about the status of that relationship, so that historic information can be maintained (e.g., for a product whose policy information has changed over time).
Column | Data Type | Length | Description |
|---|---|---|---|
ccdd_code | String | 8 | Unique meaningless identifier for a concept within the Canadian Clinical Drug Data Set. This may be a tm_code, an ntp_code or an mp_code. |
ccdd_formal_name | String | 500 | The unambiguous description of the concept within the Canadian Clinical Drug Data Set. This may be a tm_formal_name, an ntp_formal_name or an mp_formal_name. |
ccdd_type | String | 15 | The identification of the specific Canadian Clinical Drug Data Set concept type (either MP, NTP or TM). |
policy_type | String | 250 | A code representing the policy that the concept described in ccdd_code is controlled by. The detail of the code can be found in the coded_attributes file. |
policy_reference | String | 250 | A reference to further information about the policy. This reference may be a url. |
special_groupings_status | String | 8 | The lifecycle status of the relationship between the concept described in ccdd_code and the policy described in policy_type. Allowable values for this status are "Active" and "Inactive". |
special_groupings_status_effective_time | String (Date) | 8 | For “Active” status entries, this is the date that the information became present in this file. For “Inactive” status entries, this is the date that the policy information in this file is no longer applicable. Format = YYYYMMDD. |
Coded Attribute;
(FILE NAME; coded_attribute_yyyymmdd)
This file provides the coded values used in an attribute field within the CCDD.
Column | Data Type | Length | Description |
|---|---|---|---|
attribute | String | 50 | The name of the specific coded attribute from the CCDD file type. |
attribute_code | String | 8 | Unique identifier for an attribute value within the Clinical Drug Data Set. |
attribute_value | String | 500 | Unambiguous description of an attribute within Clinical Drug Data Set. |
fr_attribute_value | String | 500 | The French description of the CCDD Attribute Value. In the event a French description is not available, the value will be “NA”. |
CCDD_file_type | String | 200 | The name of the specific CCDD file type the attribute is from. |
attribute_ status | String | 8 | The lifecycle status for the concept in this file. Allowable values for status are “Active”, “Inactive” and "Deprec" (deprecated ). |
attribute_ status_effective_time | String (Date) | 8 | The date of the status in this file. Format = YYYYMMDD. |
CCDD Delta Release Files
Non-proprietary Therapeutic Product Delta Release;
(FILE NAME; ntp_ delta_release_yyyymmdd)
A representation of the changes from the previous released version of the ntp_full_release. Only the NTP concepts that have changed will be provided in this file. The “Delta' release contains only those concepts that have been added or changed since the previous release.
Column | Data Type | Length | Description |
|---|---|---|---|
ntp_code | String | 7 | Unique meaningless Non-proprietary Therapeutic Product identifier. |
ntp_formal_name | String | 500 | The unambiguous description of the Non-proprietary Therapeutic Product that includes details necessary to distinguish it from other similar concepts. |
ntp_en_description | String | 500 | The user-friendly English description that may be used for web applications or the user interface for any system. NB: Not present in the files currently. |
ntp_fr_description | String | 500 | The French description of the Non-proprietary Therapeutic Product formal name. |
ntp_status | String | 8 | The lifecycle state for the product. Allowable values for status are “Active”, “Inactive” and "Deprec" (deprecated). |
ntp_status_effective_time | String (Date) | 8 | The date of the ntp_status in this file has been inferred based on the Manufactured Products associated with the ntp. Format = YYYYMMDD |
ntp_type | String | 8 | This attribute is used to differentiate combination products. Values = "Comb" (for Combination product) or "NA". |
change_type | String | 10 | This attribute provides the types of change applied to any aspect of the concept or applicable attributes. The types of change include “added” or “changed” |
Therapeutic Moiety Delta Release;
(FILE NAME; tm_delta_release_yyyymmdd)
A representation of the changes from the previous released version of the tm_full_release. Only the TM concepts that have changed will be provided in this file. The “Delta' release contains only those concepts that have been added or changed since the previous release.
Column | Data Type | Length | Description |
|---|---|---|---|
tm_code | String | 7 | Unique meaningless Therapeutic Moiety identifier. |
tm_formal_name | String | 500 | The unambiguous description of the Therapeutic Moiety that includes details necessary to distinguish it from other similar concepts. |
tm_fr_description | String | 500 | The French description of the Therapeutic Moiety formal name. |
tm_status | String | 8 | The lifecycle state for the product. Allowable values for status are “Active”, “Inactive” and "Deprec" (deprecated). |
tm_status_effective_time | String (Date) | 8 | The date of the tm_status in this file has been inferred based on the Manufactured Products associated with the tm. Format = YYYYMMDD |
change_type | String | 10 | This attribute provides the types of change applied to any aspect of the concept or applicable attributes. The types of change include “added” or “changed” |
Manufactured Product Delta Release;
(FILE NAME; mp_delta_release_yyyymmdd)
A representation of the changes from the previous released version of the mp_full_release. Only the MP concepts that have changed will be provided in this file. The “Delta' release contains only those concepts that have been added or changed since the previous release.
Column | Data Type | Length | Description |
|---|---|---|---|
mp_code | String | 8 | The unique Manufactured Product identifier, that may be a Health Canada assigned DIN or NPN, or an identifier specific to the Canadian Clinical Drug Data Set. |
mp_formal_name | String | 500 | The unambiguous description of the Manufactured Product that includes details necessary to distinguish it from other similar concepts. |
mp_en_description | String | 500 | The user-friendly English description that may be used for web applications or the user interface for any system. NB: Not present in the files currently. |
mp_fr_description | String | 500 | The French description of the Manufactured Product formal name. |
mp_status | String | 8 | The lifecycle state for the product. Allowable values for status are “Active”, “Inactive” and "Deprec" (deprecated). |
mp_status_effective_time | String (Date) | 8 | The date of the mp_status in this file is based on the underlying regulatory status data in the DPD. Format = YYYYMMDD |
change_type | String | 10 | This attribute provides the types of change applied to any aspect of the concept or applicable attributes. The types of change include “added” or “changed” |
Device Non-proprietary Therapeutic Product Delta Release;
(FILE NAME; device-ntp_delta_release_yyyymmdd)
A representation of the changes from the previous released version of the Device-ntp_full_release. Only the Device-NTP concepts that have changed will be provided in this file. The “Delta' release contains only those concepts that have been added or changed since the previous release.
Column | Data Type | Length | Description |
device_ntp_code | String | 7 | Unique meaningless Device Non-proprietary Therapeutic Product identifier |
device_ntp_formal_name | String | 500 | The unambiguous description of the Device Non-proprietary Therapeutic Product that includes details necessary to distinguish it from other similar concepts. |
device_ntp_en_description | String | 500 | The user-friendly English description that may be used for web applications or the user interface for any system. NB: Not present in the files currently. |
device_ntp_fr_description | String | 500 | The French description of the Device Non-proprietary Therapeutic Product formal name. |
device_ntp_status | String | 8 | The lifecycle status for the concept in this file. Allowable values for status are “Active”, “Inactive” and "Deprec" (deprecated). |
device_ntp_status_effective_time | String (Date) | 8 | The date of the status in this file. Format = YYYYMMDD. |
change_type | String | 10 | This attribute provides the types of change applied to any aspect of the concept or applicable attributes. The types of change include “added” or “changed” |