NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
Column
width40%
Panel
titleTopic Links

Table of Contents
maxLevel4
minLevel2

Column

This section provides instructions for managing subject accruals via the NCI CTRP Accrual REST Service.

Introduction

The Accrual REST Service is a CTRP Web Service that provides the following operations in a REST-like fashion:

  • Add or update trial study subject accrual information on a given participating site
  • Delete specific trial study subject accrual information from a given participating site
  • Submit Report accrual count for a participating site in an Abbreviated trialstudy

The service uses XML for data exchange.

...

Description

This operation submits reports Subject & Partial Subject accrual information for a specific participating site on a trialstudy. If the subject accrual record already exists for the specified study and participating site, this operation will update that record accordingly. If you submit multiple report multiple Subject accrual records all with the same subject ID within the same request, the last record in the list will supplant the others. The submitter must have accrual access to the site.

...

  1. /sites/{id}
    1. {id}. CTRP numeric identifier of a participating site
    2. Example: https://trials-stage.nci.nih.gov/accrual-services/sites/121787425
  2. /trials/{idType}/{trialID}/sites/po/{id}
    1. {idType}. Type of identifier you want to use to identify a trial in study in CTRP. Possible values: pa, nci, ctep, dcp.
    2. {trialID}. Trial identifier value itself
    3. {id}. PO identifier of the organization that is the site on the trialstudy

    4. Example: https://trials-int.nci.nih.gov/accrual-services/trials/nci/NCI-2019-00038/sites/po/7434
  3. /trials/{idType}/{trialID}/sites/ctep/{id}
    1. {idType}. Type of identifier you want to use to identify a trial in study in CTRP. Possible values: pa, nci, ctep, dcp.
    2. {trialID}. Trial identifier value itself
    3. {id}. CTEP identifier of the organization that is the site on the trialstudy

    4. Example: https://trials-int.nci.nih.gov/accrual-services/trials/nci/NCI-2019-00038/sites/ctep/WQ456 

...

The following XML request shows an example for submitting five reporting five study subjects to site 121787425 using ICD9 for disease codes. Note that the <siteDisease> is not required since the disease code used is ICD9.

...

The following XML request shows an example for submitting one reporting one study subject to site 121787425 using ICD-O-3 for the Topography code. Note that when the Topography <codeSystem> = “ICD-O-3”, both the <disease> and the <siteDisease> are mandatory.

...

The following XML request shows an example for submitting one reporting one study subject to site 121787425 using Legacy Codes - CTEP for the disease code.

...

The following XML request shows an example for submitting reporting one study subject to site 7434 using ICD-0-3 for the disease code. Note: for ICD-0-3 studies neither <disease> and <siteDisease> are mandatory. However, if <disease> is included then <siteDisease> must be included.

...

The following XML request shows an example for submitting reporting one study subject to site 7434 using ICD-O-3 for the disease code with <disease> and <siteDisease> included.

...

This operation updates accrual counts for a participating site on an Abbreviated (Industrial) trialstudy.

HTTP Method

PUT

URL

Three options are available:

  1. /sites/{siteID}/count?count={count}&cutOffDt={cutOffDate}
    1. {siteID}. CTRP numeric identifier of a participating site.
    2. {count}. Mandatory parameter. The accrual count for the site.
    3. {cutOffDate} . The cut-off date for the accrual count, in the format MM-DD-YYYY.
    4. Example: https://trials-stage.nci.nih.gov/accrual-services/sites/28577/count?count=10&cutOffDt=03-10-2015 
  2. /trials/{idType}/{trialID}/sites/po/{poid}/ count?count={count}&cutOffDt={cutOffDate}
    1. {idType}. Type of identifier you want to use to identify a trial in study in CTRP. Possible values: pa, nci, ctep, dcp.
    2. {trialID}. Trial identifier value itself.
    3. {poid}. PO identifier of the organization that is the site on the trialstudy.

    4. {count}. Mandatory parameter. The accrual count for the site.
    5. {cutOffDate} . The cut-off date for the accrual count, in the format MM-DD-YYYY.
    6. Example: https://trials-int.nci.nih.gov/accrual-services/trials/nci/NCI-2018-03045/sites/po/7434/count?count=10&cutOffDt=03-10-2015
  3. /trials/{idType}/{trialID}/sites/ctep/{id}/ count?count={count}&cutOffDt={cutOffDate}
    1. {idType}. Type of identifier you want to use to identify a trial in study in CTRP. Possible values: pa, nci, ctep, dcp.
    2. {trialID}. Trial identifier value itself.
    3. {id}. CTEP identifier of the organization that is the site on the trialstudy.

    4. {count}. Mandatory parameter. The accrual count for the site.
    5. {cutOffDate} . The cut-off date for the accrual count, in the format MM-DD-YYYY.
    6. Example: https://trials-int.nci.nih.gov/accrual-services/trials/nci/NCI-2018-03045/sites/ctep/WQ456/count?count=20&cutOffDt=03-10-2015 

...

  1. /sites/{siteID}/subjects/{subjectID}
    1. {siteID}. CTRP numeric identifier of a participating site
    2. {subjectID}. Study subject identifier
    3. Example: https://trials-stage.nci.nih.gov/accrual-services/sites/28577/subjects/SU001
  2. /trials/{idType}/{trialID}/sites/po/{poid}/subjects/{subjectID}
    1. {idType}. Type of identifier you want to use to identify a trial in study in CTRP. Possible values: pa, nci, ctep, dcp.
    2. {trialID}. Trial identifier value itself
    3. {poid}. PO identifier of the organization that is the site on the trialstudy

    4. {subjectID}. Study subject identifier
    5. Example: https://trials-stage.nci.nih.gov/accrual-services/trials/nci/NCI-2014-00233/sites/po/7434/subjects/SU001
  3. /trials/{idType}/{trialID}/sites/ctep/{ctepID}/subjects/{subjectID}
    1. {idType}. Type of identifier you want to use to identify a trial in study in CTRP. Possible values: pa, nci, ctep, dcp .
    2. {trialID}. Trial identifier value itself
    3. {ctepID}. CTEP identifier of the organization that is the site on the trialstudy

    4. {subjectID}. Study subject identifier
    5. Example: https://trials-stage.nci.nih.gov/accrual-services/trials/nci/NCI-2014-00233/sites/ctep/WQ456/subjects/SU001

...

Code Response
200Success
400Validation error
404Study subject not found
500Internal server error

...

Report CDUS Batch File for Asynchronous Processing

Refer to the following on batch file formats: Complete Trial Data Record FormatsAbbreviated Trial Data Record Formats

...

With this operation, you can upload a CDUS batch file. The system processes this file asynchronously and sends the results of processing by email to the submitting userreporting user.

HTTP Method 

Post

URL

/batch

...

In this example, consider the following CDUS Accrual information for a typical CDUS Accrual file:

...


How to Construct the Body:

...

  • Convert the CDUS Accrual information to Base64 encoding. You can do so using Base64 Encoding feature in the Notepad++ application. (Other tools can be found here: https://www.google.com/#q=base64+encoding+tool

    Multiexcerpt include
    MultiExcerptNameExitDisclaimer
    nopaneltrue
    PageWithExcerptwikicontent:Exit Disclaimer to Include
    .) If you convert the above example information, the result would be as follows:

    Code Block
    IkNPTExFQ1RJT05TIiwiTkNJLTIwMTQtMDI1OTMiLCwsLCwsLCwsDQoiUEFUSUVOVFMiLCJOQ0ktMjAxNC0wMjU5MyIsImcyIiwiMjA4NTAiLCJVUyIsIjE5ODAwMyIsIk1hbGUiLCJOb3QgUmVwb3J0ZWQiLCJNZWRpY2FpZCBhbmQgTWVkaWNhcmUiLCIyMDE0MDkzMCIsLCIxMjA4OTQiLCwsLCwsLCwsLCIyNTAuMDIiLCwNCiJQQVRJRU5UX1JBQ0VTIiwiTkNJLTIwMTQtMDI1OTMiLCJnMiIsIldoaXRlIg== 
  • Insert the Base64 encoded text between <batchFile xmlns="gov.nih.nci.accrual.webservices.types"> and </batchFile> tags, as follows:

    Code Block
    <batchFile xmlns="gov.nih.nci.accrual.webservices.types">IkNPTExFQ1RJT05TIiwiTkNJLTIwMTQtMDI1OTMiLCwsLCwsLCwsDQoiUEFUSUVOVFMiLCJOQ0ktMjAxNC0wMjU5MyIsImcyIiwiMjA4NTAiLCJVUyIsIjE5ODAwMyIsIk1hbGUiLCJOb3QgUmVwb3J0ZWQiLCJNZWRpY2FpZCBhbmQgTWVkaWNhcmUiLCIyMDE0MDkzMCIsLCIxMjA4OTQiLCwsLCwsLCwsLCIyNTAuMDIiLCwNCiJQQVRJRU5UX1JBQ0VTIiwiTkNJLTIwMTQtMDI1OTMiLCJnMiIsIldoaXRlIg==</batchFile>
  • ...