Version 0.1 DRAFT
The current scope of the CTRP Dictionary is as follows:
- The elements that appear in the NCI Clinical Trials API
- The elements that appear in the CTRP Trial Summary Report (TSR)
- Some of the elements that appear in CTRP Accrual web application
The following table describes each column in the CTRP Dictionary page:
| Column | Description |
|---|---|
| Element ID | An ID number arbitrarily assigned by the author of this wiki page, for maintenance purposes. It has no relevance in the NCI Clinical Trials API or in CTRP. |
| Data Element | Data element name as it appears in the API, data warehouse (DW), or database (DB), in that order of preference. |
| Definition | A definition of the data element. |
| API | Yes or No, indicating whether the data element is in the API JSON schema and in the API JSON output, such as clinical-trial/NCT02194738. Where other columns mention components, this refers to the hierarchy of nested elements in the API schema. For example, the central_contact_email element is nested within the central_contact element in the API schema. The central_contact element does not exist in the other systems, except in the sense that its components (such as the central_contact_email element) do exist in the other systems. |
| TSR | Yes or No, indicating whether the data element is in the TSR, as generated from CTRP. |
| DW | Yes or No, indicating whether the data element is in the data warehouse. |
| DB | Yes or No, indicating whether the data element is in the CTRP database for the Protocol Abstraction or Person/Organization web application. |
The following table describes each additional column in the spreadsheet:
Column | Description |
|---|---|
API Data Element | Data element name as it appears in the JSON schema of the NCI Clinical Trials API, if this data element is represented in the API. |
API Data Type | Data type as indicated in the API JSON schema, if this data element is represented in the API. |
TSR Section | Where this data element is represented in the TSR, as generated from CTRP. |
DW Table | Where this data element is represented in the data warehouse. |
DW Data Element | Data element name as it appears in the data warehouse. |
| Which DB | Which CTRP database contains this data element:
|
DB Table | Where this data element is represented in the CTRP database. |
DB Data Element | Data element name as it appears in the CTRP database. |
Character Limit | Character limit of the data element. |
List of Values | List of values for the data element. |
Date/Time Format Example | An example indicating the date/time format of the data element, if the data type is date. |
