...
TCIA is currently in an alpha testing phase of our REST API implementation. More information will be forthcoming.
REST API URL and Format
The TCIA REST API defines one base URL for all queries: https://services.cancerimagingarchive.net/services/TCIA/TCIA/query. Each query described below will use a URL that consists of the base URL with a further specification of the resource. For example, the first query getCollectionValues will use the URL: https://services.cancerimagingarchive.net/services/TCIA/TCIA/query/getCollectionValues
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. Right now we are just supporting = for the database operator. Do we want to support some substring matching?
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 |
|
|
|
|
|
| |
getPatientStudy | Set of patient/study objects filtered by query keys | collection (O) | patient_id (O) | study_instance_uid (O) |
|
| |||||
getSeries | Set of series objects filtered by query keys | collection (O) | patient_id (O) | study_instance_uid (O) |
| ||||||
getImage | Set of images in a zip file | 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 |
|---|---|---|---|---|---|---|---|
getCollectionValues | Set of all collection names | collection (O) | modality (O) | body_part (O) | manufacturer (O) manufacturer |
|
|
getModalityValues | Set of all modality values (CT, MR, ...) filtered by query keys | collection (O) | modality (O) | body_part (O) | manufacturer (O) |
|
|
getBodyPartValues | Set of all body part names filtered by query keys | collection (O) | modality (O) | body_part (O) | manufacturer (O) |
|
|
getManufacturerValues | Set of all manufacturer names filtered by query keys | collection (O) | modality (O) | body_part (O) | manufacturer (O) |
|
|
getPatientStudy | Set of patient/study objects filtered by query keys | collection (O) | modality (O) | body_part (O) | manufacturer (O) | patient ID _id (O) | study_instance_uid (O) Study Instance UID |
getSeries | Set of series objects filtered by query keys | collection (O) | modality (O) | body_part (O) | manufacturer (O) | patient ID | study_instance_uid (O) Study Instance UID |
getImages | Set of images in a zip file Series | Instance UID series_instance_uid (R) |
|
|
|
|
|
Return Values
PatientStudy
...