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

Versions Compared

Key

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

...

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

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 one of these data formats : 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.

...

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/HTML/XML/JSON

 

 

 

 

 

 

getModalityValues

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

CSV/HTML/XML/JSON

Collection (O)

BodyPartExamined (O)

Modality (O)

 

 

 

getBodyPartValues

Set of all body part names filtered by query keys

CSV/HTML/XML/JSON

Collection (O)

BodyPartExamined (O)

Modality (O)

 

 

 

getManufacturerValues

Set of all manufacturer names filtered by query keys

CSV/HTML/XML/JSON

Collection (O)

BodyPartExamined (O)

Modality (O)

 

 

 

getPatientSet of patient objects filtered by query keysCSV/HTML/XML/JSONCollection (O)     

getPatientStudy

Set of patient/study objects filtered by query keys

CSV/HTML/XML/JSON

Collection (O)

PatientID (O)

StudyInstanceUID (O)

 

 

 

getSeries

Set of series objects filtered by query keys

CSV/HTML/XML/JSON

Collection (O)

PatientID (O)

StudyInstanceUID (O)

Modality (O)

 

 

getImages

Set of images in a zip file

ZIP

SeriesInstanceUID (R)

 

 

 

 

 

...