|
Inside the NIH Firewall (VPN required)
Outside of the NIH Firewall
|
To use the service, you must have a valid NCI CTRP account. For instructions, refer to Creating New NCI CTRP User Accounts. All service endpoints require Okta token authentication with your NCI CTRP Client ID and Client Secret. Contact CTRP_support@nih.gov to have a NCI CTRP Client ID and Client secret generated for your CTRP REST account. See the following document for generating an Okta access token using your CTRP Client ID and Client Secret: NCI CTRP API Authentication Guide |
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. |
This operation reports Subject & Partial Subject accrual information for a specific participating site on a study. If the subject accrual record already exists for the specified study and participating site, this operation will update that record accordingly. If you 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.
PUT
Three options are available:
{id}. PO identifier of the organization that is the site on the study
{id}. CTEP identifier of the organization that is the site on the study
XML document with studySubjects
root element (see XML Schema). MIME Type: application/xml
.
Request XML:
The following XML request shows an example for 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.
<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 Topography and Morphology codes using ICD-O-3)
The following XML request shows an example for 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.
<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/3</tns:disease> <tns:siteDisease codeSystem="ICD-O-3">C34.1</tns:siteDisease> </tns:studySubject> </tns:studySubjects> |
Request XML (Specifying Disease and Site Disease codes using Legacy Codes - CTEP)
The following XML request shows an example for reporting one study subject to site 121787425 using Legacy Codes - CTEP for the disease code.
<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</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:zipCode>22201</tns:zipCode> <tns:registrationDate>2014-01-01</tns:registrationDate> <tns:methodOfPayment>MANAGED_CARE</tns:methodOfPayment> <tns:disease codeSystem="Legacy Codes - CTEP">10001418</tns:disease> </tns:studySubject> </tns:studySubjects> |
Request XML:
The following XML request shows an example for 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.
<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>SU100</tns:identifier> <tns:registrationDate>2014-01-01</tns:registrationDate> </tns:studySubject> </tns:studySubjects> |
Request XML:
The following XML request shows an example for reporting one study subject to site 7434 using ICD-O-3 for the disease code with <disease> and <siteDisease> included.
<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>SU101</tns:identifier> <tns:registrationDate>2014-01-01</tns:registrationDate> <tns:disease codeSystem="ICD-O-3">8012/3</tns:disease> <tns:siteDisease codeSystem="ICD-O-3">C34.1</tns:siteDisease> </tns:studySubject> </tns:studySubjects> |
None (if successful) or an error message. MIME Type: text/plain
.
Code | Response |
---|---|
200 | Success |
400 | Validation error |
404 | Participating site not found |
500 | Internal server error |
This operation updates accrual counts for a participating site on an Abbreviated (Industrial) study.
PUT
Three options are available:
{poid}. PO identifier of the organization that is the site on the study.
{id}. CTEP identifier of the organization that is the site on the study.
None.
None (if successful) or an error message. MIME Type: text/plain
.
Code | Response |
---|---|
200 | Success |
400 | Validation error |
401 | Authentication/Authorization Failure: invalid username/password or insufficient permissions to access the service |
404 | Participating site/study subject not found |
500 | Internal server error (includes the condition of updating/deleting a study subject that you don't have accrual access to) |
Deletes specific study subject (patient) accrual information from a participating site.
DELETE
Three options are available:
{poid}. PO identifier of the organization that is the site on the study
{ctepID}. CTEP identifier of the organization that is the site on the study
NONE
None (if successful) or an error message. MIME Type: text/plain
.
Code | Response |
---|---|
200 | Success |
400 | Validation error |
404 | Study subject not found |
500 | Internal server error |
Refer to the following on batch file formats: Complete Trial Data Record Formats, Abbreviated 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 reporting user.
Post
/batch
Example: https://trials-stage.nci.nih.gov/accrual-services/batch
Content-Type: application/xml
Accept: application/xml
XML document with batchFile root element.
In this example, consider the following CDUS Accrual information for a typical CDUS Accrual file:
"COLLECTIONS","NCI-2014-02593",,,,,,,,, "PATIENTS","NCI-2014-02593","g2","20850","US","198003","Male","Not Reported","Medicaid and Medicare","20140930",,"120894",,,,,,,,,,"250.02",, "PATIENT_RACES","NCI-2014-02593","g2","White" |
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:
IkNPTExFQ1RJT05TIiwiTkNJLTIwMTQtMDI1OTMiLCwsLCwsLCwsDQoiUEFUSUVOVFMiLCJOQ0ktMjAxNC0wMjU5MyIsImcyIiwiMjA4NTAiLCJVUyIsIjE5ODAwMyIsIk1hbGUiLCJOb3QgUmVwb3J0ZWQiLCJNZWRpY2FpZCBhbmQgTWVkaWNhcmUiLCIyMDE0MDkzMCIsLCIxMjA4OTQiLCwsLCwsLCwsLCIyNTAuMDIiLCwNCiJQQVRJRU5UX1JBQ0VTIiwiTkNJLTIwMTQtMDI1OTMiLCJnMiIsIldoaXRlIg== |
Insert the Base64 encoded text between <batchFile xmlns="gov.nih.nci.accrual.webservices.types"> and </batchFile> tags, as follows:
<batchFile xmlns="gov.nih.nci.accrual.webservices.types">IkNPTExFQ1RJT05TIiwiTkNJLTIwMTQtMDI1OTMiLCwsLCwsLCwsDQoiUEFUSUVOVFMiLCJOQ0ktMjAxNC0wMjU5MyIsImcyIiwiMjA4NTAiLCJVUyIsIjE5ODAwMyIsIk1hbGUiLCJOb3QgUmVwb3J0ZWQiLCJNZWRpY2FpZCBhbmQgTWVkaWNhcmUiLCIyMDE0MDkzMCIsLCIxMjA4OTQiLCwsLCwsLCwsLCIyNTAuMDIiLCwNCiJQQVRJRU5UX1JBQ0VTIiwiTkNJLTIwMTQtMDI1OTMiLCJnMiIsIldoaXRlIg==</batchFile> |
None (if successful) or an error message. MIME Type: text/plain
.