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

Versions Compared

Key

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

...

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 keysCSV/HTML/XML/JSONCollection (O)NANANa  

getPatientStudy

Set of patient/study objects filtered by query keys

CSV/HTML/XML/JSON

Collection (O)

PatientID (O)

StudyInstanceUID (O)

NA

 

 

getSeries

Set of series objects filtered by query keys

CSV/HTML/XML/JSON

Collection (O)

PatientID (O)

StudyInstanceUID (O)

Modality (O)

 

 

getImage

Set of images in a zip file

ZIP

SeriesInstanceUID (R)

NA

NA

NA

 

 

getSeriesSizeSet of total byte size and object count filtered by query keyCSV/HTML/XML/JSONSeriesInstanceUID (R)

NA

NA

NA

  

Return Values

Collection

An object that represents Collection (project) values.

...

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.
   


SeriesSize

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.

...