Summary
TCIA is currently in an alpha testing phase of our REST API implementation. More information will be forthcoming.
REST API URL and Format
The full API consists of a base URL followed by the api, the api_key and the query parameters in that order.
For example, in the following URL:
http://services.cancerimagingarchive.net:9099/services/TCIA/TCIA/query/getSeries?api_key=a9312dfe-4465-4e0b-8b76-8eeab0b77ce5&collection=TCGA-GBM&patient_id=1.2.3&study_instance_uid=4.5.6
- The base URL is: http://services.cancerimagingarchive.net:9099/services/TCIA/TCIA/query
- The API endpoint is getSeries
- The api_key is provided as follows: &api_key=a9312dfe-4235-4e0b-8b76-8fghqab0b77ce5
- And the three query parameters are provided as follows: &collection=TCGA-GBM&patient_id=1.2.3&study_instance_uid=4.5.6
NOTE: The order in which the query parameters are provided does not matter
With the exception of the getImage query, all other queries return a comma separated value (CSV) 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 (Available)
The query keys in the table below are the literal strings used as keys for key/value pairs to specify query parameters. After each key is an indication if the key is required for the query (R) or optional (O). Omitting optional keys will lead to responses that are more broad.
The api_key described above is listed as a Query Key in the table below for simplicity and completeness. It is a required part of the API for all queries. For this collection, the defined value for the api_key is:
a9312dfe-4235-4e0b-8b76-8fghqab0b77ce5
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 |
api_key (R) |
|
|
|
|
|
getPatientStudy |
Set of patient/study objects filtered by query keys |
api_key (R) |
collection (O) |
patient_id (O) |
study_instance_uid (O) |
|
|
getSeries |
Set of series objects filtered by query keys |
api_key (R) |
collection (O) |
patient_id (O) |
study_instance_uid (O) |
|
|
getImage |
Set of images in a zip file |
api_key (R) |
series_instance_uid (R) |
|
|
|
|
REST API Directory (Proposed)
Query Name |
Return Values |
Query Key 1 |
Query Key 2 |
Query Key 3 |
Query Key 4 |
Query Key 5 |
Query Key 6 |
Query Key 7 |
|---|---|---|---|---|---|---|---|---|
getCollectionValues |
Set of all collection names |
api_key (R) |
collection (O) |
modality (O) |
body_part (O) |
manufacturer (O) |
|
|
getModalityValues |
Set of all modality values (CT, MR, ...) filtered by query keys |
api_key (R) |
collection (O) |
modality (O) |
body_part (O) |
manufacturer (O) |
|
|
getBodyPartValues |
Set of all body part names filtered by query keys |
api_key (R) |
collection (O) |
modality (O) |
body_part (O) |
manufacturer (O) |
|
|
getManufacturerValues |
Set of all manufacturer names filtered by query keys |
api_key (R) |
collection (O) |
modality (O) |
body_part (O) |
manufacturer (O) |
|
|
getPatientStudy |
Set of patient/study objects filtered by query keys |
api_key (R) |
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 |
api_key (R) |
collection (O) |
modality (O) |
body_part (O) |
manufacturer (O) |
patient_id (O) |
study_instance_uid (O) |
getImages |
Set of images in a zip file |
api_key (R) |
series_instance_uid (R) |
|
|
|
|
|
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 (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. |
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 |
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, ..) |
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 |
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. |
images_in_series |
Computed |
A count of the number of images in this series |
Internal Notes
These fields in some database tables are not exposed. This section to be deleted
Patient Table
- trial_dp_pk_id
- trial_subject_id
- trial_subject_reading_id
- trial_site_pk_id
Study
- study_time
- admitting_diagnoses_code_seq
- patient_size
- patient_weight
- occupation
- additional_patient_history
Series
- series_laterality
- series_date
- general_equipment_pk_id
- trial_protocol_id
- trial_protocol_name
- trial_site_name
- study_date
- study_desc
- admitting_diagnoses_desc
- patient_age
- patient_sex
- patient_weight
- age_group
- patient_pk_id
- sync_frame_of_ref_uid
- patient_id
- frame_of_reference_uid
- visibility
- security_group
- project (AKA collection)
- site
- max_submission_timestamp