CDISC CRT-DDS 1.0

Purpose

The CDISC CRT-DDS standard defines the metadata structures in a machine-readable XML format. These metadata structures are used to describe the CRT data sets and variables for regulatory submissions. The XML schema that is used to define the metadata structures in an XML format is based on an extension to the CDISC Operational Data Model (ODM).

Release Date

CDISC CRT-DDS, Final Version 1.0, February 10, 2005

Regulatory Basis

(Source: CDISC Case Report Tabulation Data Definition Specification)
In 1999, the FDA standardized the submission of clinical and non-clinical data and metadata in a set of eSubmission guidelines to include metadata descriptions of the data sets and columns within a Data Definition Document (define.pdf). In 2003, the FDA published a set of guidance documents on receiving electronic product applications per the International Conference on Harmonisation (ICH) electronic Common Technical Document (eCTD) specifications. In these specifications, the FDA expanded the acceptable file types to include the XML format.

CDISC CRT-DDS 1.0 Reference Standard

The domain and column metadata that constitute the SAS representation of CDISC CRT-DDS 1.0 are derived from the global standards library in these formats:
  • as empty data sets (using the utility macro cst_createTablesForDataStandard)
  • as table metadata for 39 data sets (reference_tables in the standard metadata folder (see the example in the following table))
  • as column metadata for 176 columns in the 39 data sets (reference_columns in the standard metadata folder (see the example in Sample Reference_Columns Record (CDISC CRT-DDS 1.0)))
Sample Reference_Tables Record (CDISC CRT-DDS 1.0)
Column Name
Column Value
sasref
REFDATA
table
ItemGroupDefs
label
keys
OID
standard
CDISC-CRTDDS
standardversion
1.0
standardref
comment
xmlelementname
ItemGroupDefs
class
ItemGroupDefs
qualifiers
Sample Reference_Columns Record (CDISC CRT-DDS 1.0)
Column Name
Column Value
sasref
REFDATA
table
DefineDocument
column
FileType
label
File type (Snapshot | Transactional)
order
5
type
C
length
13
displayformat
$13.
standard
CDISC-CRTDDS
standardversion
1.0
standardref
comment
core
Req
xmlcodelist
FILETYPE
qualifiers
As a general rule, the SAS representation of the CDISC CRT-DDS standard is patterned to match the XML element (data set) and attribute (column) structure of define.xml. For example, for CDISC SDTM, domain-level metadata is represented by a define.xml ItemGroupDef element. This metadata is captured in the ItemGroupDefs SAS data set. This is shown in the following code and table that represent the TE domain metadata:
<ItemGroupDef OID="docroot.IG.TE"
    Name="TE"
    Repeating="No"
    IsReferenceData="Yes"
    Purpose="Tabulation"
    def:Label="Trial Elements"
    def:Structure="One record per planned element"
    def:DomainKeys="STUDYID,ETCD"
    def:Class="Trial Design"
    def:ArchiveLocationID="ArchiveLocation.te">
    !-- All ItemRefs would be listed here -->
    <def:leaf ID="ArchiveLocation.te"
    xlink:href="te.xpt"> <def:title>te.xpt</def:title>
  </def:leaf>
</ItemGroupDef>
Sample Data Set Representation: ItemGroupDefs.sas7bdat
Column
Value
OID
docroot.IG.TE
Name
TE
Repeating
No
IsReferenceData
Yes
SASDatasetName
Domain
Origin
Role
Purpose
Tabulation
Comment
Label
Trial Elements
Class
Trial Design
Structure
One record per planned element
DomainKeys
STUDYID, ETCD
ArchiveLocationID
ArchiveLocation.te
FK_MetaDataVersion
Note: Empty or null attributes are not typically included in the XML file.
The following table lists the complete set of 39 tables that form the SAS Clinical Standards Toolkit SAS representation of the CDISC CRT-DDS 1.0 standard.
Data Sets in the SAS Representation of the CDISC CRT-DDS 1.0 Standard
Table
Table
AnnotatedCRFs
ItemQuestionTranslatedText
CLItemDecodeTranslatedText
ItemRangeCheckValues
CodeListItems
ItemRangeChecks
CodeLists
ItemRole
ComputationMethods
ItemValueListRefs
DefineDocument
MDVLeaf
ExternalCodeLists
MDVLeafTitles
FormDefArchLayouts
MUTranslatedText
FormDefItemGroupRefs
MeasurementUnits
FormDefs
MetaDataVersion
ImputationMethods
Presentation
ItemAliases
ProtocolEventRefs
ItemDefs
RCErrorTranslatedText
ItemGroupAliases
Study
ItemGroupDefItemRefs
StudyEventDefs
ItemGroupDefs
StudyEventFormRefs
ItemGroupLeaf
SupplementalDocs
ItemGroupLeafTitles
ValueListItemRefs
ItemMURefs
ValueLists
ItemQuestionExternal
The highly structured nature of CDISC CRT-DDS data requires that any mapping to a relational format include a large number of data sets, with foreign key relationships to help preserve the intended non-relational object structure. In the SAS Clinical Standards Toolkit, foreign key relationships are enforced when validating the CDISC CRT-DDS data sets.
Field lengths in the CDISC CRT-DDS data sets are consistent by core data type. CDISC has not specified any limit to the length of most character fields. Arbitrary lengths have been chosen by data type. These lengths are listed in the following table. In the table, standard data types are distilled into core data types. To be safe, larger lengths have been chosen to ensure that no data loss occurs in the SAS Clinical Standards Toolkit pre-installed data sets. Production tables might be compressed using SAS mechanisms to preserve disk space.
CDISC CRT-DDS Default Lengths by Data Type
Type Name
Length
Description
oid
128
A unique object identifier or a reference
text
2000
A character field that can accommodate a large number of characters
name
128
A descriptive identifier
value
512
An item of collected or reference data
path
512
An absolute or relative file system path or URL
The following table lists the data sets with member columns that form the CDISC CRT-DDS 1.0 data in the SAS Clinical Standards Toolkit.
No data set has more than one variable that acts as the key or index for that data set. The names of key variables are prepended with two asterisks (**). Some data sets do not have a key.
Foreign key variable names are prepended with two carat characters (^^). Foreign key variable names reference, in brackets [ ], the name of the data set for which it is a foreign key.
Required fields are marked with an X between brackets [X]. Required fields are fields for which a non-nil and non-whitespace-only value must be supplied in any observation for that data set.
Only the DefineDocument data set, which contains valid values for the FileOID and FileType variables, is needed to create a minimal, but valid CDISC CRT-DDS-compliant XML document. This is based on the CDISC CRT-DDS standard, which is very flexible.
All table and column names are case sensitive. They must be specified exactly as shown.
CDISC CRT-DDS SAS Table Construction
Data Set Name
Variable Name
SAS Data Type
Length (if char)
DefineDocument
**FileOID [X]
character
128 (oid)
Archival
character
3
AsOfDateTime
character
24
Description
character
2000 (text)
FileType [X]
character
13
Granularity
character
15
Id
character
128 (oid)
ODMVersion
character
2000 (text)
Originator
character
2000 (text)
PriorFileOID
character
128 (oid)
SourceSystem
character
2000 (text)
SourceSystemVersion
character
2000 (text)
Study
**OID [X]
character
128 (oid)
StudyName [X]
character
128 (name)
StudyDescription [X]
character
2000 (text)
ProtocolName [X]
character
128 (name)
^^FK_DefineDocument [DefineDocument] [X]
character
128 (oid)
MeasurementUnits
**OID [X]
character
128 (oid)
Name [X]
character
128 (name)
^^FK_Study [Study] [X]
character
128 (oid)
MUTranslatedText
TranslatedText
character
2000 (text)
lang
character
128 (name)
^^FK_MeasurementUnits [MeasurementUnits][X]
character
128 (oid)
MetaDataVersion
**OID [X]
character
128 (oid)
Name [X]
character
128 (name)
Description
character
2000 (text)
IncludedOID
character
128 (oid)
IncludedStudyOID
character
128 (oid)
DefineVersion [X]
character
2000 (text)
StandardName [X]
character
2000 (text)
StandardVersion [X]
character
2000 (text)
^^FK_Study [Study] [X]
character
128 (oid)
AnnotatedCRFs
DocumentRef
character
2000 (text)
^^leafID [MDVLeaf] [X]
character
128 (oid)
^^FK_MetaDataVersion [MetaDataVersion] [X]
character
128 (oid)
SupplementalDocs
DocumentRef
character
2000 (text)
^^leafID [MDVLeaf] [X]
character
128 (oid)
^^FK_MetaDataVersion [MetaDataVersion] [X]
character
128 (oid)
MDVLeaf
**ID [X]
character
128 (oid)
href
character
512 (path)
^^FK_MetaDataVersion [MetaDataVersion] [X]
character
128 (oid)
MDVLeafTitles
title
character
2000 (text)
^^FK_MDVLeaf [MDVLeaf] [X]
character
128 (oid)
ComputationMethods
**OID [X]
character
128 (oid)
method
character
2000 (text)
^^FK_MetaDataVersion [MetaDataVersion] [X]
character
128 (oid)
ValueLists
**OID [X]
character
128 (oid)
^^FK_MetaDataVersion [MetaDataVersion] [X]
character
128 (oid)
ValueListItemRefs
^^ItemOID [ItemDefs] [X]
character
128 (oid)
OrderNumber
numeric
8
Mandatory [X]
character
3
KeySequence
numeric
8
^^ImputationMethodOID [ImputationMethods]
character
128 (oid)
Role
character
128 (name)
^^RoleCodeListOID [CodeLists]
character
128 (oid)
^^FK_ValueLists [ValueLists] [X]
character
128 (oid)
ProtocolEventRefs
Mandatory [X]
character
3
OrderNumber
numeric
8
^^StudyEventOID [StudyEventDefs] [X]
character
128 (oid)
^^FK_MetaDataVersion [MetaDataVersion] [X]
character
128 (oid)
StudyEventDefs
**OID [X]
character
128 (oid)
Category
character
2000 (text)
Name [X]
character
128 (name)
Repeating [X]
character
3
Type [X]
character
11
^^FK_MetaDataVersion [MetaDataVersion] [X]
character
128 (oid)
StudyEventFormRefs
^^FormOID [FormDefs] [X]
character
128 (oid)
Mandatory [X]
character
3
OrderNumber
numeric
8
^^FK_StudyEventDefs [StudyEventDefs] [X]
character
128 (oid)
FormDefs
**OID [X]
character
128 (oid)
Name [X]
character
128 (name)
Repeating [X]
character
3
^^FK_MetaDataVersion [MetaDataVersion] [X]
character
128 (oid)
FormDefItemGroupRefs
^^ItemGroupOID [ItemGroupDefs] [X]
character
128 (oid)
Mandatory [X]
character
3
OrderNumber
numeric
8
^^FK_FormDefs [FormDefs] [X]
character
128 (oid)
FormDefArchLayouts
**OID [X]
character
128 (oid)
PdfFileName [X]
character
512 (path)
^^PresentationOID [Presentation]
character
128 (oid)
^^FK_FormDefs [FormDefs] [X]
character
128 (oid)
ItemGroupDefs
**OID [X]
character
128 (oid)
Name [X]
character
128 (name)
Repeating [X]
character
3
IsReferenceData
character
3
SASDatasetName
character
8
Domain
character
2000 (text)
Origin
character
2000 (text)
Role
character
128 (name)
Purpose
character
2000 (text)
Comment
character
2000 (text)
Label [X]
character
2000 (text)
Class
character
2000 (text)
Structure
character
2000 (text)
DomainKeys
character
2000 (text)
^^ArchiveLocationID [ItemGroupLeaf] [X]
character
128 (oid)
^^FK_MetaDataVersion [MetaDataVersion] [X]
character
128 (oid)
ItemGroupDefItemRefs
^^ItemOID [ItemDefs] [X]
character
128 (oid)
Mandatory [X]
character
3
OrderNumber
numeric
8
KeySequence
numeric
8
^^ImputationMethodOID [ImputationMethods]
character
128 (oid)
Role [X]
character
128 (name)
^^RoleCodeListOID [CodeLists]
character
128 (oid)
^^FK_ItemGroupDefs [ItemGroupDefs][X]
character
128 (oid)
ItemGroupAliases
Context [X]
character
2000 (text)
Name [X]
character
2000 (text)
^^FK_ItemGroupDefs [ItemGroupDefs] [X]
character
128 (oid)
ItemGroupLeaf
**ID [X]
character
128 (oid)
href
character
512 (path)
^^FK_ItemGroupDefs [ItemGroupDefs] [X]
character
128 (oid)
ItemGroupLeafTitles
title
character
2000 (text)
^^FK_ItemGroupLeaf [ItemGroupLeaf] [X]
character
128 (oid)
ItemDefs
**OID [X]
character
128 (oid)
Name [X]
character
128 (name)
DataType [X]
character
8
Length
numeric
8
SignificantDigits
numeric
8
SASFieldName
character
8
SDSVarName
character
8
Origin
character
2000 (text)
Comment
character
2000 (text)
^^CodeListRef [CodeLists]
character
128 (oid)
Label
character
2000 (text)
DisplayFormat
character
2000 (text)
^^ComputationMethodOID[ComputationMethods]
character
128 (oid)
^^FK_MetaDataVersion [MetaDataVersion] [X]
character
128 (oid)
ItemQuestionTranslatedText
TranslatedText
character
2000 (text)
lang
character
17
^^FK_ItemDefs [ItemDefs] [X]
character
128 (oid)
ItemQuestionExternal
Dictionary
character
2000 (text)
Version
character
2000 (text)
Code
character
2000 (text)
^^FK_ItemDefs [ItemDefs] [X]
character
128 (oid)
ItemMURefs
^^MeasurementUnitOID [MeasurementUnits] [X]
character
128 (oid)
^^FK_ItemDefs [ItemDefs] [X]
character
128 (oid)
ItemRangeChecks
**OID [X]
character
128 (oid)
Comparator [X]
character
5
SoftHard [X]
character
4
^^MURefOID [MeasurementUnits]
character
128 (oid)
^^FK_ItemDefs [ItemDefs] [X]
character
128 (oid)
ItemRangeCheckValues
CheckValue
character
512 (value)
^^FK_ItemRangeChecks [ItemRangeChecks] [X]
character
128 (oid)
RCErrorTranslatedText
TranslatedText
character
2000 (text)
lang
character
17
^^FK_ItemRangeChecks [ItemRangeChecks] [X]
character
128 (oid)
ItemRole
Name
character
2000 (text)
^^FK_ItemDefs [ItemDefs] [X]
character
128 (oid)
ItemAliases
Context [X]
character
2000 (text)
Name [X]
character
2000 (text)
^^FK_ItemDefs [ItemDefs] [X]
character
128 (oid)
ItemValueListRefs
^^ValueListOID [ValueLists] [X]
character
128 (oid)
^^FK_ItemDefs [ItemDefs] [X]
character
128 (oid)
CodeLists
**OID [X]
character
128 (oid)
Name [X]
character
128 (name)
DataType [X]
character
7
SASFormatName
character
8
^^FK_MetaDataVersion [MetaDataVersion] [X]
character
128 (oid)
ExternalCodeLists
Dictionary
character
2000 (text)
Version
character
2000 (text)
^^FK_CodeLists [CodeLists] [X]
character
128 (oid)
CodeListItems
**OID [X]
character
128 (oid)
CodedValue
character
512 (value)
^^FK_CodeLists [CodeLists] [X]
character
128 (oid)
Rank
numeric
8
CLItemDecodeTranslatedText
TranslatedText
character
2000 (text)
lang
character
17
^^FK_CodeListItems [CodeListItems] [X]
character
128 (oid)
ImputationMethods
**OID [X]
character
128 (oid)
method
character
2000 (text)
^^FK_MetaDataVersion [MetaDataVersion] [X]
character
128 (oid)
Presentation
**OID [X]
character
128 (oid)
presentation
character
2000 (text)
lang
character
17
^^FK_MetaDataVersion [MetaDataVersion] [X]
character
128 (oid)
The SAS Clinical Standards Toolkit CDISC CRT-DDS reference standard supports reading and representing in SAS a define.xml file, building a define.xml file, and validating the structure and content of the SAS representation of a define.xml file. In addition, it validates the structural integrity of the define.xml file. To support this functionality, supplemental files include the following global standards library files:
  • A SAS format catalog (crtddsct.sas7bcat) in the formats folder provides valid values for selected columns in the 39 tables of the SAS representation.
  • The Validation Master data set in the validation/control folder contains the super-set of checks validating the structure and content of the 39 tables.
  • The Messages data set in the messages folder provides error messaging for all Validation Master checks.
  • SAS code in the macros folder provides CDISC CRT-DDS-specific code that augments code that is provided in the primary SAS Clinical Standards Toolkit autocall library (!sasroot/cstframework/sasmacro).
  • The style sheet folder contains the define1-0-0.xsl file. The style sheet is copied from http://www.cdisc.org/stuff/contentmgr/files/0/464923b10ea16b477151fcaa9f465166/misc/define1_0_0.xsl. A define.xml file can be rendered in a human-readable form if it contains an explicit XML style sheet reference, such as a reference to the default style sheet.
It is this set of files, in whole or in part, that defines the CDISC CRT-DDS reference standard.