Page History

Versions Compared

Key

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

...

Multiexcerpt
To use the service, you must have a valid NCI LDAP account and a CTRP account. For instructions, refer to Creating New NCI CTRP User Accounts. All service endpoints require HTTP Basic authentication with your NCI LDAP username and password.

API Specification

XML Schema

Multiexcerpt
The service uses XML for data exchange. All XML elements going in or out of the service are defined and validated against the following XML schema: accrual_ws.xsd The XML schema is well-annotated with inline documentation that explains the purpose and meaning of various elements, types, and attributes. Specific elements required for service operations are explained in the sections below.

Multiexcerpt

The service uses XML for data exchange. All XML elements going in or out of the service are defined and validated against the following XML schema:

accrual_ws.xsd

The XML schema is well-annotated with inline documentation that explains the purpose and meaning of various elements, types, and attributes. Specific elements required for service operations are explained in the sections below.

API Specification

Add/Update

...

Accruals - Subject & Partial Subject

Description

This operation submits subject (patient) Subject & Partial Subject accrual information for a specific participating site on a trial. 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 subject 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.

...

/sites/{id}
1. {id}. CTRP numeric identifier of a participating site
2. Example: https://trials-stage.nci.nih.gov/accrual-services/sites/121787425
/trials/{idType}/{trialID}/sites/po/{id}
1. {idType}. Type of identifier you want to use to identify a trial 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 trial
4. Example: https://trials-int.nci.nih.gov/accrual-services/trials/nci/NCI-2019-00038/sites/po/7434
/trials/{/{idType}/{trialID}/sites/ctep/{id}
1. {idType}. Type of identifier you want to use to identify a trial 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 trial
4. Example: https://trials-int.nci.nih.gov/accrual-services/trials/nci/NCI-2019-00038/sites/ctep/WQ456

Request Body

XML document with studySubjects root element (see XML Schema). MIME Type: application/xml.

Response Body

None (if successful) or an error message. MIME Type: text/plain.

HTTP Response Codes

...

Examples - Subject Accrual

Request XML:

The following XML request shows an example for submitting 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.

Code Block

language	html/xml
theme	Eclipse
collapse	true

<tns:studySubjects xmlns:tns="gov.nih.nci.accrual.webservices.types"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="gov.nih.nci.accrual.webservices.types ../../src/resources/ws.xsd ">
    <tns:studySubject>
        <tns:identifier>SU001</

Examples

URL: https://trials-stage.nci.nih.gov/accrual-services/sites/121787425

Request XML:

The following XML request shows an example for submitting 5 study subjects to site 121787425 using ICD9 for disease codes. Note that the “siteDisease codeSystem” is not required since the disease code used is ICD9.

Code Block

language	html/xml
theme	Eclipse
collapse	true

<tns:studySubjects xmlns:tns="gov.nih.nci.accrual.webservices.types"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="gov.nih.nci.accrual.webservices.types ../../src/resources/ws.xsd ">
    <tns:studySubject>
        <tns:identifier>SU001</tns:identifier>
        <tns:birthDate>2002-01-01</tns:birthDate>
        <tns:gender>Female</tns:gender>
        <tns:race>Black or African American</tns:race>
        <tns:ethnicity>Not Hispanic or Latino</tns:ethnicity>
        <tns:country>USA</tns:country>
        <tns:zipCode>22201</tns:zipCode>
        <tns:registrationDate>2014-01-01</tns:registrationDate>
        <tns:methodOfPayment>MEDICAID_AND_MEDICARE</tns:methodOfPayment>
        <tns:disease codeSystem="ICD9">861.20</tns:disease>        
    </tns:studySubject>
    <tns:studySubject>
        <tns:identifier>SU002</tns:identifier>
        <tns:birthDate>2002-01-01</tns:birthDate>
        <tns:gender>Male</tns:gender>
        <tns:race>Native Hawaiian or Other Pacific Islander</tns:race>
        <tns:ethnicity>Not Reported</tns:ethnicity>
        <tns:country>CAN</tns:country>
        <tns:registrationDate>2014-01-01</tns:registrationDate>
        <tns:methodOfPayment>MILITARY_OR_VETERANS</tns:methodOfPayment>
        <tns:disease codeSystem="ICD9">861.20</tns:disease>        
    </tns:studySubject>
    <tns:studySubject>
        <tns:identifier>SU003</tns:identifier>
        <tns:birthDate>2002-01-01</tns:birthDate>
        <tns:gender>Unknown</tns:gender>
        <tns:race>American Indian or Alaska Native</tns:race>
        <tns:race>Asian</tns:race>
        <tns:race>Black or African American</tns:race>
        <tns:race>Native Hawaiian or Other Pacific Islander</tns:race>
        <tns:race>Not Reported</tns:race>
        <tns:race>Unknown</tns:race>
        <tns:race>White</tns:race>        
        <tns:ethnicity>Unknown</tns:ethnicity>
        <tns:country>CAN</tns:country>
        <tns:registrationDate>2014-01-01</tns:registrationDate>
        <tns:methodOfPayment>NO_MEANS_OF_PAYMENT</tns:methodOfPayment>
        <tns:disease codeSystem="ICD9">861.20</tns:disease>     
    </tns:studySubject>
    <tns:studySubject>
        <tns:identifier>SU004</tns:identifier>
        <tns:birthDate>2002-01-01</tns:birthDate>
        <tns:gender>Unspecified</tns:gender>
        <tns:race>Native Hawaiian or Other Pacific Islander</tns:race>
        <tns:ethnicity>Not Reported</tns:ethnicity>
        <tns:country>AFG</tns:country>
        <tns:registrationDate>2011-01-01</tns:registrationDate>
        <tns:methodOfPayment>STATE_SUPPLEMENTAL</tns:methodOfPayment>
        <tns:disease codeSystem="ICD9">861.20</tns:disease>     
    </tns:studySubject>
     <tns:studySubject>
        <tns:identifier>SU005</tns:identifier>
        <tns:birthDate>1990-01-01</tns:birthDate>
        <tns:gender>Female</tns:gender>
        <tns:race>American Indian or Alaska Native</tns:race>
        <tns:race>Asian</tns:race>
        <tns:race>Black or African American</tns:race>   <tns:birthDate>1990-01-01</tns:birthDate>
        <tns:gender>Female</tns:gender>
        <tns:race>American Indian or Alaska Native</tns:race>
        <tns:race>Asian</tns:race>
        <tns:race>Black or African American</tns:race>
        <tns:race>Native Hawaiian or Other Pacific Islander</tns:race>
        <tns:race>Not Reported</tns:race>
        <tns:race>Unknown</tns:race>
        <tns:race>White</tns:race>      
        <tns:ethnicity>Hispanic or Latino</tns:ethnicity>
        <tns:country>USA</tns:country>
        <tns:zipCode>22222</tns:zipCode>
        <tns:registrationDate>2014-01-01</tns:registrationDate>
        <tns:methodOfPayment>MANAGED_CARE</tns:methodOfPayment>
        <tns:disease codeSystem="ICD9">011.41</tns:disease>     
    </tns:studySubject>
</tns:studySubjects>

Request XML (Specifying Topography and Morphology codes using ICD-O-3)

The following XML request shows an example for submitting 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.

Code Block

language	html/xml
theme	Eclipse
collapse	true

<tns:studySubjects xmlns:tns="gov.nih.nci.accrual.webservices.types"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="gov.nih.nci.accrual.webservices.types ../../src/resources/ws.xsd ">
    <tns:studySubject>
        <tns:race>Native Hawaiian or Other Pacific Islander<identifier>SU006</tns:race>identifier>
        <tns:race>Not Reported<birthDate>2002-01-01</tns:race>birthDate>
        <tns:race>Unknown<gender>Female</tns:race>gender>
        <tns:race>White<race>Black or African American</tns:race>      
        <tns:ethnicity>Hispanicethnicity>Not Hispanic or Latino</tns:ethnicity>
        <tns:country>USA</tns:country>
        <tns:zipCode>22222<zipCode>22201</tns:zipCode>
        <tns:registrationDate>2014-01-01</tns:registrationDate>
        <tns:methodOfPayment>MANAGEDmethodOfPayment>MEDICAID_AND_CARE<MEDICARE</tns:methodOfPayment>
        <tns:disease codeSystem="ICD9">011.41<ICD-O-3">8012/3</tns:disease>
        <tns:siteDisease codeSystem="ICD-O-3">C34.1</tns:siteDisease>
    </tns:studySubject>
</tns:studySubjects>

Request XML (Specifying Topography Disease and Morphology Site Disease codes using ICD-O-3Legacy Codes - CTEP)

Code Block

language	html/xml
theme	Eclipse
collapse	true

<tns:studySubjects xmlns:tns="gov.nih.nci.accrual.webservices.types"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="gov.nih.nci.accrual.webservices.types ../../src/resources/ws.xsd ">
    <tns:studySubject>
        <tns:identifier>SU006<identifier>SU007</tns:identifier>
        <tns:birthDate>2002-01-01</tns:birthDate>
        <tns:gender>Female</tns:gender>
        <tns:race>Blackrace>American Indian or AfricanAlaska American<Native</tns:race>
        <tns:ethnicity>Not Hispanic or Latino</tns:ethnicity>
        <tns:country>USA</tns:country>
        <tns:zipCode>22201</tns:zipCode>
        <tns:registrationDate>2014-01-01</tns:registrationDate>
        <tns:methodOfPayment>MEDICAIDmethodOfPayment>MANAGED_AND_MEDICARE<CARE</tns:methodOfPayment>
        <tns:disease codeSystem="ICD-O-3">8012/3</tns:disease>
        <tns:siteDisease codeSystem="ICD-O-3">C34.1</tns:siteDisease>Legacy Codes - CTEP">10001418</tns:disease>
    </tns:studySubject>
</tns:studySubjects>

Examples - Partial Accrual

Request XML

...

:

The following XML request shows an example for submitting one study subject to site 121787425 using Legacy Codes - CTEP for the disease codeto 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.

Code Block

language	html/xml
theme	Eclipse
collapse	true

<tns:studySubjects xmlns:tns="gov.nih.nci.accrual.webservices.types"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="gov.nih.nci.accrual.webservices.types ../../src/resources/ws.xsd ">
    <tns:studySubject>
        <tns:identifier>SU007<identifier>SU100</tns:identifier>
        <tns:birthDate>2002-01-01</tns:birthDate>
        <tns:gender>Female</tns:gender>
        <tns:race>American Indian or Alaska Native</tns:race>
        <tns:ethnicity>Not Hispanic or Latino</tns:ethnicity>
        <tns:country>USA</tns:country>   <tns:registrationDate>2014-01-01</tns:registrationDate>
    </tns:studySubject>
</tns:studySubjects>

Request XML:

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

Code Block

language	html/xml
theme	Eclipse
collapse	true

<tns:studySubjects xmlns:tns="gov.nih.nci.accrual.webservices.types"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="gov.nih.nci.accrual.webservices.types ../../src/resources/ws.xsd ">
    <tns:studySubject>
        <tns:zipCode>22201<identifier>SU101</tns:zipCode>identifier>
        <tns:registrationDate>2014-01-01</tns:registrationDate>
        <tns:methodOfPayment>MANAGED_CARE<		<tns:disease codeSystem="ICD-O-3">8012/3</tns:methodOfPayment>disease>
        <tns:diseasesiteDisease codeSystem="Legacy Codes - CTEP">10001418<ICD-O-3">C34.1</tns:disease>siteDisease>
    </tns:studySubject>
</tns:studySubjects>

Response Body

None (if successful) or an error message. MIME Type: text/plain.

HTTP Response Codes

Code	Response
200	Success
400	Validation error
404	Participating site not found
500	Internal server error

Update Accrual Count

Description

...

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

Examples

URL: https://trials-stage.nci.nih.gov/accrual-services/trials/nci/NCI-2014-00233/sites/po/12733422/subjects/SU001

...

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

MultiExcerptName	ExitDisclaimer
nopanel	true
PageWithExcerpt	wikicontent:Exit Disclaimer to Include

.) If you convert the above example information, the result would be as follows:

Code Block
IkNPTExFQ1RJT05TIiwiTkNJLTIwMTQtMDI1OTMiLCwsLCwsLCwsDQoiUEFUSUVOVFMiLCJOQ0ktMjAxNC0wMjU5MyIsImcyIiwiMjA4NTAiLCJVUyIsIjE5ODAwMyIsIk1hbGUiLCJOb3QgUmVwb3J0ZWQiLCJNZWRpY2FpZCBhbmQgTWVkaWNhcmUiLCIyMDE0MDkzMCIsLCIxMjA4OTQiLCwsLCwsLCwsLCIyNTAuMDIiLCwNCiJQQVRJRU5UX1JBQ0VTIiwiTkNJLTIwMTQtMDI1OTMiLCJnMiIsIldoaXRlIg==

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>

Code Block

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

Content

Space Tools

Versions Compared

Old Version 3

New Version 4

Key

API Specification

XML Schema

API Specification

Add/Update

Accruals - Subject & Partial Subject

Description

Request Body

Response Body

HTTP Response Codes

Examples - Subject Accrual

Examples

Examples - Partial Accrual

Request XML

:

Request XML:

Response Body

HTTP Response Codes

Update Accrual Count

Description

Examples