Versions Compared

Key

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

Summary

This document describes v2 v4 of the TCIA programmatic Interface or  REST API implementation.  This API is designed for use by developers of image analysis and data mining tools to directly query the public resources of TCIA and retrieve information into their applications.   The API complements the existing web interface but eliminates the need for users to visit the TCIA web pages to select and download images then upload them into their viewing and analysis applications. The TCIA Programmatic Interface is based on a middleware platform called Project Bindaas, developed by Emory University and uses REST web service technologies.

The API is a RESTful interface, accessed through web URLs.   There is no software that an application developer needs to download in order to use the API. The application developer can build their own access routines using just the API documentation provided.  The The interface employs a set of predefined query functions (see REST API Directory) that access TCIA databases.

If you are interested in using the API and have any questions, please contact us at cancerimagingarchive@mailhelp@cancerimagingarchive.nih.gov.

API Reference

 

a

 

 

Incorporating the TCIA Programmatic Interface into Your Application

net.

Previously access to the APIs required an API-KEY.  An Your software that uses the programmatic interface requires an API-KEY. In this version of the programmatic interface, the API-KEY is used no longer required to identify the software application. You can obtain one API-KEY and use that for your application; you do not need a separate API-KEY for each user of your software..  To obtain an API-Key please send a request to help@cancerimagingarchive.net  or contact TCIA's help desk by phone at: +1 314-747-4254.  Please see the coding examples in github: https://github.com/nadirsaghar/TCIA-REST-API-Client for guidance on how to incorporate the API-Key into your code.  Once you have acquired an API-Key you will need to implement a minimal amount of software in your application to invoke the REST API.

REST API URL and Format

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:

Code Block
https://services.cancerimagingarchive.net/services/TCIA/TCIA/query/getSeries?Collection=TCGA-GBM&PatientID=1.2.3&StudyInstanceUID=4.5.6&format=csv

...

access the public TCIA collections.

What's new

The following characteristics apply to all TCIA APIs.

Version 4 (current)

  • The getSeries API has been modified to include new query parameters.
  • Bug fixes.

Version 3 (Documentation for Version 3 can be found here)

  • Two new APIs have been added (/getSingleImage, /getSOPInstanceUIDs).
  • Three new APIs have been added (/NewPatientsInCollection, /NewStudiesInPatientsCollection, /PatientsByModality).
  • The getSeries API has been modified to include new query parameters.
  • Bug fixes.

Version 2 (Documentation for Version 2 can be found here)

  • You can access the metadata of an API by appending /metadata to the end of a QueryEndpoint, without any QueryParameters (See below). The metadata is in JSON format and conforms to this schema.
  • Most APIs can return results as CSV/JSON/XML/HTML. You can specify the return format by including the query parameter format.

Getting Started with the TCIA API

Getting access to the API:

  • Previously access to the APIs required an API-KEY.  An API-KEY is no longer required to access the public TCIA collections. Simply call the RESTful endpoints.
  •  To support existing code without changes, an API-KEY can be included in the url by adding an extra query parameter api_key or it can be included in the HTTP headers.  Since the API-KEY is no longer needed, the underlying service will simply ignore it.

The following characteristics apply to all TCIA APIs:

  • You access a resource by sending an HTTP request to the TCIA API server. The server replies with a response that either contains the data you requested, or a status indicator.
  • You can access the metadata of an API by appending /metadata to the end of the query. See examples. The metadata is in JSON format and conforms to this schema
  • Most APIs can return results as CSV/JSON/XML/HTML. You can specify the return format by including the query parameter format
  • An API request takes the following structure:
    <BaseURL><Resource><QueryEndpoint>?<QueryParameters><Format> 
    For example, the API shown below is a request to get all studies in the TCGA-GBM collection for patient GBM-0123 as CSV
    https://services.cancerimagingarchive.net/services/v4/TCIA/query/getPatientStudy?Collection=TCGA-GBM&PatientID=GBM-0123&format=csv
    This can be broken down as follows: 
BaseURLhttps://services.cancerimagingarchive.net/services/v4The BaseURL includes the version number of this API (v4 in this example)
Resource/TCIA
QueryEndpoint/query/getPatientStudy
Query ParametersCollection=TCGA-GBM &
PatientID=GBM-0123

Formatformat=csvSome APIs support CSV/HTML/XML/JSON, while others only support a single return type.
Therefore this is required only in instances where multiple return types are supported.
  • Coding examples and a SDK (in Python & Java) can be found on here
  • Interface documentation can be found on Mashape. The table below contains the most up-to-date documentation of the API. 
  • The interface is registered on ProgrammableWeb

API Reference

The full API consists of a base URL followed by the api and the query parameters in that order. 

ResourceQueryEndpoint

Query Parameters

All query parameters are
optional unless stated otherwise
 

Format

Description
/TCIA





/query/getCollectionValuesNoneCSV/HTML/XML/JSONSet of all collection names

/query/getModalityValuesCollection / BodyPartExamined

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

With the exception of the getImage query, all other queries return one of these data formats : CSV,HTML,XML and JSON  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/HTML/XML/JSON

NA

NA

NA

NA

 

 

getModalityValues

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

CSV/HTML/XML/JSON

Collection (O)

BodyPartExamined (O)

Modality (O)

NA

 

 

getBodyPartValues

Set of all body part names filtered by query keys

CSV/HTML/XML/JSON

Collection (O)

BodyPartExamined (O)

Modality (O)

NA

 

 

getManufacturerValues

Set of all manufacturer names filtered by query keys

CSV/HTML/XML/JSON

Collection (O)

BodyPartExamined (O)

Modality (O)

NA

 

 

getPatientSet of patient objects filtered by query keys
CSV/HTML/XML/JSON
Collection (O)NANANa  

getPatientStudy

Set of patient/study objects filtered by query keys

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

/query/getBodyPartValuesCollection / ModalityCSV/HTML/XML/JSONSet of all body part names filtered by query keys

/query/getManufacturerValuesCollection / Modality /
BodyPartExamined
CSV/HTML/XML/JSON

Collection (O)

PatientID (O)

StudyInstanceUID (O)

NA

 

 

Set of all manufacturer names filtered by query keys

/query/getPatientCollectionCSV/HTML/XML/JSONSet of patient objects filtered by query keys

/query/PatientsByModalityCollection (R)
Modality (R
CSV/HTML/XML/JSON

Returns a list of PatientIDs, given a specific Collection Name and Modality


/query/getPatientStudyCollection / PatientID /
StudyInstanceUID

getSeries

Set of series objects filtered by query keys

CSV/HTML/XML/JSON

Collection (O)

PatientID (O)

StudyInstanceUID (O)

Modality (O)

 

 

getSeriesSizeSet of total byte size and object count filtered by query key
CSV/HTML/XML/JSON
SeriesInstanceUID (R)

NA

NA

NA

  
Set of patient/study objects filtered by query keys

/query/getSeries

Collection / StudyInstanceUID /
PatientID / SeriesInstanceUID /
Modality / BodyPartExamined /
ManufacturerModelName /
Manufacturer

CSV/HTML/XML/JSONSet of series objects filtered by query keys

/query/getSeriesSize

getImage

Set of images in a zip file

ZIP
SeriesInstanceUID (R)

NA

NA

NA

 

 

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.
Expand
titlePatientStudy

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.

SeriesCountNAComputed number of series.
   
   
   
   
   
   
   
   
   
   
   
   
   
   

 

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.

...

An object that represents set of total byte size and object count filtered by query key SeriesInstanceUID.

AttributeDICOM TagDescription
TotalSizeInBytesNATotal byte size per series
ObjectCountNACount of total objects per 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
Production https://services.cancerimagingarchive.net/services/TCIA/TCIA/query
Test https://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

StudyInstanceUIDStudyDateStudyDescriptionAdmittingDiagnosesDescriptionStudyIDPatientAgePatientIDPatientNamePatientBirthDatePatientSexEthnicGroupCollectionSeriesCount
1.3.6.1.4.1.14519.5.2.1.3344.4004.4483581302664837903905810182401995-02-26CT Urogram with 3DNULLNULLNULLTCGA-CW-6088TCGA-CW-6088NULLMNULLTCGA-KIRC3
1.3.6.1.4.1.14519.5.2.1.4792.2001.6275775188861537552263837821622008-10-18Digital Right Mammogram DiagnosticNULLNULL029YBreastDx-01-0070NULLNULLFNULLBREAST-DIAGNOSIS5
1.3.6.1.4.1.14519.5.2.1.9203.4004.2616882243665039470855251168201991-12-07FORFILE CD MR ABDOMENNULLNULL072YTCGA-BP-5198TCGA-BP-5198NULLMNULLTCGA-KIRC8
1.3.6.1.4.1.14519.5.2.1.5826.4003.897160909780395368971006445736 2002-12-19NR MRI BRAIN W/WONULLNULL042YTCGA-FG-8186TCGA-FG-8186NULLFNULLTCGA-LGG3
1.3.6.1.4.1.9328.50.4.10415 2000-01-01CT SCREENING VIRT COLONOSCOPYNULL1056Y1.3.6.1.4.1.9328.50.4.00111.3.6.1.4.1.9328.50.4.0011NULLMNULLCT COLONOGRAPHY1
1.3.6.1.4.1.14519.5.2.1.6279.6001.6272752011926753262157424983712000-01-01NULLNULLNULL LIDC-IDRI-0077NULLNULLNULLNULLLIDC-IDRI1
1.3.6.1.4.1.14519.5.2.1.7695.4001.2183610890005329623548517135892001-06-06MSTEALTHNULLNULL030YTCGA-08-0355NULLNULLFNULLTCGA-GBM1
1.3.6.1.4.1.9328.50.17.1711695030150124843657753733479717035432006-05-07NULLNULLNULL000YRIDER-1009463841218236NULLNULLNULLRIDER Lung PET-CT3
1.3.6.1.4.1.14519.5.2.1.7777.4007.2070993776756119135729502872221992-09-01CT Chest withNULLNULL060YTCGA-24-1423TCGA-24-1423NULLFNULLTCGA-OV2
1.3.6.1.4.1.14519.5.2.1.5099.8010.1999200869208231717064549032511999-08-23Neck^HeadNeckPETCTNULLNULL000D0522c00010522c0001NULLFNULLHead-Neck Cetuximab1
1.3.6.1.4.1.14519.5.2.1.4334.1501.1115589256377782588181959247981991-07-17CT CHEST W CONTRASTNULLNULL062YGSM714069GSM714069NULL0NULLNSCLC Radiogenomics2
1.3.6.1.4.1.14519.5.2.1.9203.4002.2591722375720971881289511163912002-08-10NULLNULLNULL041YTCGA-AO-A03VTCGA-AO-A03VNULLFNULLTCGA-BRCA1
1.3.12.2.1107.5.2.31.30165.300000080831154544671000000072008-08-31Physics^EFJ NCINULL1018YZZ083108CZZ RIDER 31990-01-01MNULLRIDER PHANTOM MRI7
1.3.6.1.4.1.14519.5.2.1.8421.4010.1947039462769837777211828391512001-12-12MRI ABD W+WO CONTNULLNULL052YTCGA-B9-4115TCGA-B9-4115NULLMNULLTCGA-KIRP1
1.2.840.113619.2.55.3.1602280607.497.1169961245.4592007-01-27NULLNULL2324000YSNMCB04SNMCB04NULLNULLNULLRIDER PHANTOM PET-CT1
1.3.6.1.4.1.14519.5.2.1.4792.2001.2065523960385364588124118158562008-09-09MRI Right Breast with and without ContrastNULLNULLNULLBreastDx-01-0070NULLNULLFNULLBREAST-DIAGNOSIS2
             
             

Series

SeriesInstanceUIDStudyInstanceUIDModalityProtocolNameSeriesDateSeriesDescriptionBodyPartExaminedSeriesNumberAnnotationsFlagCollectionPatientIDManufacturerManufacturerModelNameSoftwareVersionsImageCount
1.3.6.1.4.1.14519.5.2.1.3344.4004.1356286754499027682482307736681.3.6.1.4.1.14519.5.2.1.3344.4004.448358130266483790390581018240CRNULL1995-02-26projection urogramKidney3002NULLTCGA-KIRCTCGA-CW-6088FUJI PHOTO FILM Co., ltd.NULLNULL1
1.3.6.1.4.1.14519.5.2.1.3344.4004.2459165390705186263428175238331.3.6.1.4.1.14519.5.2.1.3344.4004.448358130266483790390581018240CRNULL1995-02-26projection urogramKidney3001NULLTCGA-KIRCTCGA-CW-6088FUJI PHOTO FILM Co., ltd.NULLNULL1
1.3.6.1.4.1.14519.5.2.1.3344.4004.6953626872392950785233791591021.3.6.1.4.1.14519.5.2.1.3344.4004.448358130266483790390581018240CRNULL1995-02-26projection urogramKidney3003NULLTCGA-KIRCTCGA-CW-6088FUJI PHOTO FILM Co., ltd.NULLNULL1
1.3.6.1.4.1.14519.5.2.1.4792.2001.1166298323954169853792825827471.3.6.1.4.1.14519.5.2.1.4792.2001.627577518886153755226383782162MGR CC2008-10-18R CCBREAST1NULLBREAST-DIAGNOSISBreastDx-01-0070LORADLorad SeleniaAWS:MAMMODROC_3_4_1_81
1.3.6.1.4.1.14519.5.2.1.4792.2001.3152771464797987992634160438441.3.6.1.4.1.14519.5.2.1.4792.2001.627577518886153755226383782162MGR ML2008-10-18R MLBREAST5NULLBREAST-DIAGNOSISBreastDx-01-0070LORADLorad SeleniaAWS:MAMMODROC_3_4_1_81
1.3.6.1.4.1.14519.5.2.1.4792.2001.3256714945149714134596668723531.3.6.1.4.1.14519.5.2.1.4792.2001.627577518886153755226383782162MGR LM2008-10-18R LMBREAST5NULLBREAST-DIAGNOSISBreastDx-01-0070LORADLorad SeleniaAWS:MAMMODROC_3_4_1_81
1.3.6.1.4.1.14519.5.2.1.4792.2001.4551196346072094679000402651611.3.6.1.4.1.14519.5.2.1.4792.2001.627577518886153755226383782162MGR CC2008-10-18R CCBREAST1NULLBREAST-DIAGNOSISBreastDx-01-0070LORADLorad SeleniaAWS:MAMMODROC_3_4_1_81
1.3.6.1.4.1.14519.5.2.1.4792.2001.9651217498955190801815714607141.3.6.1.4.1.14519.5.2.1.4792.2001.627577518886153755226383782162MGR MLO2008-10-18R MLOBREAST6NULLBREAST-DIAGNOSISBreastDx-01-0070LORADLorad SeleniaAWS:MAMMODROC_3_4_1_81
1.3.6.1.4.1.14519.5.2.1.4792.2001.2612922368716317555398191273311.3.6.1.4.1.14519.5.2.1.4792.2001.206552396038536458812411815856MRT2W_TSE SENSE2008-09-09T2W_TSE SENSEBREAST301NULLBREAST-DIAGNOSISBreastDx-01-0070Philips Medical SystemsAchieva2.6.384
1.3.6.1.4.1.14519.5.2.1.4792.2001.6197964751784050062735043143521.3.6.1.4.1.14519.5.2.1.4792.2001.206552396038536458812411815856MRSTIR SENSE2008-09-09STIR SENSEBREAST401NULLBREAST-DIAGNOSISBreastDx-01-0070Philips Medical SystemsAchieva2.6.384
1.3.6.1.4.1.14519.5.2.1.9203.4004.1371770996584217041458638954931.3.6.1.4.1.14519.5.2.1.9203.4004.261688224366503947085525116820MRT2_FASE AX-KID1991-12-07T2 FASE AX-KIDKIDNEY10NULLTCGA-KIRCTCGA-BP-5198TOSHIBA_MECMRT200PP3V8.01*R24220
1.3.6.1.4.1.14519.5.2.1.9203.4004.1432879886441475188801177829801.3.6.1.4.1.14519.5.2.1.9203.4004.261688224366503947085525116820MRT2_FASE COR-KID1991-12-07T2 FASE COR-KIDKIDNEY6NULLTCGA-KIRCTCGA-BP-5198TOSHIBA_MECMRT200PP3V8.01*R24216
1.3.6.1.4.1.14519.5.2.1.9203.4004.1970579527975977512158161058421.3.6.1.4.1.14519.5.2.1.9203.4004.261688224366503947085525116820MRAX T2 FSAT-KID1991-12-07AX T2 FSAT-KIDKIDNEY9NULLTCGA-KIRCTCGA-BP-5198TOSHIBA_MECMRT200PP3V8.01*R24220
1.3.6.1.4.1.14519.5.2.1.9203.4004.1979008221683662448605881962271.3.6.1.4.1.14519.5.2.1.9203.4004.261688224366503947085525116820MRCOR T2 FSAT-KID1991-12-07COR T2 FSAT-KIDKIDNEY7NULLTCGA-KIRCTCGA-BP-5198TOSHIBA_MECMRT200PP3V8.01*R24216
1.3.6.1.4.1.14519.5.2.1.9203.4004.3071017514424960572175063315771.3.6.1.4.1.14519.5.2.1.9203.4004.261688224366503947085525116820MRCOR  LOC1991-12-07COR LOCKIDNEY1NULLTCGA-KIRCTCGA-BP-5198TOSHIBA_MECMRT200PP3V8.01*R2425
1.3.6.1.4.1.14519.5.2.1.9203.4004.3109293257602384603960808038811.3.6.1.4.1.14519.5.2.1.9203.4004.261688224366503947085525116820MRAX FE IN/OUT PH-KID1991-12-07AX FE IN/OUT PH-KIDKIDNEY8NULLTCGA-KIRCTCGA-BP-5198TOSHIBA_MECMRT200PP3V8.01*R24240
1.3.6.1.4.1.14519.5.2.1.9203.4004.3375416987600180031617214419101.3.6.1.4.1.14519.5.2.1.9203.4004.261688224366503947085525116820MR2 PLANE LOC1991-12-072 PLANE LOCKIDNEY2NULLTCGA-KIRCTCGA-BP-5198TOSHIBA_MECMRT200PP3V8.01*R2428
1.3.6.1.4.1.14519.5.2.1.9203.4004.8674322927397324873442022984521.3.6.1.4.1.14519.5.2.1.9203.4004.261688224366503947085525116820MRAX T2 FSE-ABDOMEN1991-12-07AX T2 FSE-ABDOMENKIDNEY5NULLTCGA-KIRCTCGA-BP-5198TOSHIBA_MECMRT200PP3V8.01*R24220
1.3.6.1.4.1.14519.5.2.1.5826.4003.2344403248365861392334580338271.3.6.1.4.1.14519.5.2.1.5826.4003.897160909780395368971006445736MRlocalizer2002-12-19localizerBRAIN1NULLTCGA-LGGTCGA-FG-8186SiemensVeriosyngo MR B173
1.3.6.1.4.1.14519.5.2.1.5826.4003.2808753794405197529226112460131.3.6.1.4.1.14519.5.2.1.5826.4003.897160909780395368971006445736MRT2 AX2002-12-19T2 AXBRAIN3NULLTCGA-LGGTCGA-FG-8186SiemensVeriosyngo MR B1731
1.3.6.1.4.1.14519.5.2.1.5826.4003.2824850915760252781249855689771.3.6.1.4.1.14519.5.2.1.5826.4003.897160909780395368971006445736MRT2 COR2002-12-19T2 CORBRAIN4NULLTCGA-LGGTCGA-FG-8186SiemensVeriosyngo MR B1740
1.3.6.1.4.1.9328.50.4.104161.3.6.1.4.1.9328.50.4.10415CTVIRTUAL COLON/Abdomen/HxNULLSUPINECOLON271NULLCT COLONOGRAPHY1.3.6.1.4.1.9328.50.4.0011PhilipsBrilliance 401.2.3575
1.3.6.1.4.1.14519.5.2.1.6279.6001.2529880520610802517487601618421.3.6.1.4.1.14519.5.2.1.6279.6001.627275201192675326215742498371DXNULL2000-01-01 NULLCHEST3001583NULLLIDC-IDRILIDC-IDRI-0077"GE Healthcare""Thunder Platform"DM_Platform_Magic_Release_Patch_1-4.3-22
1.3.6.1.4.1.14519.5.2.1.7695.4001.1720739032173683343281014567361.3.6.1.4.1.14519.5.2.1.7695.4001.218361089000532962354851713589MRNULL2001-06-06Summary SeriesBRAIN1102NULLTCGA-GBMTCGA-08-0355GESIGNA_1.5T937
1.3.6.1.4.1.9328.50.17.1097904963401423047007416351710892343451.3.6.1.4.1.9328.50.17.171169503015012484365775373347971703543CTNULL2006-05-07CT 2.5mm cb02CHEST2NULLRIDER Lung PET-CTRIDER-1009463841GE MEDICAL SYSTEMSDiscovery STEpet_vct_hp.8065
1.3.6.1.4.1.9328.50.17.2093661948448020362927148364286531442681.3.6.1.4.1.9328.50.17.171169503015012484365775373347971703543PTNULL2006-05-073D FBP H10 5min cb02CHEST401NULLRIDER Lung PET-CTRIDER-1009463841GE MEDICAL SYSTEMSDiscovery STE41.0447
1.3.6.1.4.1.9328.50.17.233714402478328244081052726996544897291.3.6.1.4.1.9328.50.17.171169503015012484365775373347971703543PTNULL2006-05-075min 3D OSEM 8it28sub 7MM CB02CHEST402NULLRIDER Lung PET-CTRIDER-1009463841GE MEDICAL SYSTEMSDiscovery STE41.0447
1.3.6.1.4.1.14519.5.2.1.7777.4007.2485741922486374487438868832311.3.6.1.4.1.14519.5.2.1.7777.4007.207099377675611913572950287222CT02_CAP_ONERUN1992-09-01CAP  5.0  B60fOVARY4NULLTCGA-OVTCGA-24-1423SIEMENSSensation 64syngo CT 2007S55
1.3.6.1.4.1.14519.5.2.1.7777.4007.2879785417052113572221939629121.3.6.1.4.1.14519.5.2.1.7777.4007.207099377675611913572950287222CT02_CAP_ONERUN1992-09-01CAP  5.0  B20fOVARY3NULLTCGA-OVTCGA-24-1423SIEMENSSensation 64syngo CT 2007S129
1.3.6.1.4.1.14519.5.2.1.5099.8010.4272643008509657372628600555801.3.6.1.4.1.14519.5.2.1.5099.8010.199920086920823171706454903251CTHeadNeckPETCT1999-08-23CT 5.0 H30sHEADNECK2NULLHead-Neck Cetuximab0522c0001SIEMENSEmotionVA40C113
1.3.6.1.4.1.14519.5.2.1.4334.1501.1101411719277808197296282237691.3.6.1.4.1.14519.5.2.1.4334.1501.111558925637778258818195924798CT5.1 ROUTINE CHEST W/CON1991-07-172.5MM AXIAL CHEST STD ALG.LUNG4NULLNSCLC RadiogenomicsGSM714069GE MEDICAL SYSTEMSLightSpeed VCT07MW18.4129
1.3.6.1.4.1.14519.5.2.1.4334.1501.1463805749884480174642901960171.3.6.1.4.1.14519.5.2.1.4334.1501.111558925637778258818195924798CT5.1 ROUTINE CHEST W/CON1991-07-17SCOUT CHESTLUNG1NULLNSCLC RadiogenomicsGSM714069GE MEDICAL SYSTEMSLightSpeed VCT07MW18.42
1.3.6.1.4.1.14519.5.2.1.9203.4002.2243793547923317176977966545411.3.6.1.4.1.14519.5.2.1.9203.4002.259172237572097188128951116391MRBILATERAL BREAST/12002-08-10LocalizationBREAST1NULLTCGA-BRCATCGA-AO-A03VGE MEDICAL SYSTEMSSIGNA HDx1435
1.3.12.2.1107.5.2.31.30165.2008083111550627984708535.0.0.01.3.12.2.1107.5.2.31.30165.30000008083115454467100000007MRT1 Flip = 22008-08-31T1 Flip = 2PHANTOM2NULLRIDER PHANTOM MRIZZ083108CSIEMENSEspreesyngo MR B1512
1.3.12.2.1107.5.2.31.30165.200808311155464169208602.0.0.01.3.12.2.1107.5.2.31.30165.30000008083115454467100000007MRT1 Flip = 52008-08-31T1 Flip = 5PHANTOM3NULLRIDER PHANTOM MRIZZ083108CSIEMENSEspreesyngo MR B1512
1.3.12.2.1107.5.2.31.30165.2008083111562588769508673.0.0.01.3.12.2.1107.5.2.31.30165.30000008083115454467100000007MRT1 Flip = 102008-08-31T1 Flip = 10PHANTOM4NULLRIDER PHANTOM MRIZZ083108CSIEMENSEspreesyngo MR B1512
1.3.12.2.1107.5.2.31.30165.2008083111570538055908740.0.0.01.3.12.2.1107.5.2.31.30165.30000008083115454467100000007MRT1 Flip = 152008-08-31T1 Flip = 15PHANTOM5NULLRIDER PHANTOM MRIZZ083108CSIEMENSEspreesyngo MR B1512
1.3.12.2.1107.5.2.31.30165.2008083111574514678808807.0.0.01.3.12.2.1107.5.2.31.30165.30000008083115454467100000007MRT1 Flip = 202008-08-31T1 Flip = 20PHANTOM6NULLRIDER PHANTOM MRIZZ083108CSIEMENSEspreesyngo MR B1512
1.3.12.2.1107.5.2.31.30165.2008083111582438586708870.0.0.01.3.12.2.1107.5.2.31.30165.30000008083115454467100000007MRT1 Flip = 252008-08-31T1 Flip = 25PHANTOM7NULLRIDER PHANTOM MRIZZ083108CSIEMENSEspreesyngo MR B1512
1.3.12.2.1107.5.2.31.30165.2008083111590425145308940.0.0.01.3.12.2.1107.5.2.31.30165.30000008083115454467100000007MRT1 Flip = 302008-08-31T1 Flip = 30PHANTOM8NULLRIDER PHANTOM MRIZZ083108CSIEMENSEspreesyngo MR B1512
1.3.6.1.4.1.14519.5.2.1.8421.4010.2914912404857249115616890711811.3.6.1.4.1.14519.5.2.1.8421.4010.194703946276983777721182839151MRt1_vibe_tra_p2_bh_dixon2001-12-12t1_vibe_tra_p2_bh_dixon_in_FIL NULL10NULLTCGA-KIRPTCGA-B9-4115SIEMENSAvantosyngo MR B1572
1.2.840.113619.2.131.1602280607.1169973530.46761.2.840.113619.2.55.3.1602280607.497.1169961245.459PTSNMphantom3D2007-01-273D FBP H10 5MIN CB04PHANTOM401NULLRIDER PHANTOM PET-CTSNMCB04GE MEDICAL SYSTEMSDiscovery STE41.0447
               
CSV/HTML/XML/JSONSet of total byte size and object count filtered by query key

/query/getImageSeriesInstanceUID (R)ZIPSet of images in a zip file

/query/NewPatientsInCollection

Date (R)
Collection (R

CSV/HTML/XML/JSON

Returns a set of Patients that have been added to a specified collection since a specified date.
Date is specified as (YYYY-MM-DD)
Use the getCollectionValues to get the list of available collections 


/query/NewStudiesInPatientCollectionDate (R)
Collection (R)
PatientID
CSV/HTML/XML/JSON

Returns a set of Studies that have been added to a specified collection, and optionally to a patient since a specified date

Date is specified as (YYYY-MM-DD)
Use the getCollectionValues to get the list of available collections 

/query/getSOPInstanceUIDsSeriesInstanceUID (R)CSV/HTML/XML/JSON

Return a list of SOPInstanceUID for a given series using the SeriesInstanceUID


/query/getSingleImageSeriesInstanceUID (R)
SOPInstanceUID (R)
Raw DICOM ObjectReturns a SINGLE DICOM Object that is identified by its SeriesInstanceUID and SOPInstanceUID. This API will always be used following the /getSOPInstanceUIDs
/SharedList




/query/ContentsByNamename (R)JSONGiven the name of a shared list return its contents.

API Metadata

The API now supports the ability to programmatically access the metadata about your API. This information is provided as a JSON document and includes:

Name of API
Free text description
List of Query Parameters
Supported Return Types
A description of the returned attributes: Name, DICOM Tag and Description

The returned metadata conforms to the following JSON schema

Example:
Let us say we wanted metadata for the getPatientStudy query from our earlier example. The query would look as follows:
https://services.cancerimagingarchive.net/services/v4/TCIA/query/getPatientStudy/metadata 

Or in other words, the query would have the following structure:
<BaseURL><Resource><QueryEndpoint>/metadata

(Warning) Don’t forget to include the api-key in either HTTP headers or the URL of the API.

Return Values

Click here to see more details on the return values.