This appendix describes sample and practice dictionary definitions in Oracle Thesaurus Management System (TMS) that correspond to the sample load scripts available on My Oracle Support as Sample Maintenance Scripts for MedDRA, MedDRA Primary Path, MedDRA SMQ, WHODrug Formats B, B2, B3, C and C3, and SNOMED (article ID 258975.1) and TMS CLASS Dictionary Loading Scripts (article ID 428204.1). For further details, see Chapter 6, "Defining and Loading Dictionaries".
This appendix includes:
Note:
The short names of the dictionary levels and of the dictionary itself must be exactly the same in the load script and in the dictionary definition in the TMS user interface.The dictionary definition and loading process is complex, and varies depending on the dictionary and the needs of the company. You can use CLS as a practice dictionary. All the control, data, and SQL files you need are provided in a zip file on the My Oracle Support website. You can use these files as examples when you create your own dictionaries.
The CLS structure diagram in Figure A-1 corresponds to the Level Definitions in "CLS Level Definitions" and Level Relations Definitions in "CLS Level Relations Definitions".
See "Defining the Dictionary Levels" for instructions on defining dictionary levels using the Define Dictionaries window in TMS.
Short Name | Name | Classification Level? | Report Value? | Level Order | Level Type | Term Unique? | Group Short Name |
---|---|---|---|---|---|---|---|
ATC |
Anatomical-Therapeutic- |
Group Level |
|||||
ATC1 |
ATC 1 |
X |
Level |
ATC |
|||
ATC2 |
ATC 2 |
X |
Level |
ATC |
|||
ATC3 |
ATC 3 |
X |
Level |
ATC |
|||
ATC4 |
ATC 4 |
X |
Level |
ATC |
|||
VTC |
Verbatim Term Classification Group |
X |
Group Level |
X |
|||
PN |
Preferred Name |
X |
Level |
VTC |
|||
SYN |
Synonym |
X |
1 |
Level |
VTC |
||
BNA |
Drug Constituents |
2 |
Level |
||||
DDSRC |
Source of Drug |
1 |
Level |
||||
MAN |
Manufacturers |
2 |
Level |
See "Defining Relations Between Levels (Strong Dictionaries Only)" for instructions on defining Level Relations in the Define Dictionaries window.
Setting | Parent Level | Child Level |
---|---|---|
Level Name |
Anatomical-Therapeutic-Chemical- |
ATC 1 |
Relation Type: Top Sublevel |
||
Short Name |
ATC |
ATC1 |
Mandatory? |
||
Many Cardinality? |
||
Primary Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
ATC 1 |
ATC 2 |
Relation Type: Level |
||
Short Name |
ATC1 |
ATC2 |
Mandatory? |
X |
|
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
ATC 2 |
ATC 3 |
Relation Type: Level |
||
Short Name |
ATC2 |
ATC3 |
Mandatory? |
X |
|
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
ATC 3 |
ATC 4 |
Relation Type: Level |
||
Short Name |
ATC3 |
ATC4 |
Mandatory? |
X |
|
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
Anat.-Therap.-Chem.-Classification Group |
Preferred Name |
Relation Type: Level |
||
Short Name |
ATC |
PN |
Mandatory? |
||
Many Cardinality? |
X |
X |
Primary Link? |
X |
n/a |
Derivable? |
X |
n/a |
Level Name |
Preferred Name |
Synonym |
Relation Type: Level |
||
Short Name |
PN |
SYN |
Mandatory? |
X |
|
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
Preferred Name |
Drug Constituents |
Relation Type: Level |
||
Short Name |
PN |
BNA |
Mandatory? |
||
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Drug Constituents |
Source of Drug |
Relation Type: Level |
||
Short Name |
BNA |
DDSRC |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Verbatim Term Classification Group |
Preferred Name |
Relation Type: Top Sublevel |
||
Short Name |
VTC |
PN |
Mandatory? |
||
Many Cardinality? |
||
Primary Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Verbatim Term Classification Group |
Manufacturers |
Relation Type: Level |
||
Short Name |
VTC |
MAN |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Verbatim Term Classification Group |
Source of Drug |
Relation Type: Level |
||
Short Name |
VTC |
DDSRC |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Derivable? |
n/a |
This section provides a structure diagram of the sample MedDRA dictionary, and the dictionary level and level relations definitions that are required to create a dictionary with this structure.
The sample MedDRA dictionary structure in Figure A-2 corresponds to the definitions provided in "Sample MedDRA Dictionary Level Definitions" and "Sample MedDRA Dictionary Level Relations Definitions".
Figure A-2 Sample MedDRA Dictionary Structure
See "Defining the Dictionary Levels" for instructions on defining dictionary levels using the Define Dictionaries window in TMS.
See "Defining Relations Between Levels (Strong Dictionaries Only)" for instructions on defining Level Relations in the Define Dictionaries window.
Setting | Parent Level | Child Level |
---|---|---|
Level Name |
System Organ Class |
High Level Group Term |
Relation Type: Level |
||
Short Name |
SOC |
HLGT |
Mandatory? |
X |
X |
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
High Level Group Term |
High Level Term |
Relation Type: Level |
||
Short Name |
HLGT |
HLT |
Mandatory? |
X |
X |
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
High Level Term |
Preferred Term |
Relation Type: Level |
||
Short Name |
HLT |
PT |
Mandatory? |
X |
X |
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Preferred Term |
Lowest Level Term |
Relation Type: Level |
||
Short Name |
PT |
LLT |
Mandatory? |
X |
X |
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
System Organ Class |
Preferred Term |
Relation Type: Level |
||
Short Name |
SOC |
PT |
Mandatory? |
X |
X |
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
Preferred Term |
Special Category |
Relation Type: Level |
||
Short Name |
PT |
SC |
Mandatory? |
||
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
This section provides a structure diagram of the sample MedDRA dictionary with a primary path, and the dictionary level and level relations definitions that are required to create a dictionary with this structure.
Sample MedDRA Dictionary with a Primary Path Dictionary Level Definitions
Sample MedDRA Dictionary with a Primary Path Level Relations Definitions
The sample MedDRA dictionary structure in Figure A-3 corresponds to the definitions provided in "Sample MedDRA Dictionary with a Primary Path Dictionary Level Definitions" and "Sample MedDRA Dictionary with a Primary Path Level Relations Definitions".
Figure A-3 Sample MedDRA Dictionary with Primary Path Structure
See "Defining the Dictionary Levels" for instructions on defining dictionary levels using the Define Dictionaries window in TMS.
Table A-5 Sample MedDRA Dictionary with Primary Path Dictionary Level Definitions
Short Name | Name | Classifica-tion Level? | Report Value | Level Order | Level Type | Term Unique? | Group Short Name |
---|---|---|---|---|---|---|---|
PPG |
Primary Path Group |
0 |
Group Level |
None |
|||
SOC |
System Organ Class |
X |
0 |
Level |
Level |
PPG |
|
HLGT |
High Level Group Term |
X |
0 |
Level |
Level |
PPG |
|
HLT |
High Level Term |
X |
0 |
Level |
Level |
PPG |
|
CODING |
Verbatim Coding Group |
X |
0 |
Group Level |
Level |
||
PT |
Preferred Term |
X |
100 |
Level |
None |
CODING |
|
LLT |
Lowest Level Term |
X |
0 |
Level |
None |
CODING |
|
VT |
Verbatim Term |
500 |
Verbatim Level |
Level |
See "Defining Relations Between Levels (Strong Dictionaries Only)" for instructions on defining Level Relations in the Define Dictionaries window.
Table A-6 Sample MedDRA Dictionary with Primary Path Level Relations
Setting | Parent Level | Child Level |
---|---|---|
Level Name |
Primary Path Group |
System Organ Class |
Relation Type: Top SubLevel |
||
Short Name |
PPG |
PPG |
Mandatory? |
||
Many Cardinality? |
||
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
System Organ Class |
High Level Group Term |
Relation Type: Level |
||
Short Name |
SOC |
PPG |
Mandatory? |
X |
X |
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
High Level Group Term |
High Level Term |
Relation Type: Level |
||
Short Name |
HLGT |
HLT |
Mandatory? |
X |
X |
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
High Level Term |
Preferred Term |
Relation Type: Level |
||
Short Name |
HLT |
PT |
Mandatory? |
X |
X |
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Preferred Term |
Lowest Level Term |
Relation Type: Level |
||
Short Name |
PT |
LLT |
Mandatory? |
X |
|
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
Primary Path Group |
Preferred Term |
Relation Type: Level |
||
Short Name |
PPG |
PT |
Mandatory? |
X |
X |
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Primary Path Link? |
X |
n/a |
Derivable? |
X |
n/a |
Level Name |
High Level Term |
Preferred Term |
Relation Type: Level |
||
Short Name |
HLT |
PT |
Mandatory? |
X |
X |
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Verbatim Coding Group |
Preferred Term |
Relation Type: Level |
||
Short Name |
CODING |
PT |
Mandatory? |
||
Many Cardinality? |
||
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Verbatim Coding Group |
Verbatim Term |
Relation Type: Top SubLevel |
||
Short Name |
CODING |
SC |
Mandatory? |
X |
|
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
X |
n/a |
This section provides a structure diagram of the sample MedDRA SMQ dictionary, and the dictionary level and level relations definitions that are required to create a dictionary with this structure.
The sample MedDRA dictionary structure in Figure A-4 corresponds to the definitions provided in "Sample MedDRA SMQ Dictionary Level Definitions" and "Sample MedDRA SMQ Dictionary Level Relation Definitions".
Term Uniqueness Enforced? is set to N (unchecked) at the dictionary level.
Figure A-4 Sample MedDRA SMQ Dictionary Structure
The following table provides the Level Definitions for the sample MedDRA SMQ dictionary. See "Defining the Dictionary Levels" for instructions on defining dictionary levels using the Define Dictionaries window in TMS.
Table A-7 Sample MedDRA SMQ Dictionary Level Definitions
Short Name | Name | Classifica-tion Level? | Report Value | Level Order | Level Type | Term Unique? | Group Short Name |
---|---|---|---|---|---|---|---|
SMQ1 |
SMQ Level 1 |
0 |
Level |
None |
|||
SMQ2 |
SMQ Level 2 |
0 |
Level |
None |
|||
SMQ3 |
SMQ Level 3 |
0 |
Level |
None |
|||
SMQ4 |
SMQ Level 4 |
0 |
Level |
None |
|||
SMQ5 |
SMQ Level 5 |
0 |
Level |
None |
The following table provides the Level Relations Definitions for the sample MedDRA SMQ dictionary. See "Defining Relations Between Levels (Strong Dictionaries Only)" for instructions on defining Level Relations in the Define Dictionaries window.
Table A-8 Sample MedDRA SMQ Dictionary Level Relation Definitions
Setting | Parent Level | Child Level |
---|---|---|
Level Name |
SMQ Level 1 |
SMQ Level 2 |
Relation Type: Level |
||
Short Name |
SMQ1 |
SMQ2 |
Mandatory? |
||
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
SMQ Level 2 |
SMQ Level 3 |
Relation Type: Level |
||
Short Name |
SMQ2 |
SMQ3 |
Mandatory? |
||
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
SMQ Level 3 |
SMQ Level 4 |
Relation Type: Level |
||
Short Name |
SMQ3 |
SMQ4 |
Mandatory? |
||
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
SMQ Level 4 |
SMQ Level 5 |
Relation Type: Level |
||
Short Name |
SMQ4 |
SMQ5 |
Mandatory? |
||
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
This section provides a structural diagram of the sample WHODrug format B2 dictionary, and the dictionary level and Level Relations Definitions that are required to create a dictionary with this structure.
This dictionary is the same as CLS except that no Primary Link is defined between the ATC Group level and the Preferred Name level, and therefore you cannot derive terms from any of the sublevels within the ATC Group.
The sample WHODrug format B2 dictionary structure in Figure A-5 corresponds to the definitions provided in "Sample WHODrug Format B2 Dictionary Level Definitions" and "Sample WHODrug Format B2 Dictionary Level Relations Definitions".
Figure A-5 Sample WHODrug Dictionary Structure
See "Defining the Dictionary Levels" for instructions on defining dictionary levels using the Define Dictionaries window in TMS.
Table A-9 Sample WHODrug B2 Dictionary Level Definitions
Short Name | Name | Classifica-tion Level? | Report Value? | Level Order | Level Type | Term Unique? | Group Short Name |
---|---|---|---|---|---|---|---|
ATC |
Anatomical-Therapeutic-Chemical Classification Group |
Group Level |
None |
||||
ATC1 |
ATC Level One |
X |
Level |
None |
ATC |
||
ATC2 |
ATC Level Two |
X |
Level |
None |
ATC |
||
ATC3 |
ATC Level Three |
X |
Level |
None |
ATC |
||
ATC4 |
ATC Level Four |
X |
Level |
None |
ATC |
||
VTC |
Verbatim Coding Group |
X |
Group Level |
Level |
|||
PN |
Preferred Name |
X |
Level |
None |
VTC |
||
SYN |
Synonym |
X |
1 |
Level |
None |
VTC |
|
BNA |
Drug Constituents |
2 |
Level |
None |
|||
DDSRC |
Source of Drug Information |
1 |
Level |
None |
|||
MAN |
Manufacturers |
2 |
Level |
None |
See "Defining Relations Between Levels (Strong Dictionaries Only)" for instructions on defining Level Relations in the Define Dictionaries window.
Table A-10 Sample WHODrug B2 Dictionary Level Relations Definitions
Setting | Parent Level | Child Level |
---|---|---|
Level Name |
Anatomical-Therapeutic-Chemical- |
ATC Level One |
Relation Type: Top Sublevel |
||
Short Name |
ATC |
ATC1 |
Mandatory? |
||
Many Cardinality? |
||
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
X |
|
Level Name |
ATC Level One |
ATC Level Two |
Relation Type: Level |
||
Short Name |
ATC1 |
ATC2 |
Mandatory? |
X |
|
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
ATC Level Two |
ATC Level Three |
Relation Type: Level |
||
Short Name |
ATC2 |
ATC3 |
Mandatory? |
X |
|
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
ATC Level Three |
ATC Level Four |
Relation Type: Level |
||
Short Name |
ATC3 |
ATC4 |
Mandatory? |
X |
|
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
Anat.-Therap.-Chem.-Classification Group |
Preferred Name |
Relation Type: Level |
||
Short Name |
ATC |
PN |
Mandatory? |
||
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
Preferred Name |
Synonym |
Relation Type: Level |
||
Short Name |
PN |
SYN |
Mandatory? |
X |
|
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Missing Primary Path Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
Preferred Name |
Drug Constituents |
Relation Type: Level |
||
Short Name |
PN |
BNA |
Mandatory? |
||
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Derivable? |
n/a |
|
Primary Path Link? |
n/a |
|
Level Name |
Drug Constituents |
Source of Drug |
Relation Type: Level |
||
Short Name |
BNA |
DDSRC |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Verbatim Term Classification Group |
Preferred Name |
Relation Type: Top Sublevel |
||
Short Name |
VTC |
PN |
Mandatory? |
||
Many Cardinality? |
||
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Verbatim Term Classification Group |
Manufacturers |
Relation Type: Level |
||
Short Name |
VTC |
MAN |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Verbatim Term Classification Group |
Source of Drug |
Relation Type: Level |
||
Short Name |
VTC |
DDSRC |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
This section provides a structural diagram of the sample WHODrug format B3 dictionary, and the dictionary level and Level Relations Definitions that are required to create a dictionary with this structure.
The sample WHODrug format B3 dictionary structure in Figure A-6 corresponds to the definitions provided in Sample WHODrug Format B3 Dictionary Level Definitions and Sample WHODrug Format B3 Dictionary Level Relations Definitions.
Figure A-6 Sample WHODrug B3 Dictionary Structure
See "Defining the Dictionary Levels" for instructions on defining dictionary levels using the Define Dictionaries window in TMS.
Table A-11 Sample WHODrug B3 Dictionary Level Definitions
Short Name | Name | Classification Level? | Report Value? | Level Order | Level Type | Term Unique? | Group Short Name |
---|---|---|---|---|---|---|---|
ATC |
Anatomical-Therapeutic-Chemical Classification Group |
Group Level |
None |
||||
ATC1 |
ATC Level One |
X |
Level |
None |
ATC |
||
ATC2 |
ATC Level Two |
X |
Level |
None |
ATC |
||
ATC3 |
ATC Level Three |
X |
Level |
None |
ATC |
||
ATC4 |
ATC Level Four |
X |
Level |
None |
ATC |
||
PN |
Preferred Name |
X |
10 |
Level |
None |
||
SYN |
Synonym |
X |
X |
Level |
Level |
||
BNA |
Drug Constituents |
10 |
Level |
None |
|||
DDSRC |
Source of Drug Information |
30 |
Level |
None |
|||
MAN |
Manufacturers |
10 |
Level |
None |
See "Defining Relations Between Levels (Strong Dictionaries Only)" for instructions on defining Level Relations in the Define Dictionaries window.
Table A-12 Sample WHODrug B3 Dictionary Level Relations Definitions
Setting | Parent Level | Child Level |
---|---|---|
Level Name |
Anatomical-Therapeutic-Chemical |
ATC Level One |
Relation Type: Top Sublevel |
||
Short Name |
ATC |
ATC1 |
Mandatory? |
||
Many Cardinality? |
||
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
ATC Level One |
ATC Level Two |
Relation Type: Level |
||
Short Name |
ATC1 |
ATC2 |
Mandatory? |
X |
|
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
ATC Level Two |
ATC Level Three |
Relation Type: Level |
||
Short Name |
ATC2 |
ATC3 |
Mandatory? |
X |
|
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
ATC Level Three |
ATC Level Four |
Relation Type: Level |
||
Short Name |
ATC3 |
ATC4 |
Mandatory? |
X |
|
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
Anatomical-Therapeutic-Chemical Classification Group |
Preferred Name |
Relation Type: Level |
||
Short Name |
ATC |
PN |
Mandatory? |
||
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
Preferred Name |
Synonym |
Relation Type: Level |
||
Short Name |
PN |
SYN |
Mandatory? |
X |
|
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Missing Primary Path Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
Synonym |
Manufacturers |
Relation Type: Level |
||
Short Name |
SYN |
MAN |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Missing Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Synonym |
Source of Drug Information |
Relation Type: Level |
||
Short Name |
SYN |
DDSRC |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Missing Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Preferred Name |
Drug Constituents |
Relation Type: Level |
||
Short Name |
PN |
BNA |
Mandatory? |
||
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Derivable? |
n/a |
|
Primary Path Link? |
n/a |
|
Level Name |
Drug Constituents |
Source of Drug Information |
Relation Type: Level |
||
Short Name |
BNA |
DDSRC |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Preferred Name |
Source of Drug Information |
Relation Type: Level |
||
Short Name |
PN |
DDSRC |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Derivable? |
n/a |
|
Primary Path Link? |
n/a |
This section provides a structural diagram of the sample WHODrug format C dictionary, and the dictionary level and Level Relations Definitions that are required to create a dictionary with this structure.
Sample WHODrug Dictionary with Format C or C3 Level Definitions
Sample WHODrug Dictionary with Format C or C3 Level Relations Definitions
The sample WHODrug dictionary structure in Figure A-5 corresponds to the definitions provided in Sample WHODrug Dictionary with Format C or C3 Level Definitions and Sample WHODrug Dictionary with Format C or C3 Level Relations Definitions.
See "Defining the Dictionary Levels" for instructions on defining dictionary levels using the Define Dictionaries window in TMS.
Table A-13 Sample WHODrug C or C3 Dictionary Level Definitions
Short Name | Name | Classifi-cation Level? | Report Value? | Level Order | Level Type | Term Unique? | Group Short Name |
---|---|---|---|---|---|---|---|
ATC |
Anatomical-Therapeutic-Chemical Classification Group |
0 |
Group Level |
None |
|||
ATC1 |
ATC 1 |
X |
0 |
Level |
None |
ATC |
|
ATC2 |
ATC 2 |
X |
0 |
Level |
None |
ATC |
|
ATC3 |
ATC 3 |
X |
0 |
Level |
None |
ATC |
|
ATC4 |
ATC 4 |
X |
0 |
Level |
None |
ATC |
|
MP |
Medicinal Product Group |
X |
Group Level |
None |
|||
PN |
Preferred Name |
X |
10 |
Level |
None |
MP |
|
SYN |
Synonym |
X |
0 |
Level |
None |
MP |
|
PF |
Pharmaceutical Form |
20 |
Level |
None |
|||
STR |
Strength |
30 |
Level |
None |
|||
NS |
Name Specifier |
40 |
Level |
None |
|||
COUNTRY |
Country |
50 |
Level |
None |
|||
MAH |
Marketing Authorization Holder |
60 |
Level |
None |
|||
ING |
Ingredient |
70 |
Level |
None |
|||
INGSRC |
Ingredient Reference |
0 |
Level |
None |
|||
MPSRC |
Reference |
80 |
Level |
None |
|||
SRCCOUNTRY |
Source Country |
90 |
Level |
None |
|||
COM |
Company |
100 |
Level |
None |
|||
PRT |
Product Type |
110 |
Level |
None |
|||
PRG |
Product Group |
120 |
Level |
None |
See "Defining Relations Between Levels (Strong Dictionaries Only)" for instructions on defining Level Relations in the Define Dictionaries window.
Table A-14 Sample WHODrug Dictionary Format C or C3 Level Relations Definitions
Setting | Parent Level | Child Level |
---|---|---|
Level Name |
Anatomical-Therapeutic-Chemical- |
ATC 1 |
Relation Type: Top Sublevel |
||
Short Name |
ATC |
ATC1 |
Mandatory? |
||
Many Cardinality? |
||
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
ATC 1 |
ATC 2 |
Relation Type: Level |
||
Short Name |
ATC1 |
ATC2 |
Mandatory? |
X |
|
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
ATC 2 |
ATC 3 |
Relation Type: Level |
||
Short Name |
ATC2 |
ATC3 |
Mandatory? |
X |
|
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
ATC 3 |
ATC 4 |
Relation Type: Level |
||
Short Name |
ATC3 |
ATC4 |
Mandatory? |
X |
|
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
Anat.-Therap.-Chem.-Classification Group |
Preferred Name |
Relation Type: Level |
||
Short Name |
ATC |
PN |
Mandatory? |
X |
|
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
Preferred Name |
Synonym |
Relation Type: Level |
||
Short Name |
PN |
SYN |
Mandatory? |
X |
|
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Derivable? |
X |
n/a |
Level Name |
Medicinal Product Group |
Preferred Name |
Relation Type: Level |
||
Short Name |
MP |
PN |
Mandatory? |
||
Many Cardinality? |
||
Primary Link? |
n/a |
|
Derivable? |
n/a |
|
Primary Path Link? |
n/a |
|
Level Name |
Medicinal Product Group |
Pharmaceutical Form |
Relation Type: Top Sublevel |
||
Short Name |
MP |
PF |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Medicinal Product Group |
Strength |
Relation Type: Level |
||
Short Name |
MP |
STR |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Medicinal Product Group |
Name Specifier |
Relation Type: Level |
||
Short Name |
MP |
NS |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Medicinal Product Group |
Country |
Relation Type: Level |
||
Short Name |
MP |
COUNTRY |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Medicinal Product Group |
Marketing Authorization Holder |
Relation Type: Level |
||
Short Name |
MP |
MAH |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Medicinal Product Group |
Ingredient |
Relation Type: Level |
||
Short Name |
MP |
ING |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Ingredient |
Ingredient Reference |
Relation Type: Level |
||
Short Name |
ING |
INGSRC |
Mandatory? |
||
Many Cardinality? |
X |
X |
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Medicinal Product Group |
Reference |
Relation Type: Level |
||
Short Name |
MP |
MPSRC |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Medicinal Product Group |
Source Country |
Relation Type: Level |
||
Short Name |
MP |
SRCCOUNTRY |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Medicinal Product Group |
Company |
Relation Type: Level |
||
Short Name |
MP |
COM |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Medicinal Product Group |
Product Type |
Relation Type: Level |
||
Short Name |
MP |
PRT |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
|
Level Name |
Medicinal Product Group |
Product Group |
Relation Type: Level |
||
Short Name |
MP |
PRG |
Mandatory? |
||
Many Cardinality? |
X |
|
Primary Link? |
n/a |
|
Primary Path Link? |
n/a |
|
Derivable? |
n/a |
Some WHODrug Format C tables, which are loaded into TMS as dictionary levels, contain too many attributes, or columns, to fit into tables tms_dict_contents and tms_dict_relations. In these cases the sample scripts load certain column data as Informative Notes associated with terms that have data in the column.
All mappings are detailed in the sample script code.
Table A-15 WHODrug C or C3 Data Handled as Informative Notes in TMS
WHODrug C Table/ TMS Dictionary Level | WHODrug C Table Column | Informative Note Attribute |
---|---|---|
Medicinal Product |
AUTHNUM |
Marketing Authorization Number |
Medicinal Product |
AUTHDATE |
Marketing Authorization Date |
Medicinal Product |
WITHDATE |
Marketing Auth Withdrawal Date |
Medicinal Product and Substance |
REFYEAR |
Year of Reference |
Medicinal Product and Ingredient |
CREATEDATE |
Create Date |
Medicinal Product |
CHGDATE |
Date Changed |
This section provides a structural diagram of the sample SNOMED dictionary, and the dictionary level and Level Relations Definitions that are required to create a dictionary with this structure.
The sample SNOMED dictionary structure in Figure A-8 corresponds to the definitions provided in "Sample SNOMED Dictionary Level Definitions" and "Sample SNOMED Dictionary Level Relations".
Figure A-8 Sample SNOMED Dictionary Structure
See "Defining the Dictionary Levels" for instructions on defining dictionary levels using the Define Dictionaries window in TMS.
See "Defining Relations Between Levels (Strong Dictionaries Only)" for instructions on defining Level Relations in the Define Dictionaries window.