Page History
...
Multiexcerpt |
---|
Inside the NIH Firewall (VPN required)
Outside of the NIH Firewall
|
Access Requirements
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. |
...
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: 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. |
...
Code | Response |
---|---|
200 | Success |
400 | Validation error |
404 | Participating site not found |
500 | Internal server error |
Examples
URL: https://trials-devstage.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 | ||||||
---|---|---|---|---|---|---|
| ||||||
<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: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 Disease Topography and Site Disease Morphology codes using ICD-O-3)
The following XML request shows an example for submitting one study subject to site 121787425 site 121787425 using ICD-O-3 for the disease Topography code. Note that when the disease Topography <codeSystem> = “ICD-O-3”, either both the <disease> or and the <siteDisease> is are mandatory.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<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</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="ICD-O-3">8012<>8012/3</tns:disease> <tns:siteDisease codeSystem="ICD-O-3">C34.1</tns:siteDisease> </tns:studySubject> </tns:studySubjects> |
...
The following XML request shows an example for submitting one study subject to site 121787425 site 121787425 using Legacy Codes - CTEP for the disease code.
...
- /sites/{siteID}/count?count={count}&cutOffDt={cutOffDate}
- {siteID}. CTRP numeric identifier of a participating site.
- {count}. Mandatory parameter. The accrual count for the site.
- {cutOffDate} . The cut-off date for the accrual count, in the format MM-DD-YYYY.
- /trials/{idType}/{trialID}/sites/po/{poid}/ count?count={count}&cutOffDt={cutOffDate}
- {idType}. Type of identifier you want to use to identify a trial in CTRP. Possible values: pa, nci, ctep, dcp.
- {trialID}. Trial identifier value itself.
{poid}. PO identifier of the organization that is the site on the trial.
- {count}. Mandatory parameter. The accrual count for the site.
- {cutOffDate} . The cut-off date for the accrual count, in the format MM-DD-YYYY.
- /trials/{idType}/{trialID}/sites/ctep/{id}/ count?count={count}&cutOffDt={cutOffDate}
- {idType}. Type of identifier you want to use to identify a trial in CTRP. Possible values: pa, nci, ctep, dcp.
- {trialID}. Trial identifier value itself.
{id}. CTEP identifier of the organization that is the site on the trial.
- {count}. Mandatory parameter. The accrual count for the site.
- {cutOffDate} . The cut-off date for the accrual count, in the format MM-DD-YYYY.
Request Body
Non-negative numeric accrual count. MIME Type: text/plain
.None.
Response Body
None (if successful) or an error message. MIME Type: text/plain
.
...
URL Examples
https://trials-devstage.nci.nih.gov/accrual-services/accrual-services/sites/28577/count?count=10&cutOffDt=03-10-2015
https://trials-devstage.nci.nih.gov/accrual-services/trials/nci/NCI-2009-00939/sites/po/24567/count?count=10&cutOffDt=03-10-2015
https://trials-devstage.nci.nih.gov/accrual-services/trials/nci/NCI-2009-00939/sites/ctep/CA067/count?count=135&cutOffDt=03-10-2015
...
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
Submit CDUS Batch File for Asynchronous Processing
...
None (if successful) or an error message. MIME Type: text/plain
.
Example
URL: https://trials-stage.nci.nih.gov/accrual-services/batch
Content-Type: application/xml
...
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
.) If you convert the above example information, the result would be as follows:Include Page Multiexcerpt include MultiExcerptName ExitDisclaimer nopanel true PageWithExcerpt wikicontent:Exit Disclaimer to Includewikicontent:Exit Disclaimer to Include 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>