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 (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