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

 

 

 

 

 

 

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

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

VisibilityNA

A label used to identify visibility of a series.

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.

 

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

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.

Image

...

.

...

AttributeDICOM TagDescription
NANASet of images in a zip file

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

...