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

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Update patient definition to match DICOM tag labels; still need to update the remaining objects.

...

For example, in the following URL:

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

...

Query Name

Return Values

Output Format

Query Key 1

Query Key 2

Query Key 3

Query Key 4

Query Key 5

getCollectionValues

Set of all collection names

CSV

 

 

 

 

 

getModalityValues

Set of modality values filtered by query keys

CSV

collection (O)

modality (O)

body_part_examined (O)

 

 

getBodyPartValues

Set of body parts examined filtered by query keys

CSV

collection (O)

modality (O)

body_part_examined (O)

 

 

getPatient

Set of patient objects filtered by query keys

CSV

collection (O)

 

 

 

 

getPatientStudy

Set of patient/study objects filtered by query keys

CSV

collection (O)

patient_id (O)

study_instance_uid (O)

 

 

getSeries

Set of series objects filtered by query keys

CSV

collection (O)

patient_id (O)

study_instance_uid (O)

modality (O)

 

getImage

Set of images in a zip file

ZIP

series_instance_uid (R)

 

 

 

 

...

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

collection (O)

modality (O)

body_part (O)

manufacturer (O)

 

 

getModalityValues

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

CSV

collection (O)

modality (O)

body_part (O)

manufacturer (O)

 

 

getBodyPartValues

Set of all body part names filtered by query keys

CSV

collection (O)

modality (O)

body_part (O)

manufacturer (O)

 

 

getManufacturerValues

Set of all manufacturer names filtered by query keys

CSV

collection (O)

modality (O)

body_part (O)

manufacturer (O)

 

 

getPatientStudy

Set of patient/study objects filtered by query keys

CSV

collection (O)

modality (O)

body_part (O)

manufacturer (O)

patient_id (O)

study_instance_uid (O)

getSeries

Set of series objects filtered by query keys

CSV

collection (O)

modality (O)

body_part (O)

manufacturer (O)

patient_id (O)

study_instance_uid (O)

getImages

Set of images in a zip file

ZIP

series_instance_uid (R)

 

 

 

 

 

...

Attribute

DICOM Tag

Description

patient_id PatientID

0010 0020

Has been de-identified as part of submission process.

patient_name PatientName

0010 0010

Has been de-identified as part of submission process.

patient_birth_date PatientBirthDate

0010 0030

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

patient_sex PatientSex

0010 0040

Standard DICOM definition

ethnic_group 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

patient_id

0010 0020

Has been de-identified as part of submission process.

patient_name

0010 0010

Has been de-identified as part of submission process.

patient_birth_date

0010 0030

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

patient_sex

0010 0040

Standard DICOM definition

ethnic_group

0010 2160

Standard DICOM definition

collection

NA

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.

study_instance_uid

0020 000D

Has been de-identified as part of submission process.

study_date

0008 0020

Has been de-identified as part of submission process. Longitudinal information is preserved.

study_desc

0008 1030

Standard DICOM definition. Has been inspected and cleaned of any PHI

admitting_diagnoses_desc

0008 1080

Standard DICOM definition. Has been inspected and cleaned of any PHI

study_id

0020 0010

Has been de-identified as part of submission process.

patient_age

0010 1010

Standard DICOM definition

image_count

Computed

Number of images in this study

series_in_study

Computed

A count of the number of series in this study (1, 2, 3, ..)

modalities_in_study

Computed

A list of the modalities found in this study (CT, MR, ..)

...

Attribute

DICOM Tag

Description

study_instance_uid

0020 000D

Has been de-identified as part of submission process.

series_instance_uid

0020 000E

Has been de-identified as part of submission process.

modality

0008 0060

Standard DICOM definition

protocol_name

0018 1030

Standard DICOM definition. Has been inspected and cleaned of any PHI

series_desc

0008 103E

Standard DICOM definition. Has been inspected and cleaned of any PHI

body_part_examined

0018 0015

Entered on a per collection basis using relevant SNOMED terms.

manufacturer

0008 0070

Standard DICOM definition

manufacturer_model_name

0008 1090

Standard DICOM definition

software_versions

0018 1020

Standard DICOM definition

series_number

0020 0011

Standard DICOM definition

annotations_flag

NA

 

collection

NA

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_count

Computed

A count of the number of images in this series