NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

Topic Links

This section provides instructions for uploading batch files via the Accrual user interface. It also provides instructions for resolving any errors that may have occurred during the import process.

The batch upload feature enables you to submit accrual data for multiple subjects and one or more trials at a time rather than having to enter data for each subject/study individually.

Once you have been granted permission to submit accrual data, you can upload accrual data files singly as plain text files or in multiple text files that have been compressed into a Zip file. For instructions, refer to Requesting Permission to Submit Accrual Data and Preparing Accrual Batch Files.

Only Super Abstractors can upload accrual data batch files for CTEP and DCP trials. For these trials, the system assigns default patient disease codes if the disease code was not included in the batch file. The following table maps disease code systems to their default codes.

Disease Code SystemDefault Code Assigned
ICD-O-3

C998 (site code)

7001 (histology code)

ICD-9V100
ICD-10Z1000
SDC8000001

If a trial currently has no existing study subjects, and if all study subjects are missing the disease code in the CDUS file being submitted, the system assigns the CTEP SDC "disease not specified code, i.e., " 80000001, by default. The system cannot process files in which invalid study subject disease codes are provided.

Preparing CTRP Accrual Batch Files

When a trial has accrued many subjects, rather than entering the data subject-by-subject via the user interface (UI), you can upload all study subject data into CTRP using a batch file upload. The information that follows provides all the details you need to create an Accruals batch file.

Use the Batch File Utility as a guide

If you are new to the batch file creation process, you can use the CTRP Accrual Batch File Tool to get you started. With it you can produce properly-formatted batch files that you can upload in the Accrual application.  

When you create a batch file, ensure that each data element conforms to the requirements:

  • List each data element in its appropriate position in a given row
  • Use the correct character cases (CAPITAL vs. lower case letters)
  • Use the correct character lengths (number of characters allowed in a single field)

After you have prepared a batch file, you can upload it to CTRP.  For instructions on submitting batch files, see Uploading Accrual Batch Data Files.

Return to top of page

Key Facts about CTRP Accrual Batch Files

  • The Accrual batch file format is based on the CTEP Clinical Data Update System (CDUS) file format. You can obtain a copy of the CDUS Instructions and Guidelines, which explains the CDUS file format in great detail, at the CTEP web site at http://ctep.cancer.gov/protocolDevelopment/electronic_applications/cdus.htm.
  • Although the CTRP accrual batch file format is CDUS-compatible, CTRP captures a subset of all the CDUS required data elements.  Comparison of CTRP and CDUS Accrual Data Elements provides a list of all the CDUS fields with a note next to each field indicating whether CTRP captures it.

  • Different data elements are required and expected when submitting accrual data to CTRP for Complete trials (Externally Peer Reviewed, and Institutional) than for Abbreviated Trials (Industrial). Instructions are provided below for preparing batch files for both Complete and Abbreviated Trials.

  • A CTRP accrual batch file is a TXT (.txt) file with fields delimited (separated) by commas. The text file can be UTF-8 or ANSI-encoded.

  • Each CTRP batch text file contains accrual data for a single trial. You can compress one or more CTRP accrual batch text files into a single Zip file and then upload this Zip file into CTRP. CTRP will unzip the file and process each TXT file. Your Zip file can include batch files for both Complete and Abbreviated Trials.

  • Accruals for National trials are submitted directly to CTRP from CTEP and/or DCP.

Do not include the following items in Zip files that you intend to upload:

  • Folders or other Zip files
  • Path names. Some ZIP/compression tools provide an option to include the entire file path name when compressing a file. Path names describe the location of the file.

Initial Accrual Batch File Submission: 

  • The initial accrual batch file submitted to CTRP will add accrual records for either Summary Level Accrual or Subject Level Accrual based on the selection.

Subsequent Accrual Batch File Submissions:  

  • For Summary Level Accrual (typically provided for Abbreviated/Imported - e.g., Industrial trials), subsequent accrual batch file uploads will replace previously submitted/uploaded accrual data.  Batch uploads will not append data; cumulative accrual data must be uploaded with each accrual file submitted to CTRP.  
    • Please ensure that your CTRP accrual batch file contains all cumulative accrual data for each participating site to date before uploading to CTRP.  Failure to include cumulative accrual data will result in erasing your accrual history.
  • For Subject Level Accrual (typically provided for Complete trials), subsequent accrual batch file uploads will append data.   
    • If there are duplicate records (all fields are the same) within the batch file being submitted, the file will not be loaded and a notification will be sent to the user asking for the duplicate record(s) to be removed and the file resubmitted.  
    • If an element is changed, for example Gender, then the record is considered an update not a duplicate.

To download a copy of the of the CTRP Accrual Batch File Tool (includes instructions), go to:

CTRP Accrual Batch File Tool

For Summary Level Accrual (typically provided for Abbreviated/Imported - e.g., Industrial trials), the following is an example batch file for one trial with two participating sites (Sites 1 and 2) supporting monthly accrual updates.  Site 1 and 2 in the below example map to "PO ID" (unique to each Participating Site).

Note:  Create and submit one trial per batch load.  You can also include individual batch load files in one zip.  

Centers have the option to provide quarter, monthly accrual from trial start date to present.  Another option is to provide batch load file which includes a cut off date accrual entry from trial start for each as of cut-off date for only when accrual changed. 

Abbreviated/Imported (e.g., Industrial Trials) Example Batch File - Monthly

COLLECTIONS,<Study_Identifier>,,,,,,,,,

"ACCRUAL_COUNT","NCI-2017-00225","Site 1","2","20170630"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","2","20170731"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","4","20170831"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","5","20170930"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","6","20171031"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","10","20171130"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","12","20171231"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","15","20180131"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","15","20180228"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","18","20180331"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","18","20180430"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","18","20180531"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","21","20180630"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","21","20180731"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","25","20180831"

"ACCRUAL_COUNT","NCI-2017-00225","Site 2","1","20170630"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","1","20170731"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","5","20170831"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","5","20170930"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","8","20171031"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","9","20171130"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","13","20171231"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","13","20180131"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","14","20180228"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","18","20180331"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","22","20180430"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","30","20180531"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","31","20180630"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","32","20180731"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","33","20180831"


Abbreviated/Imported (e.g., Industrial Trials) Example Batch File - Accrual Changes

COLLECTIONS,<Study_Identifier>,,,,,,,,,

"ACCRUAL_COUNT","NCI-2016-00225","Site 1","1","20170215"
"ACCRUAL_COUNT","NCI-2016-00225","Site 1","2","20170820"
"ACCRUAL_COUNT","NCI-2016-00225","Site 1","4","20180331"
"ACCRUAL_COUNT","NCI-2016-00225","Site 1","6","20180910"
"ACCRUAL_COUNT","NCI-2016-00225","Site 1","10","20181202"

"ACCRUAL_COUNT","NCI-2016-00225","Site 2","2","20170128"
"ACCRUAL_COUNT","NCI-2016-00225","Site 2","4","20170710"
"ACCRUAL_COUNT","NCI-2016-00225","Site 2","5","20170825"
"ACCRUAL_COUNT","NCI-2016-00225","Site 2","7","20171031"
"ACCRUAL_COUNT","NCI-2016-00225","Site 2","9","20171122"
"ACCRUAL_COUNT","NCI-2016-00225","Site 2","12","20180107"








For additional information, refer to the following pages:

Return to top of page

An Introduction to Batch Files

This section provides general background information about batch file structure. Subsequent sections provide specific details about the Accrual batch file structure.

Each line of text in a batch file corresponds to one record that consists of various required or optional data elements. Each data element is separated by a comma.

Traditional Table Structure

Column 1Column 2Column 3Column 4
Row 1-Field 1Row 1-Field 2Row 1-Field 3Row 1-Field 4
Row 2-Field 1Row 2-Field 2Row 2-Field 3Row 2-Field 4

Corresponding Comma-Delimited Structure

Comma-Delimited Structure
Field 1,Field 2,Field 3,Field 4
Field 1,Field 2,Field 3,Field 4
Fields Required for CDUS Records
CDUS Field 1,CDUS Field 2,CDUS Field 3,CDUS Field 4,CDUS Field 5,CDUS Field 6
Fields Required for CTRP Batch File
CTRP Field 1,CTRP Field 2,,,,CTRP Field 6

In a traditional table grid structure, the column headings indicate the order in which the field values occur. In CTRP batch files, the column heading is implicit, and the field order is sequential from left to right, beginning at Field 1.

Traditional Table Structure

Column 1Column 2Column 3Column 4
Row 1-Field 1Row 1-Field 2Row 1-Field 3Row 1-Field 4
Comma-Delimited Structure
Field #1,Field #2,Field #3,Field #4

The first field in each record is reserved for the table name, which is always in CAPITAL letters. The exact field number for each data element is provided in the Complete Trial Record Data Field Requirements and Abbreviated Trial Record Data Field Requirements tables.

Example - Using Automobiles Instead of Patients

Suppose CDUS stores information about cars (rather than accrued patients) in its database in a table called AUTOMOBILES.

In this example, CDUS records each of the following six data elements:

  • Table Name
  • VIN (Vehicle Identification Number)
  • Make
  • Model
  • Color
  • Year

These data elements are arranged in the following sequence:

Table NameVINMakeModelColorYear

The corresponding comma-delimited sequence is as follows:

Comma-Delimited Data Elements
<AUTOMOBILE>,<vin>,<make>,<model>,<color>,<year>

A traditional table structure for these CDUS data elements and their values are shown below.

Table NameVINMakeModelColorYear
AUTOMOBILEABC-123456FordMustangBlack1965

The corresponding comma-delimited structure is as follows:

Comma-Delimited Data Values
AUTOMOBILE,ABC-123456,Ford,Mustang,Black,1965

And, to extend this example, suppose that CTRP does not capture the Model nor Color of the car. In this case, the final record in the CTRP batch file would be as follows:

Comma-Delimited CTRP Data Values
AUTOMOBILE,ABC-123456,Ford,,,1965

Return to top of page

File Naming Conventions

The CTRP Accrual Batch File is a TEXT file with fields delimited (separated) by commas. The file can have any name. However, we recommend using the following file naming conventions:
NCI Protocol Number_date.txt (with the date format: YYYYMMDD)
Example File Name
NCI-2012-00XXX_20090430.txt

The total number of characters in the file name including the file path must be less than or equal to 260. Use the file extensions .txt (for a single file) or .zip for compressed .txt files.

Return to top of page

Accrual Batch File Data for Complete Trials

The CTRP Accrual Batch File conforms to the CDUS file specification, but it only uses a limited number of fields from that file. Data in the rest of the fields are ignored, but the place holders (commas) must still be present in the data file, whether empty or filled.

Before you begin

CTRP considers each accrual submitted as the total (cumulative) count to date. Be sure to read the information about accrual counts in Recording Participating Site Subject Accrual Counts.

For instructions, refer to the following pages:

Return to top of page

Complete Trial Tables

Tables identify the record type for each record. The CTRP uses the following tables for complete trials.

Table Name

Number of CDUS Fields

(Excluding the Table Name)

Number of Fields Used by CTRP

(Excluding the Table Name)

Purpose
COLLECTIONS102Identifies the study for this data file
PATIENTS2312Subject-specific accrual data
PATIENT_RACES33Subject's Race

For a list of all the CDUS fields for these tables, refer to Comparison of CTRP and CDUS Accrual Data Elements.

Return to top of page

Complete Trial Data Elements and Field Formats

Each row in a batch file is associated with a single record in the database. The first field in each line identifies the name of the table that a record belongs to. Subsequent fields contain different data element values for the same table. The number of fields required in each record, and the values they must contain, are provided in the Complete Trial Record Data Field Requirements table. Because many more elements are required in CDUS records than in CTRP records, many fields in your batch file will be null (contain no field values at all). In these cases, use a comma to indicate a field for which there is no datum.

If a comma is part of the value, enclose the fields in double quotes. Otherwise the use of double quotes is optional.

Return to top of page

Complete Trial Data Record Formats

Each line of the data file contains one record, is prefixed by the table name, and is comma delimited.

Important!

Use blank fields for those fields that are included in the CDUS standard but not used by the CTRP.

Valid Record Formats and Field Sequence
COLLECTIONS,<Study_Identifier>,,,,,,,,,<Change_Code>
PATIENTS,<Study_Identifier>,<Study_Subject_Identifier>,<Zip_Code>,<Country_Code>,<Birth_Date>,<Gender>,<Ethnicity>,<Payment_Method>,<Subject_Registration_Date>,<Registering_Group_Identifier>,<Study_Site_Identifier>,,,,,,,,,,<Subject_Disease_Code>,,
PATIENT_RACES,<Study_Identifier>,<Study_Subject_Identifier>,<Race>

The following is an example batch file for a study that has three study subjects, and one race per subject using CTRP accepted valid values. In the example below "Male", for example, is used instead of a CDUS accepted numeric value of "1".

Example Batch File
COLLECTIONS,"NCI-2011-03861",,,,,,,,,1
PATIENTS,"NCI-2011-03861",873222899999999,84124,,196311,Male,Unknown,Private Insurance,20060809,CALGB,149280,,,,,,,,,,238.7,,
PATIENTS,"NCI-2011-03861",8732228,84124,,196311,Male,Unknown,Private Insurance,20060809,CALGB,149280,,,,,,,,,,238.7,,
PATIENTS,"NCI-2011-03861",1,84124,,196311,Male,Unknown,Private Insurance,20060809,CALGB,149280,,,,,,,,,,185.0,,
"PATIENT_RACES","NCI-2011-03861",8732228,White
"PATIENT_RACES","NCI-2011-03861",873222899999999,Asian
"PATIENT_RACES","NCI-2011-03861",1,White

The following is another example batch file, accepted by CTRP, for the same study but using CDUS accepted numeric codes instead of the text values used in the example above .

Example Batch File
COLLECTIONS,"NCI-2011-03861",,,,,,,,,1
PATIENTS,"NCI-2011-03861",873222899999999,84124,,196311,1,9,1,20060809,CALGB,149280,,,,,,,,,,238.7,,
PATIENTS,"NCI-2011-03861",8732228,84124,,196311,1,9,1,20060809,CALGB,149280,,,,,,,,,,238.7,,
PATIENTS,"NCI-2011-03861",1,84124,,196311,1,9,1,20060809,CALGB,149280,,,,,,,,,,185.0,,
"PATIENT_RACES","NCI-2011-03861",8732228,01
"PATIENT_RACES","NCI-2011-03861",873222899999999,05
"PATIENT_RACES","NCI-2011-03861",1,01

Special Characters

If you include any of the following characters in a value, enclose the field with double quotes:

! " # $ % & ' ( ) * +  , -  . / : ; < > = ? @ [] \^ _{} | ~

If you enclose a field with double quotes (as in "NCI-2012-00225"), CTRP interprets the string inside the quote exactly as presented. If the field does not contain any special characters, the quote marks are optional.


ICD-O-3 Trial Format for Topography Codes

For trials using ICD-O-3 codes, use the Subject Disease Code position for ICD-O-3 Topography and Morphology (which must include Histology and Behavior codes). When you use both Topography and Morphology codes, separate them by a semi-colon as per the example below.
Format:  site code; histology code
Code: C64.9;8000/3

Examples:

SDC Topography
PATIENTS,"NCI-2011-03861",8732228,84124,,196311,1,9,1,20060809,CALGB,149280,,,,,,,,,,238.7,,
ICD-O-3 Topography and Morphology
PATIENTS,"NCI-2011-03861",8732228,84124,,196311,1,9,1,20060809,CALGB,149280,,,,,,,,,,C64.9;8000/3,,

Return to top of page

Complete Trial Record Data Field Requirements

The tables in this section contain detailed information about each of the data elements included in the Batch Upload file. The CDUS Accepted Values are provided to show differences in case your system is already producing the CDUS file. In most cases, both CTRP and CDUS values are accepted.

For field requirements, refer to the following pages:

Return to top of page

Accrual Data Elements Table with CTRP-Accepted Values

 Accrual Data Elements table with CTRP-Accepted values for Complete trials
Accrual Data Element NameMandatory=M; Optional=O
Conditional = C
DefinitionCTRP Accepted ValuesInformation Model Class / Diagram MappingComments/Conditions
Study IdentifierMUnique identifier assigned to the studyNCI, CTEP, or DCP IdentifierStudy Protocol / assignedIdentfier--
Study Subject Identifier MUnique identifier (numeric or alphanumeric) assigned to subjects in a study

Any numeric or alphanumeric value assigned to a study subject

Study Subject / identifier--
ZIP Code CString of characters used to identify the five-digit Zone Improvement Plan (ZIP) code that represents the geographic segment that is a subunit of the ZIP code, assigned by the U.S. Postal Service to a geographic location to facilitate mail delivery.5 digit numeric ZIP codePatient / postalAddressMandatory if patient’s Country of Residence is U.S.
Country of ResidenceCFor non-U.S. residents only. This should be used when patient participation from foreign countries is involved. For patients from outside the U.S., enter the foreign country code. Leave blank if the patient is a U.S. resident. CTRP is using the International Standards Organization country codes.  Note: Either Zip code (if U.S resident) or country code (if not U.S resident) is mandatory.2-letter ISO Country CodesPatient / postalAddressMandatory if not U.S.
Patient’s Date of BirthMThe month and year on which the person was born

YYYYMM

Patient / birthDate

Year and Month are mandatory. 

Gender of a PersonMText designations that identify gender. Gender is described as the assemblage of properties that distinguish people on the basis of their societal roles
  • Male
  • Female
  • Unspecified
  • Unknown
Patient / sexCode

Identification of gender is based upon self-report and may come from a form, questionnaire, interview, etc.

Genders in batch files do not have to correspond to the gender indicated as a trial eligibility criterion.

EthnicityMText for reporting information about ethnicity based on the Office of Management and Budget (OMB) categories
  • Hispanic or Latino
  • Not Hispanic or Latino
  • Not Reported
  • Unknown
Patient / ethnicGroupCode--
Payment MethodOTerm for an entity, organization, government, corporation, health plan sponsor, or any other financial agent who pays a healthcare provider for the healthcare service rendered to a person or reimburses the cost of the healthcare service
  • Private Insurance
  • Medicare
  • Medicare and Private Insurance
  • Medicaid
  • Medicaid and Medicare
  • Military or Veterans Sponsored, NOS
  • Military Sponsored (Including CHAMPUS & TRICARE)
  • Veterans Sponsored
  • Self-Pay (No Insurance)
  • No Means of Payment (No Insurance)
  • Managed Care
  • State Supplemental Health Insurance
  • Other
  • Unknown
StudySubject / paymentMethodCode
Payment Method Codes in batch files are not case-sensitive.
Subject Registration Date MDate the subject was registered to the studyYYYYMMDDPerformedSubjectMilestone / registrationDate--
Registering Group CodeO

Unique CTEP Group code assigned to the group that originally registered the patient for the study

--StudySubject / registrationGroupId

For trials with Group participation, provide CTEP Group Code, if available

Study Site IdentifierMUnique identifier (PO ID) assigned to the institution accruing the patient to the study

CTRP Person/Organization ID (PO ID)

Study Site / identifier--

Subject Disease Code

   

M

Code that identifies a disease

  • CTEP Simplified Disease Code (SDC) terms
  • ICD-9-CM codes
  • ICD-O-3 codes
  • ICD-10
For SDC Disease Code:
StudySubject / diease_identifier

For ICD-9 Disease Code:
StudySubject / icd9diease_identifier

Disease code is mandatory for all trials except those managed by DCP PIO.

Cancer specific ICD-9-CM disease codes in the range 140 to 239. Information about these disease codes is available at http://www.icd9data.com Exit Disclaimer logo

For trials using ICD-O-3 terminology, use this position for Site and Morphology (which must include Histology and Behavior Codes). When using both Site and Histology codes, separate them by a semicolon ( ; ). Site codes are available at https://codes.iarc.fr/usingicdo.php.

For Disease Codes for disease not specified, healthy volunteers and donors see Disease Codes for Disease not Specified, Healthy Volunteers and Donors - Include v4.4

RaceMText for reporting information about race based on the Office of Management and Budget (OMB) categories
  • American Indian or Alaska Native
  • Asian
  • Black or African American
  • Native Hawaiian or Other Pacific Islander
  • Not Reported
  • Unknown
  • White
Patient / raceCode
Multiple races in batch files are permissible even if "Not Reported" or "Unknown" is indicated.
Change CodeOAdditions or changes since the last report
  • 1
  • 2
  • NULL
AccrualCollections / changeCode

1 or NULL = changes in the file;  the CTRP system processes and saves the submission

2 = If the trial's current accrual is 0, the CTRP system processes the file as a Code 1 change. If the trial's current accrual is greater than 0, the system saves the file but does not process it.


Return to top of page

Accrual Data Elements Table with CDUS-Accepted Values

Accrual Data Elements table with CDUS-Accepted values for Complete trials
Accrual Data Element NameMandatory=M; Optional=O
Conditional = C
DefinitionCDUS Accepted ValuesComments/Conditions
Study IdentifierMUnique identifier assigned to the studyCTEP Identifier --
Study Subject Identifier MUnique identifier (numeric or alphanumeric) assigned to subjects in a study

Any numeric or alphanumeric value assigned to a study subject

--
ZIP Code CString of characters used to identify the five-digit Zone Improvement Plan (ZIP) code that represents the geographic segment that is a subunit of the ZIP code, assigned by the U.S. Postal Service to a geographic location to facilitate mail delivery.5 digit numeric ZIP codeMandatory if patient’s Country of Residence is U.S.
Country of ResidenceCFor non-U.S. residents only. This should be used when patient participation from foreign countries is involved. For patients from outside the U.S., enter the foreign country code. Leave blank if the patient is a U.S. resident. CTRP is using the International Standards Organization country codes.  Note: Either Zip code (if U.S resident) or country code (if not U.S resident) is mandatory.2-letter ISO Country CodesMandatory if not U.S.
Patient’s Date of BirthMThe month and year on which the person was bornYYYYMMYear and Month are mandatory
Study Subject SexMText designations that identify gender. Gender is described as the assemblage of properties that distinguish people on the basis of their societal roles
  • 1 = Male
  • 2 = Female
  • 9 = Unknown
Identification of gender is based upon self-report and may come from a form, questionnaire, interview, etc.
EthnicityMText for reporting information about ethnicity based on the Office of Management and Budget (OMB) categories
  • 1 = Hispanic or Latino
  • 2 = Not Hispanic or Latino
  • 8 = Not Reported
  • 9 = Unknown
--
Subject Registration Date MDate the subject was registered to the studyYYYYMMDD--
Study Site IdentifierMUnique identifier (PO ID) assigned to the institution accruing the patient to the study

CTEP Site  ID

--
Subject Disease CodeM

Code that identifies a disease

  • CTEP Simplified Disease Code (SDC) terms
  • ICD-9-CM codes

Disease code is mandatory for all trials except those managed by DCP PIO.

Cancer specific ICD-9-CM disease codes in the range 140 to 239. Information about these disease codes is available at http://www.icd9data.com Exit Disclaimer logo

RaceMText for reporting information about race based on the Office of Management and Budget (OMB) categories
  • 01 = White
  • 03 = Black or African American
  • 04 = Native Hawaiian or Other Pacific Islander
  • 05 = Asian
  • 06 = American Indian or Alaska Native
  • 98 = Not Reported
  • 99 = Unknown
--
Change CodeOAdditions or changes since the last report----

Return to top of page

Complete Trial Record Data Field Formats

The following table lists the data fields by the table in which they are recorded. It also provides the field number (field position in a row); and the format and character limits for each field. 
TablesField (Field Position in a Row)Format (Maximum Number of Characters)
COLLECTIONSStudy Identifier (2)Text (35)
COLLECTIONSChange Code (11)Number (1)
PATIENTSStudy Identifier (2)Text (35)
PATIENTSStudy Subject Identifier (3)Text (20)
PATIENTSZIP Code (4)Text (10)
PATIENTSCountry of Residence (5)Text (2)
PATIENTSPatient's Date of Birth (6)Date (YYYYMM)
PATIENTSGender of a Person (7)Text (10)
PATIENTSEthnicity (8)Text (25)
PATIENTSPayment Method (9)Text (50)
PATIENTSSubject Registration Date (10)Date (YYYYMMDD)
PATIENTSRegistering Group Identifier (11)Text (25)
PATIENTSStudy Site Identifier (12)Text (25)
PATIENTS

Subject Disease Code (22) 1

Number (10)
PATIENT_RACESStudy Identifier (2)Text (35)
PATIENT_RACESStudy Subject Identifier (3)Text (20)
PATIENT_RACESRace (4)Text (45)

The relation between COLLECTIONS, PATIENTS, and PATIENT_RACES is that COLLECTIONS can have multiple PATIENTS, and PATIENTS can have multiple PATIENT_RACES. These relations are maintained through the use of consistent Study Identifier and Study Subject Identifier fields.

Using the format table, you can determine that you must enter the Patient's Date of Birth in the sixth position in a row in the PATIENTS table as YYYYMM. The following diagram contains a typical line of text from a batch file. Brackets with numbers indicate the field position number.

Diagram demonstrating the batch file field format

In the example above, the fifth field position (5) is null (blank) because it (Country of Residence) is a conditionally required field and in this example is not required.

___

  1. For trials using ICD-O-3 terminology, use this position for Site and/or Histology Codes. When using both Site and Histology codes, separate them by a semicolon ( ; ).

Return to top of page

Accrual Batch File Data for Abbreviated Trials

Abbreviated Studies in CTRP are those with the Data Table 4 trial submission category of Industrial. The CTRP requires users to submit accrual totals only for these trials. Do not submit subject-specific data. The CTRP Accrual Batch File uses the same file format as CDUS, but the fields are unique to CTRP.

Before you begin

The CTRP considers each accrual submitted as the total (cumulative) count to date. Be sure to read the information about accrual counts in Recording Participating Site Subject Accrual Counts.


Note: The new submission for a trial will completely REPLACE the previous submission (count history) of this trial. In order to maintain the count history, the user will need to attach the previous submissions in the same batch file.

For instructions, refer to the following pages:

Return to top of page

Abbreviated Trial Tables

Tables identify the record type for each record. CTRP uses the following tables for abbreviated studies.
Table Name

Number of CDUS Fields

(Excluding the Table Name) 

Number of Fields Used by CTRP

(Excluding the Table Name) 

Purpose
COLLECTIONS101Identifies the study for this data file
ACCRUAL_COUNT(TBD: 0 or 1)4Aggregate accrual data

Return to top of page

Abbreviated Trial Data Record Formats

Each line of the data file contains one record, is prefixed by the table name, and is comma delimited.

Use blank fields for those fields that are included in the CDUS standard but not used by the CTRP.


To download a copy of the of the CTRP Accrual Batch File Tool (includes instructions), go to:

CTRP Accrual Batch File Tool

For Summary Level Accrual (typically provided for Abbreviated/Imported - e.g., Industrial trials), the following is an example batch file for one trial with two participating sites supporting monthly accrual updates.  Site 1 and 2 in the below example map to "PO ID" (unique to each Participating Site).

Note:  Submit one trial per batch load.  You can also include individual batch load files in one zip. 

Example Batch File
COLLECTIONS,<Study_Identifier>,,,,,,,,,
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","2","20170630"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","2","20170731"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","4","20170831"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","5","20170930"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","6","20171031"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","10","20171130"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","12","20171231"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","15","20180131"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","15","20180228"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","18","20180331"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","18","20180430"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","18","20180531"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","21","20180630"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","21","20180731"
"ACCRUAL_COUNT","NCI-2017-00225","Site 1","25","20180831"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","1","20170630"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","1","20170731"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","5","20170831"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","5","20170930"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","8","20171031"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","9","20171130"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","13","20171231"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","13","20180131"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","14","20180228"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","18","20180331"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","22","20180430"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","30","20180531"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","31","20180630"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","32","20180731"
"ACCRUAL_COUNT","NCI-2017-00225","Site 2","33","20180831"

Special Characters

If you include any of the following characters in a value, enclose the field with double quotes:

! " # $ % & ' ( ) * +  , -  . / : ; < > = ? @ [] \^ _{} | ~

If you enclose a field with double quotes (as in "NCI-2012-00225"), CTRP interprets the string inside the quote exactly as presented. If the field does not contain any special characters, the quote marks are optional.

Return to top of page

Abbreviated Trial Record Data Field Requirements

The following table contains detailed information about each of the data elements included in the Batch Upload file for Abbreviated Trials. The CDUS Accepted Values are provided to show differences in case your system is already producing the CDUS file.

For field requirements, refer to the following pages:

Return to top of page

Accrual Data Elements with CTRP-Accepted Values

Accrual Data Elements table with CTRP accepted values
Accrual Data Element NameMandatory=M; Optional=O
Conditional = C
DefinitionCTRP Accepted ValuesInformation Model Class / Diagram Mapping
Study IdentifierMUnique identifier assigned to the studyNCI, CTEP, or DCP IdentifierStudy Protocol / assignedIdentfier
Study Site IdentifierMUnique identifier (PO ID) assigned to the institution accruing the patient to the studyPO IDStudy Site / identifier
Study Site Accrual CountMNumeric count of subjects accrued at a study site to dateNumericStudy Site / subjectAccrualcount
Cut-Off DateOThe date from which the cumulative accrual count was calculated.YYYYMMDD(TBD)

Return to top of page

Accrual Data Elements with CDUS-Accepted Values

Accrual Data Elements table with CDUS-Accepted values
Accrual Data Element NameMandatory=M; Optional=O
Conditional = C
DefinitionCDUS Accepted Values
Study IdentifierMUnique identifier assigned to the studyCTEP Identifier
Study Site IdentifierMUnique identifier (PO ID) assigned to the institution accruing the patient to the studyCTEP Site  ID
Study Site Accrual CountMN/A--
Cut-Off DateOThe date from which the cumulative accrual count was calculated.(TBD)

Return to top of page

Abbreviated Trial Data Field Requirements

TablesField (Field Position in a Row)Format (Maximum Number of Characters)
COLLECTIONSStudy Identifier (2)Text (35)
ACCRUAL_COUNTStudy Identifier (2)Text (35)
ACCRUAL_COUNTStudy Site Identifier (3)Text (25)
ACCRUAL_COUNTStudy Site Accrual Count (4)Text (10)

The COLLECTIONS and ACCRUAL_COUNT tables are linked by consistent Study Identifier and Study Site Identifier fields. There is no limit to the number of ACCRUAL_COUNT records.

Return to top of page

Uploading Accrual Batch Files

Note: The new submission for a trial will completely REPLACE the previous submission (count history) of this trial. In order to maintain the count history, the user will need to attach the previous submissions in the same batch file.

Be sure to complete your batch file preparation first

Before you begin, gather all the protocol data you need. See Preparing CTRP Accrual Batch Files for instructions. The system logs you out if it detects that you have not used the application for 90 minutes. 

The system locks you out after three unsuccessful attempts to log in within 24 hours. In the event that you have been locked out of your account, contact us at ctrp_support@nih.gov. If you have forgotten your password, or if you want to reset it for any reason, refer to Resetting Your Password.

Once you have created your Accrual Batch Upload file, upload it via the CTRP Accrual web interface. Existing accrual data for the study will be updated and any new data you submit will be added.

The batch upload template currently does NOT provide a way to enter accrual disease code terminology; instead, the default value of SDC is used.

The batch files you submit do not delete previously accrued patients/patient data. Use the Accrual application user interface to delete accrued subjects as necessary.

How to Upload Accrual Batch Files

  1. On the toolbar, click Batch Upload
    The Batch Upload page appears.
    Accrual Batch Upload page displaying Browse button
  2. Click Browse and select the .txt or .zip file that contains your accrual data.

  3. Click Submit.
    Your file is uploaded to the system and processed in the backgroundWhen processing has been completed, the system sends you an email message to inform you of the status of your file(s). It includes the information listed below. The system will also notify you if it is unable to process your Zip file. 

  • NCI Identifier
  • Number of subject accruals that the system imported
  • Details of any errors that may have occurred during the import process

The system checks your submissions to ensure there are no duplicates. The system does not process a study subject record if it detects that a participating site in the same trial has registered a subject with the same Study Subject ID. The system includes details about which Study Subject IDs are affected in an error message.

A subject is duplicate if 

   1. There is already  an accrual with same subject id on the same PS for a trial.

   2. If following attributes (subject id, dob, gender, ethnicity) match for a subject on any other PS on the trial(not including the PS accrual is added to).


Once you have uploaded your batch file, the CTRP system continues to update the record status both by email and Accrual. To view the information you uploaded, see Downloading Accrual Batch Data Files and  Reviewing and Updating Prior Accrual Submissions.


Return to top of page

Resolving Accrual Batch File Upload Errors

If the email notice you received after uploading a batch file indicated that errors occurred during the the import process, you can use the following steps to correct them before re-submitting your accruals batch file.

If the batch (.zip) file contains both valid (error-free) and invalid files, the system processes the valid files and notifies you about the files that it could not process.

If the CTRP system was unable to identify an organization that you submitted in your batch file, it determines if the organization was nullified and merged with another organization. If so, the system includes the new organization name in the error message.

For Super Abstractors

If a CDUS batch file contains accruals for sites that have not been added yet to the trial in the CTRP, the system processes the valid sites and then emails you a list of participating sites from your file that are missing in the CTRP. You can correct this type of error by adding the site(s) to the trial and resubmitting the accrual batch file.

How to Resolve Accrual Batch File Upload Errors

  1. Go through the list of errors described in detail in the status email you received for each line in your text file that caused the error.
  2. Correct the errors.
  3. Save the file and re-submit.

Return to top of page

 

  • No labels