Child pages
  • TCIA Programmatic Interface (REST API) Usage Guide v1

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

Compare with Current View Page History

« Previous Version 52 Next »

Summary

TCIA is currently in an alpha testing phase of our REST API implementation.  If you are interested in participating in testing the API please contact us at cancerimagingarchive@mail.nih.gov.

REST API URL and Format

This section would benefit from an overview and architecture diagram. The next sections on the API assume you have that understanding.  The full API consists of a base URL followed by the api and the query parameters in that order.

For example, in the following URL:

https://services.cancerimagingarchive.net/services/TCIA/TCIA/query/getSeries?collection=TCGA-GBM&patient_id=1.2.3&study_instance_uid=4.5.6

NOTE: The order in which the query parameters are provided does not matter

With the exception of the getImage query, all other queries return a comma separated value (CSV) file with results. The first line of the file contains the names of the columns in the response. Each subsequent line corresponds to one row from the TCIA database. The getImage query returns a zip of the images.

 

REST API Directory

Query Name

Return Values

Output Format

Query Key 1

Query Key 2

Query Key 3

Query Key 4

Query Key 5

Query Key 6

getCollectionValues

Set of all collection names

CSV

 

 

 

 

 

 

getModalityValues

Set of all modality values (CT, MR, ...) filtered by query keys

CSV

Collection (O)

BodyPartExamined (O)

Modality (O)

 

 

 

getBodyPartValues

Set of all body part names filtered by query keys

CSV

Collection (O)

BodyPartExamined (O)

Modality (O)

 

 

 

getManufacturerValues

Set of all manufacturer names filtered by query keys

CSV

Collection (O)

BodyPartExamined (O)

Modality (O)

 

 

 

getPatientSet of patient objects filtered by query keysCSVCollection (O)     

getPatientStudy

Set of patient/study objects filtered by query keys

CSV

Collection (O)

PatientID (O)

StudyInstanceUID (O)

 

 

 

getSeries

Set of series objects filtered by query keys

CSV

Collection (O)

PatientID (O)

StudyInstanceUID (O)

Modality (O)

 

 

getImages

Set of images in a zip file

ZIP

SeriesInstanceUID (R)

 

 

 

 

 

Return Values

Collection

An object that represents Collection (project) values.

AttributeDICOM TagDescription
CollectionNA

A label used to name a set of images collected for a specific trial or other reason.
Assigned during the process of curating the data.

Modality

An object that represents Modality values.

AttributeDICOM TagDescription
Modality0008 0060Standard DICOM definition

BodyPartExamined

An object that represents BodyPartExamined values.

AttributeDICOM TagDescription
BodyPartExamined0018 0015Standard DICOM definition

Manufacturer

An object that represents Manufacturer values.

AttributeDICOM TagDescription
Manufacturer0008 0070Standard DICOM definition

Patient

An object that represents one patient.

Attribute

DICOM Tag

Description

PatientID

0010 0020

Has been de-identified as part of submission process.

PatientName

0010 0010

Has been de-identified as part of submission process.

PatientBirthDate

0010 0030

Has been de-identified (emptied) as part of submission process.

PatientSex

0010 0040

Standard DICOM definition

EthnicGroup

0010 2160

Standard DICOM definition

CollectionNAA label used to name a set of images collected for a specific trial or other reason.
Assigned during the process of curating the data.

PatientStudy

An object that represents one DICOM imaging study performed on one patient.

Attribute

DICOM Tag

Description

StudyInstanceUID0020 000DHas been de-identified as part of submission process.
StudyDate0008 0020Has been de-identified as part of submission process. Longitudinal information is preserved.
StudyDescription0008 1030Standard DICOM definition. Has been inspected and cleaned of any PHI
AdmittingDiagnosesDescription0008 1080Standard DICOM definition. Has been inspected and cleaned of any PHI
StudyID0020 0010Has been de-identified as part of submission process.
PatientAge0010 1010Standard DICOM definition
PatientID0010 0020

Has been de-identified as part of submission process.

PatientName0010 0010Has been de-identified as part of submission process.
PatientBirthDate

0010 0030

Has been de-identified (emptied) as part of submission process.

PatientSex

0010 0040

Standard DICOM definition

EthnicGroup

0010 2160

Standard DICOM definition

CollectionNA

A label used to name a set of images collected for a specific trial or other reason.
Assigned during the process of curating the data.

ImageCountNAComputed number of images in this study.

Series

An object that represents one imaging series.

Attribute

DICOM Tag

Description

SeriesInstanceUID

0020 000E

Has been de-identified as part of submission process.
StudyInstanceUID0020 000DHas been de-identified as part of submission process.

Modality

0008 0060

Standard DICOM definition

ProtocolName0018 1030Standard DICOM definition. Has been inspected and cleaned of any PHI
SeriesDate0008 0021Standard DICOM definition

SeriesDescription

0008 103E

Standard DICOM definition. Has been inspected and cleaned of any PHI
BodyPartExamined0018 0015Entered on a per collection basis using relevant SNOMED terms.
SeriesNumber0020 0011Standard DICOM definition
AnnotationsFlagNA 
CollectionNA

A label used to name a set of images collected for a specific trial or other reason.
Assigned during the process of curating the data.

PatientID0010 0020Has been de-identified as part of submission process.
Manufacturer0008 0070Standard DICOM definition
ManufacturerModelName0008 1090Standard DICOM definition
SoftwareVersions0018 1020Standard DICOM definition
ImageCountNAComputed number of images in this series.
   

Image

An object that represents set of images in zip file based on SeriesInstanceUID.

AttributeDICOM TagDescription
NANASet of images in a zip file

Production / Test URLs and Test Data

There are two RESTful servers provided by TCIA. A test system is loaded with a small set of known data to allow you to test your applications. The production system is configured to use the full TCIA database. The query format is the same for both systems. The base URLs are:

TypeURL
Productionhttps://services.cancerimagingarchive.net/services/TCIA/TCIA/query
Testhttps://services-test.cancerimagingarchive.net/services/TCIA/TCIA/query

 

The test server is loaded with this data:

Collections

Collection
TCGA-KIRC
BREAST-DIAGNOSIS
TCGA-LGG
CT COLONOGRAPHY
LIDC-IDRI
TCGA-GBM
RIDER Lung PET-CT
TCGA-OV
Head-Neck Cetuximab
TCGA-PRAD
NSCLC Radiogenomics
TCGA-BRCA
RIDER PHANTOM MRI
TCGA-KIRP
RIDER PHANTOM PET-CT

 

PatientStudy



 

  • No labels