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

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Summary

TCIA is currently in an alpha testing phase of our REST API implementation.  More information will be forthcoming.

REST API Directory

Query Name

Return Values

Query Key 1

Query Key 2

Query Key 3

Query Key 4

Query Key 5

Query Key 6

getCollectionValues

Set of all collection names filtered by query keys

collection

modality

body part

manufacturer

 

 

getModalityValues

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

collection

modality

body part

manufacturer

 

 

getBodyPartValues

Set of all body part names filtered by query keys

collection

modality

body part

manufacturer

 

 

getManufacturerValues

Set of all manufacturer names filtered by query keys

collection

modality

body part

manufacturer

 

 

getPatientStudy

Set of patient/study objects filtered by query keys

collection

modality

body part

manufacturer

patient ID

Study Instance UID

getSeries

Set of series objects filtered by query keys

collection

modality

body part

manufacturer

patient ID

Study Instance UID

getImages

Set of images in a zip file

Series Instance UID

 

 

 

 

 

Return Values

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 as part of submission process.

patient_sex

0010 0040

Standard DICOM definition

ethnic_group

0010 2160

 

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.

trial_subject_id

 

 

trial_site_id

 

 

trial_site_name

 

 

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.

study_desc

0008 1030

 

admitting_diagnoses_desc

0008 1080

 

study_id

0020 0010

Has been de-identified as part of submission process.

patient_age

0010 1010

 

series_in_study

Computed

 

modalities_in_study

Computed

 

Series

An object that represents one imaging series.

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

 

series_desc

0008 103E

 

body_part_examined

0018 0015

 

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.

site

NA

 

images_in_series

Computed

 

  • No labels