...
Purpose of this Guide
The This guide explains the advanced features of the National Biomedical Imaging Archive (NBIA) REST APIs allow you to access the search and download functions used in the TCIA Rdiology Portal. The NBIA Advanced REST APIs , described on this page, provide capabilities to access restricted collections, which require login authentication. They also provide advanced features that are geared towards developers seeking to integrate searching and downloading TCIA data into their own web and desktop applications.
...
NBIA Advanced REST API Base URL, Format, and Return Values
Access to any NBIA Advanced REST API requires an access token. If you want to access restricted collections, the TCIA Help Desk must give your user account permission to access them.
The full API for data structure consists of a base URL followed by the API and query parameters, in that order. The base URL to access NBIA Advanced REST API data is https://services.cancerimagingarchive.net/nbia-api/services.
Note | ||
---|---|---|
| ||
To access National Lung Screening Trial (NLST) data, get the authentication token from https://nlst.cancerimagingarchive.net/nbia-api/oauth/token, then use https://nlst.cancerimagingarchive.net/nbia-api/services/ to make REST API calls. |
...
icon | false |
---|---|
title | NBIA Advanced REST API Query Structure |
Code Block |
---|
<YOUR_ACCESS_TOKEN><BaseURL><Resource><QueryEndpoint>?<QueryParameters> |
...
For example, the AP
I shown below requests all Body Part Values and Counts for the PT modality.
Note: To accommodate special characters in passwords, use double quotes on Windows and single quotes on Mac and Linux.
Info | ||||
---|---|---|---|---|
| ||||
|
...
All APIs return results in JSON format except for the Thumbnail API (JPG), Manifest Text API (TXT), and Series Metadata 2 API (CSV).
Secure Access to NBIA REST Services
Access to any NBIA Advanced REST API requires a token that you must request.
...
This token can then be used on subsequent requests to authorize access to resources. This token will expire in two hours but you can refresh it.
The NBIA REST API supports secure access to private data in the Client Credentials authorization flow with Spring Security and OAuth2. The Client Credentials authorization flow is also known as "signed fetch" or 2-legged OAuth. The following figure illustrates the typical use case for REST API calls made on the web using 2-legged OAuth. For more information regarding the specific workflow, consult the OAuth2 Specification.
...
Figure 1: Client Credentials Flow
This flow includes the following steps:
- The client authenticates with the authorization server and requests an access token from the token endpoint.
- The authorization server authenticates the client, and if valid, issues an access token.
This token can then be used on subsequent requests to authorize access to resources. The NBIA Advanced REST API server also supports token expiration and extension by refresh. The time it takes tokens to expire is currently two hours but is configurable.
To access TCIA using an NBIA Advanced REST API, you must request a token to use with restricted data. This token will expire in two hours and you can refresh it. Refer to REST Advanced REST APIs for example calls.
Requesting a Token to Use with Restricted Data
Access to any NBIA Advanced REST API requires an access token.
Requesting a Token
Access to any NBIA Advanced REST API requires an access token. A request for an access token takes the following structure. Note that USER should be your TCIA username and PASSWORD should be your TCIA password.
Note: To accommodate special characters in passwords, use double quotes on Windows and single quotes on Mac and LinuxA request for an access token takes the following structure. Note that USERNAME should be your TCIA username and PASSWORD should be your TCIA password.
Code Block | ||
---|---|---|
| ||
curl -X -v -d "username=USERNAMEUSER&password=PASSWORD&client_id=NBIA&grant_type=password" -X POST -k https://services.cancerimagingarchive.net/nbia-api/oauth/token |
Request a token by interacting with the application in the following way.
- The application requests credentials. The credentials you pass are different depending on if you want to access public or restricted data (see above).
The application sends a request to the service using the credentials you provided as a query string for the body.
- grant_type=password
- username=your TCIA username
- password=your TCIA password
The service responds with access token details and expiration information.
- access_token
- expires_in
- refresh_expires_in
- refresh_token
- not-before-policy
- session_state
The application makes a request for resources using the returned access token. All APIs listed for accessing public data also support secure access to restricted data with an additional parameter for the access token.
Requesting a Token to Use with Public Data
If you don't have a TCIA account and want to test an API on this page, you can access public data using the NBIA guest If you don't have a TCIA account, you can access public data using the "nbia_guest" account with no password, as follows.
Code Block | ||
---|---|---|
| ||
curl -X -v -d "username=nbia_guest&password=&client_id=NBIA&grant_type=password" -X POST -k https://services.cancerimagingarchive.net/nbia-api/oauth/token |
...
A successful service request returns the value in a defined format.
Refreshing the Token
The time it takes tokens to expire is configurable but is currently two hours. You can refresh your access token for an additional two hours by passing the refresh token from your original token request.
Code Block | ||
---|---|---|
| ||
# Request for refreshing the token
curl -X -v -d "username=USERNAME&client_id=nbia&grant_type=refresh_token&refresh_token=YOUR_REFRESH_TOKEN" -X POST -k https://nbia.cancerimagingarchive.net/nbia-api/oauth/token |
...
The request does not return any values.
REST Advanced REST APIs
The TCIA Radiology Portal’s search features use the following Advanced REST APIs.
If the value for an attribute is null in the specified collection, it will not appear in the returned values.
Accessing the National Lung Screening Trial (NLST) collection
Due to its size, the National Lung Screening Trial (NLST) collection lives on a separate NBIA server. Since this server only holds the public NLST collection, there is no reason to create an API token with your own credentials. To access these data via the Advanced REST API, you must change the URL to obtain the authentication token from https://nlst.cancerimagingarchive.net/nbia-api/oauth/token. You can then use https://nlst.cancerimagingarchive.net/nbia-api/services/ to make REST API calls. In both cases, the beginning of the URL is changed from "services" to "nlst." Examples of requesting a token and performing an API query are shown below:
Code Block | ||||
---|---|---|---|---|
| ||||
curl -X -v -d "username=nbia_guest&password=&client_id=NBIA&grant_type=password" -X POST -k https://nlst | ||||
Table of Content Zone | ||||
| ||||
Body Part Values and Counts APIThe Body Part Values and Counts API returns the modality values and body part count for the modality. It optionally takes the following parameters.
Example Body Part Values and Counts Query Code Block | | |||
|
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://nlst.cancerimagingarchive.net/nbia-api/services/getBodyPartValuesAndCounts?Modality=PT" |
Advanced REST APIs
The TCIA Radiology Portal’s search features use the following Advanced REST APIs.
Query Name | Return Values | Query Parameters |
---|---|---|
Body Part Values and Counts | Modality values and body part count for the modality API example and return values for getBodyPartValuesAndCounts | Collection (O) Modality (O) |
Collection Descriptions | The collection's description | collectionName (O) |
Collection or Series for DOI | The collection and/or series with the Digital Object Identifier (DOI) API example and return values for getCollectionorSeriesforDOI | DOI (R) CollectionOrSeries (O) - if left empty, only collection names and third party analysis are returned. If set to "series" a full list of Series Instance UIDs associated with each collection are also returned. |
Collection Values and Counts | The collections and the subject count for the collection API example and return values for getCollectionValuesandCounts | |
Create Saved Cart | Creates a saved cart (list) API example and return values for Create Saved Cart (createSharedList) | list - A repeatable parameter for each series you wish to have in the saved cart name- Name for the saved cart (note that names of saved carts must be unique) description - Description of the saved cart url - URL of the saved cart |
DICOM Metadata by Series UID | Provides the functionality in the portal where the DICOM data is retrieved from a series | SeriesUID |
Extended Simple Search with Modality and Body Part Paged | API example and return values for getSimpleSearchWithModalityAndBodyPartPaged |
|
Image with MD5 Hash | Zip file with the images and a CSV file containing the MD5 hashes | SeriesInstanceUID |
Manifest for Simple Search | The Manifest Text for Simple Search API allows the creation of a manifest file that can be used to execute the NBIA Data Retriever. API example and return values for getManifestForSimpleSearch | The API takes the same arguments as the Simple Search GUI. |
Manifest Text | The Manifest Text API allows the creation of a manifest file that can be used to execute the NBIA Data Retriever. |
|
Manifest for Text Search | Generates a manifest file of series. This is an API version of the text search in the NBIA Radiology Portal GUI. See Performing a Text Search for more information. |
|
Manifest from Patient Study Series | A manifest file of patient IDs that match the input parameters API example and return values for getManifestfromPatientStudySeries | patientIDs (O) studyUIDs (O) seriesUIDs (O) anyOrAll (O) includeAnnotation (O) |
MD5 Hierarchy | API example and return values for getMD5Hierarchy | SeriesInstanceUID (O) StudyInstanceUID (O) PatientID (O) Collection (O) |
Manufacturer Values and Counts | The manufacturer and their counts API example and return values for getManufacturerValuesandCounts | |
MD5 Hash for Image | The API returns a zip file containing the DICOM images and a CSV file with the MD5 hash code for each image file. | |
Modality Values and Counts | The modality values plus the manufacturer count for the modality API example and return values for getModalityValuesandCounts | Collection (O) Modality (O) Body Part Examined (O) |
Restrictions for Simple Search | API example and return values for getRestrictionsforSimpleSearch | |
Series Metadata 2 | The Series Metadata API allows returns the metadata needed by the client for a set of series as CSV. | list- Comma-separated list of series to return (R) SeriesInstanceUID (R) Collection (O) 3rd Party Analysis Data (O) Data Description URI (O) Subject ID (O) Study UID (O) Study Description (O) Study Date (O) Series Description (O) Manufacturer (O) Modality (O) SOP Class UID (O) Number of Images (O) File Size (O) File Location (O) Series Number (O) License Name (O) License URL (O) Annotation Size (O) Date Released (O) Series Date (O) Protocol Name (O) Body Part Examined (O) Annotations Flag (O) Manufacturer Model Name (O) Software Versions (O) Time Stamp (O) |
Species Tax | API example and return values for getSpeciesTax | |
Species Values And Counts | API example and return values for getSpeciesValuesAndCounts | |
Study Drill Down With Series IDs | API example and return values for getStudyDrillDownWithSeriesIDs | |
Thumbnail | API example and return values for getThumbnail | |
Text Search | API example and return values for getTextSearch | |
Updated Series | API example and return values for getUpdatedSeries |
Return Values
If the value for an attribute is null in the specified collection, it will not appear in the returned values.
Table of Content Zone | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body Part Values and CountsExample Body Part Values and Counts Query
Collection DescriptionsExample getCollectionDescriptions Query
Collection or Series for DOIExample getCollectionOrSeriesForDOI Query for Collection
Example getCollectionOrSeriesForDOI Query for Series
Return Value for Collection
Return Value for Series
Collection Values and CountsExample Collection Values And Counts Query
Create Saved CartExample Create Saved Cart Query
DICOM Metadata by Series UIDThe SeriesUID is available from the Drill Down API call. Example Metadata Query
The API sends back triples of all DICOM element, name, data in the file.
Extended Simple Search with Modality and Body Part PagedThe Extended Simple Search with Modality and Body Part Paged API is used to run queries for the Simple Search GUI in the NBIA client. This API uses a variety of criteria as seen in the NBIA client, as well as the pages of data the client requests. The available criteria types and their components follow. Since the simple search can take an unlimited number of criteria, each of the criteria items is appended with a number signifying its order in the query, starting with 0. Example Extended Simple Search with Modality and Body Part Paged Query
The API returns the results of the search.
Image with MD5 HashExample Image with MD5 Hash Query
Manifest for Simple SearchExample Manifest for Simple Search Query
Manifest TextExample Manifest Query
Manifest for Text SearchThis API takes a text value and generates a manifest file of series. This is an API version of the text search in the NBIA Radiology Portal GUI. See Performing a Text Search for more information. Example getManifestForTextSearch Query
Manifest from Patient Study SeriesThis API takes a a parameter and generates a manifest file of patient IDs that match those parameters. This API takes the following parameters:
Example getManifestFromPatientStudySeries Query
If successful, the API returns the following.
MD5 HierarchyExample getMD5Hierarchy Query
Manufacturer Values and Counts APIExample getManufacturerValuesAndCounts Query
MD5 Hash for ImageGenerates an MD5 Hierarchy for a given Collection, PatientID, StudyInstanceUID, or SeriesInstanceUID, which can be compared to a previously generated hierarchy to determine if any changes have occurred to the data. The API takes one argument:
Example MD5 Hash for Image Query
Modality Values and CountsThe Modality Values and Counts API returns the modality values plus the subject count for the modality. It optionally takes the following parameters.
Example Modality Values and Counts Query
The API returns the modalities and their counts.
Restrictions for Simple SearchThe Restrictions on Simple Search API returns whether any series returned by simple search has commercial restrictions. The API takes the same parameters as the Simple Search GUI. Example getRestrictionsForSimpleSearch Query
The API returns "Yes" if there are commercial restrictions and "No" if there are not. Series Metadata 2The Series Metadata API allows returns the metadata needed by the client for a set of series as CSV. Example Series Metadata 2 Query
The API returns ok if successful, and the error if one occurs.
Species TaxThe Species Tax API returns the species taxonomy and takes no parameters. Example Species Tax Query
The API returns the current species taxonomy.
Species Values And CountsThe Get Species Values And Counts API returns the values and counts for species and takes the same parameters as the Simple Search GUI. Example Species Values And Counts Query
The API returns the values and counts for species.
Study Drill Down With Series IDsThe Study Drill Down API provides the functionality in the portal where the user drills down to the studies and series associated with a given user. The API takes a list of series to query, using the parameter "list," that is repeated for each series instance UIDs you want to retrieve. Example Study Drill Down With Series IDs Query
The Study Drill Down With Series Ids API returns JSON with the information to populate the drill down to study screen. There can be multiple studies.
ThumbnailThe Get Thumbnail API returns the DICOM tags and values associated with the image.
Example Thumbnail Query
The API returns a JPG thumbnail.
Text SearchThe text search API is used to run queries for Text Search in the portal. The text search takes an argument, textValue. Example Text Search Query
Note that the returned JSON now includes the "hit" that was found by the Solr search engine.
Updated SeriesThis API returns the series that have been updated since a given date. The API takes one argument:
Example Get Updated Series Query
The API returns the updated series.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[
{"criteria":"ABDOMEN","count":"13"},
{"criteria":"CHEST","count":"298"},
{"criteria":"Chest","count":"1"},
{"criteria":"HEADNECK","count":"1"},{
"criteria":"Lung","count":"76"},
{"criteria":"THORAX_1_ROUTINE","count":"1"}
] |
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getCollectionDescriptions?collectionName=4D-Lung" |
If successful, the API returns the collection description.
Code Block | ||
---|---|---|
| ||
[{"description":"<p>\n\t<span>This data collection consists of images acquired during chemoradiotherapy of 20 locally-advanced, non-small cell lung cancer patients. The images include four-dimensional (4D) fan beam (4D-FBCT) and 4D cone beam CT (4D-CBCT). All patients underwent concurrent radiochemotherapy to a total dose of 64.8-70 Gy using daily 1.8 or 2 Gy fractions.</span></p>\n<p>\n\tA single Radiation Oncologist delineated targets and organs at risk in all 4D-FBCT and a limited number of 4D-CBCT images. All patients underwent concurrent radiochemotherapy to a total dose of 64.8-70 Gy using daily 1.8 or 2 Gy fractions.</p>\n<p>\n\tPlease see the <a href=\"http://doi.org/10.7937/K9/TCIA.2016.ELN8YGLE\" target=\"_blank\">4D-Lung</a> page to learn more about the images and to obtain any supporting metadata for this collection.</p>\n","id":236322816,"collectionDescTimestamp":1678942800000,"collectionName":"4D-Lung","userName":"tracyn","licenseId":null,"descriptionURI":"https://doi.org/10.7937/K9/TCIA.2016.ELN8YGLE"}] |
Collection or Series for DOI
The Collection or Series for DOI API returns the collection and/or series with the Digital Object Identifier (DOI). It does not take any parameters.
Example getCollectionOrSeriesForDOI Query for Collection
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getCollectionOrSeriesForDOI" -d "DOI=https://doi.org/10.7937/K9/TCIA.2016.ELN8YGLE&CollectionOrSeries=collection" |
Example getCollectionOrSeriesForDOI Query for Series
Code Block |
---|
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getCollectionOrSeriesForDOI" -d "DOI=https://doi.org/10.7937/K9/TCIA.2016.ELN8YGLE&CollectionOrSeries=series" |
Return Value for Collection
Code Block | ||
---|---|---|
| ||
[{""collection"":""4D-Lung"",""seriesInstanceUID"":null,""thirdPartyAnanlysis"":null}] |
Return Value for Series
Code Block |
---|
[{""collection"":""4D-Lung"",""seriesInstanceUID"":""1.3.6.1.4.1.14519.5.2.1.6834.5010.100037757822547877540622085093"",""thirdPartyAnanlysis"":null},{""collection"":""4D-Lung"",""seriesInstanceUID"":""1.3.6.1.4.1.14519.5.2.1.6834.5010.100049789635984645130991826991"",""thirdPartyAnanlysis"":null},{""collection"":""4D-Lung"",""seriesInstanceUID"":""1.3.6.1.4.1.14519.5.2.1.6834.5010.100055011459662871005613719886"",""thirdPartyAnanlysis"":null},{""collection"":""4D-Lung"",""seriesInstanceUID"":""1.3.6.1.4.1.14519.5.2.1.6834.5010.100089621274100103247029607723"",""thirdPartyAnanlysis"":null},{""collection"":""4D-Lung"",""seriesInstanceUID"":""1.3.6.1.4.1.14519.5.2.1.6834.5010.100137773791956790807544371448"",""thirdPartyAnanlysis"":null},{""collection"":""4D-Lung"",""seriesInstanceUID"":""1.3.6.1.4.1.14519.5.2.1.6834.5010.100317870572035759487319851556"",""thirdPartyAnanlysis"":null},{""collection"":""4D-Lung"",""seriesInstanceUID"":""1.3.6.1.4.1.14519.5.2.1.6834.5010.100356687286872672203671297553"",""thirdPartyAnanlysis"":null},......." |
Collection Values and Counts
The Collection Values and Counts API returns the collections and the subject count for the collection.
Example Collection Values And Counts Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getCollectionValuesAndCounts" |
The API returns the collections with their counts.
Code Block | ||
---|---|---|
| ||
[
{"criteria":"IDRI","count":"614"},
{"criteria":"IDRICONDUIT","count":"66"},
{"criteria":"LIDC","count":"397"},
{"criteria":"RIDER Pilot","count":"130"},
{"criteria":"SportInjury","count":"1"}
] |
Create Saved Cart API
The Create Saved Cart API allows the creation of a saved cart.
The API takes four arguments:
- list - A repeatable parameter for each series you wish to have in the saved cart
- name- Name for the saved cart (note that names of saved carts must be unique)
- description - Description of the saved cart
- url - URL of the saved cart
Example Create Saved Cart Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/createSharedList" -d "list=1.3.6.1.4.1.14519.5.2.1.6834.5010.100089621274100103247029607723&name=MyNewShareList&description=mysharelistdescription&url=https://myurl.com"
NOTE: list=<seriesInstanceUID> |
Response
List created.
DICOM Metadata by Series UID API
The DICOM Metadata by Series UID API provides the functionality in the portal where the DICOM data is retrieved from a series.
The API takes one argument:
- SeriesUID
The SeriesUID is available from the Drill Down API call.
Example Metadata Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getDicomTags?SeriesUID=1.3.6.1.4.1.14519.5.2.1.6834.5010.100089621274100103247029607723" |
The API sends back triples of all DICOM element, name, data in the file.
Code Block | ||
---|---|---|
| ||
{"element":"(0027,1047)","name":"","data":"1.0"},{"element":"(0027,1050)","name":"","data":"0.0"},{"element":"(0027,1051)","name":"","data":"0.0"},{"element":"(0028,0002)","name":"Samples per Pixel","data":"1"},{"element":"(0028,0004)","name":"Photometric Interpretation","data":"MONOCHROME2"},{"element":"(0028,0010)","name":"Rows","data":"512"},{"element":"(0028,0011)","name":"Columns","data":"512"},{"element":"(0028,0030)","name":"Pixel Spacing","data":"0.878906\\0.878906"},{"element":"(0028,0100)","name":"Bits Allocated","data":"16"},{"element":"(0028,0101)","name":"Bits Stored","data":"16"},{"element":"(0028,0102)","name":"High Bit","data":"15"},{"element":"(0028,0103)","name":"Pixel Representation","data":"1"},{"element":"(0028,0120)","name":"Pixel Padding Value","data":"-2000"},{"element":"(0028,0303)","name":"Longitudinal Temporal Information Modified","data":"MODIFIED"},{"element":"(0028,1050)","name":"Window Center","data":"40"},{"element":"(0028,1051)","name":"Window Width","data":"400"},{"element":"(0028,1052)","name":"Rescale Intercept","data":"0"},{"element":"(0028,1053)","name":"Rescale Slope","data":"1"},{"element":"(0028,1054)","name":"Rescale Type","data":"HU"},{"element":"(0040,0244)","name":"Performed Procedure Step Start Date","data":"19950522"},{"element":"(0040,0245)","name":"Performed Procedure Step Start Time","data":"161702"},{"element":"(0040,0254)","name":"Performed Procedure Step Description","data":"4dct stereo"},{"element":"(0043,0010)","name":"","data":"GEMS_PARM_01"},{"element":"(0043,1010)","name":"","data":"400"},{"element":"(0043,1012)","name":"","data":"99\\99\\99"},{"element":"(0043,1016)","name":"","data":"0"},{"element":"(0043,101E)","name":"","data":"0.000000"},{"element":"(0043,101F)","name":"","data":"0"},{"element":"(0043,1021)","name":"","data":"0"},{"element":"(0043,1025)","name":"","data":"0\\0\\0\\0\\0\\0"},{"element":"(0043,1026)","name":"","data":"0\\0\\0\\0\\0\\0\\0\\0"},{"element":"(0043,1027)","name":"","data":""},{"element":"(0043,102B)","name":"","data":"2\\0\\0\\0"},{"element":"(0043,1031)","name":"","data":"0.000000\\0.000000"},{"element":"(0043,1040)","name":"","data":"353.85443"},{"element":"(0043,1041)","name":"","data":"3600.8787"},{"element":"(0043,1042)","name":"","data":"0"},{"element":"(0043,1043)","name":"","data":"0"},{"element":"(0043,1044)","name":"","data":"0"},{"element":"(0043,1045)","name":"","data":"0"},{"element":"(0043,1046)","name":"","data":"0"},{"element":"(0043,104D)","name":"","data":"0.0"},{"element":"(0043,104E)","name":"","data":"5.00122"},{"element":"(0045,0010)","name":"","data":"GEMS_HELIOS_01"},{"element":"(0045,1001)","name":"","data":"8"},{"element":"(0045,1002)","name":"","data":"2.5"},{"element":"(0045,1003)","name":"","data":"7"},{"element":"(0045,1004)","name":"","data":"6"},{"element":"(0045,1006)","name":"","data":"INTO GANTRY"},{"element":"(0045,1007)","name":"","data":"0.0"},{"element":"(0045,1008)","name":"","data":"0"},{"element":"(0045,1009)","name":"","data":"17"},{"element":"(0045,100A)","name":"","data":"0.0"},{"element":"(0045,100B)","name":"","data":"0.0"},{"element":"(0045,100C)","name":"","data":"0"},{"element":"(0045,100D)","name":"","data":"0"},{"element":"(0045,100E)","name":"","data":"0.0"},{"element":"(0045,100F)","name":"","data":"0.0"},{"element":"(0045,1010)","name":"","data":"0"},{"element":"(0045,1011)","name":"","data":"0"},{"element":"(0045,1012)","name":"","data":"0"},{"element":"(0045,1013)","name":"","data":"10"},{"element":"(0045,1014)","name":"","data":"0"},{"element":"(0045,1015)","name":"","data":"0"},{"element":"(0045,1016)","name":"","data":"0"},{"element":"(0045,1017)","name":"","data":"0"},{"element":"(0045,1018)","name":"","data":"0"},{"element":"(0045,1021)","name":"","data":"0"},{"element":"(0045,1022)","name":"","data":"0"},{"element":"(0045,1032)","name":"","data":"0.5"}] |
Extended Simple Search with Modality and Body Part Paged API
The Extended Simple Search with Modality and Body Part Paged API is used to run queries for the Simple Search GUI in the NBIA client. This API uses a variety of criteria as seen in the NBIA client, as well as the pages of data the client requests. The available criteria types and their components follow. Since the simple search can take an unlimited number of criteria, each of the criteria items is appended with a number signifying its order in the query, starting with 0.
- CollectionCriteria
- value
- ImageModalityCriteria
- value
- AnatomicalSiteCriteria
- value
- ManufacturerCriteria
- value
- DateRangeCriteria
- fromDate - Formatted "dd/mm/yyyy"
- toDate - Formatted "dd/mm/yyyy"
- PatientCriteria
- value
- MinNumberOfStudiesCriteria
- value
- SpeciesCriteria
- The code for the species
- PhantomCriteria
- yes for phantoms
- TimePointCriteria
- eventType the eventType for the timepoint
- fromDate - Formatted "dd/mm/yyyy"
- toDate - Formatted "dd/mm/yyyy"
- SortField
- The field to sort on
- SortDirection
- ascending or descending
- Start
- The page to start on
- Size
- How many items per page
Example Extended Simple Search with Modality and Body Part Paged Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getSimpleSearchWithModalityAndBodyPartPaged" -d "criteriaType0=TimePointCriteria&eventType0=DIAGNOSIS&fromDay0=-5&toDay0=10&sortField=subject&sortDirection=descending&start=0&size=9" |
The API returns the results of the search.
Code Block | ||
---|---|---|
| ||
{
"resultSet":[
{
"subjectId":"Test-5910936489",
"project":"Test",
"id":819200,
"modalities":[
"CT"
],
"bodyParts":[
"LUNG"
],
"species":[
"L-877FC"
],
"timepoints":{
"DIAGNOSIS":[
1,
3
]
},
"totalNumberOfStudies":28,
"totalNumberOfSeries":61,
"studyIdentifiers":[
{
"seriesIdentifiers":[
917526,
917527,
917528
],
"seriesAndModality":[
],
"studyIdentifier":851979
},
{
"seriesIdentifiers":[
917529,
917530
],
"seriesAndModality":[
],
"studyIdentifier":851980
},
{
"seriesIdentifiers":[
917531,
917532
],
"seriesAndModality":[
],
"studyIdentifier":851981
}
]
}
],
"totalPatients":1,
"bodyParts":[
{
"value":"LUNG",
"count":1
}
],
"modalities":[
{
"value":"CT",
"count":1
}
],
"collections":[
{
"value":"Test",
"count":1
}
],
"species":[
{
"value":"L-877FC",
"count":1
}
],
"maxTimepoints":{
"DIAGNOSIS":3
},
"minTimepoints":{
"DIAGNOSIS":1
},
"sort":"subject-descending"
} |
Image with MD5 Hash API
This API takes a series UID and returns a zip file with the images and a CSV file containing the MD5 hashes.
The API takes two arguments:
- Collection - The collection to update
- DOI - Digital Object Identifier
Example Image with MD5 Hash Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/getImageWithMD5Hash?SeriesInstanceUID=1.3.6.1.4.1.14519.5.2.1.69197085.4624.313514201353787659031503464798" |
The API returns the images and a CSV file in the zip file that records the file name and a hash.
Manifest for Simple Search API
The Manifest Text for Simple Search API allows the creation of a manifest file that can be used to execute the NBIA Data Retriever.
The API takes the same arguments as the Simple Search GUI.
Example Manifest for Simple Search Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getManifestForSimpleSearch" -d "criteriaType0=ThirdPartyAnalysis&value0=yes&sortField=subject&sortDirection=descending&start=0&size=1000000" |
The API returns text that can be used as a manifest file for the NBIA Data Retriever.
Code Block | ||
---|---|---|
| ||
downloadServerUrl=https://services.cancerimagingarchive.net/nbia-download/servlet/DownloadServlet
includeAnnotation=false
noOfrRetry=4
databasketId=manifest-1523866570303.tcia
manifestVersion=3.0
ListOfSeriesToDownload=
1.3.6.1.4.1.9328.50.3.336 |
Manifest Text API
The Manifest Text API allows the creation of a manifest file that can be used to execute the NBIA Data Retriever.
The API takes two arguments:
- list - A repeatable parameter of series UIDs for each series you want to download
- includeAnnotation - If "true" is used, the annotations are returned.
Example Manifest Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getManifestTextV2" -d "list=2626.191696586241637374878426886752","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7085.2626.133227486354322852440613503770","Modality":"CT","ProtocolName":"CHEST_ABD_PELVIS","SeriesDate":"2010-09-05 00:00:00.0","SeriesDescription":"TOPOGRAM 0.6 T20s","BodyPartExamined":"CHEST","SeriesNumber":1,"Collection":"CPTAC-UCEC","PatientID":"C3N-02436","Manufacturer":"SIEMENS","ManufacturerModelName":"SOMATOM Definition Flash","SoftwareVersions":"syngo CT 2012B","ImageCount":1},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.93285.502.3.336&includeAnnotation=false" |
The API returns text that can be used as a manifest file for the NBIA Data Retriever.
Code Block | ||
---|---|---|
| ||
downloadServerUrl=https://services.cancerimagingarchive.net/nbia-download/servlet/DownloadServlet
includeAnnotation=false
noOfrRetry=4
databasketId=manifest-1523866570303.tcia
manifestVersion=3.0
ListOfSeriesToDownload=
1.3.6.1.4.1.9328.50.3.336 |
Manifest for Text Search
This API takes a text value and generates a manifest file of series. This is an API version of the text search in the NBIA Radiology Portal GUI. See Performing a Text Search for more information.
This API takes the following parameter:
- textValue
Example getManifestForTextSearch Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -X POST "https://services.cancerimagingarchive.net/nbia-api/services/getManifestForTextSearch" -d "textValue=CT" |
Code Block | ||
---|---|---|
| ||
downloadServerUrl=https://services.cancerimagingarchive.net/nbia-download/servlet/DownloadServlet includeAnnotation=false noOfrRetry=4 databasketId=manifest-1680987888150.tcia manifestVersion=3.0 ListOfSeriesToDownload= 1.211008142524560003951886355912626063954","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.56000972057571133036084570908178306645","Modality":"CT","ProtocolName":"6.1 ABD W\/O DR 30%","SeriesDate":"2009-06-30 00:00:00.0","SeriesDescription":"SOFT 5s","BodyPartExamined":"KIDNEY","SeriesNumber":3,"Collection":"CPTAC-CCRCC","PatientID":"C3L-01960","Manufacturer":"GE MEDICAL SYSTEMS","ManufacturerModelName":"LightSpeed VCT","SoftwareVersions":"gmp_vct.42","ImageCount":100},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.505.42.563784 1.3.6.1.4.1.9328.50.4.568673 1.190738758608436907826741043480210378147","StudyInstanceUID":"1.3.6.1.4.1.9328.50.4.568676 .1.14519.5.2.1.56000972057571133036084570908178306645","Modality":"CT","ProtocolName":"6.1 ABD W\/O DR 30%","SeriesDate":"2009-06-30 00:00:00.0","SeriesDescription":"2.5s soft","BodyPartExamined":"KIDNEY","SeriesNumber":4,"Collection":"CPTAC-CCRCC","PatientID":"C3L-01960","Manufacturer":"GE MEDICAL SYSTEMS","ManufacturerModelName":"LightSpeed VCT","SoftwareVersions":"gmp_vct.42","ImageCount":200},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.5.502.4.568678 1.255655949940392130215771845301489961005","StudyInstanceUID":"1.3.6.1.4.1.9328.50.4.569267 1.3.6.1.4.1.9328.50.4.569270 14519.5.2.1.109145130435628734336383566463376219652","Modality":"CT","ProtocolName":"6.1 Routine Abdomen\/Pelvis .* INCLUDES BONE RECONS","SeriesDate":"2009-07-12 00:00:00.0","SeriesDescription":"Enhanced Abdomen\/Pelvis","BodyPartExamined":"KIDNEY","SeriesNumber":2,"Collection":"CPTAC-CCRCC","PatientID":"C3L-01960","Manufacturer":"GE MEDICAL SYSTEMS","ManufacturerModelName":"LightSpeed VCT","SoftwareVersions":"gmp_vct.42","ImageCount":95},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.505.42.569273 1.3.6.1.4.1.9328.50.4.569823 1.1.62348259564270653822457602313155874057","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.571319 1.3.6.1.4.1.9328.50.4.571323 1.3.6.1.4.1.9328.50.4.571803 56000972057571133036084570908178306645","Modality":"CT","ProtocolName":"6.1 ABD W\/O DR 30%","SeriesDate":"2009-06-30 00:00:00.0","SeriesDescription":"SCOUT","BodyPartExamined":"KIDNEY","SeriesNumber":1,"Collection":"CPTAC-CCRCC","PatientID":"C3L-01960","Manufacturer":"GE MEDICAL SYSTEMS","ManufacturerModelName":"LightSpeed VCT","SoftwareVersions":"gmp_vct.42","ImageCount":2},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.505.42.571808 1.3.6.1.4.1.9328.50.4.572414 1.183148327278950087954671503508917919131","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.572418 1.3.109145130435628734336383566463376219652","Modality":"CT","ProtocolName":"6.1.4.1.9328.50.4.572422 Routine Abdomen\/Pelvis .* INCLUDES BONE RECONS","SeriesDate":"2009-07-12 00:00:00.0","SeriesDescription":"Scout","BodyPartExamined":"KIDNEY","SeriesNumber":1,"Collection":"CPTAC-CCRCC","PatientID":"C3L-01960","Manufacturer":"GE MEDICAL SYSTEMS","ManufacturerModelName":"LightSpeed VCT","SoftwareVersions":"gmp_vct.42","ImageCount":2},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.93285.502.4.572425 1.75656900515008159651347291284155973982","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.572983 1.3.6.1.4.1.9328.50.4.573038 1.575777395964990009409017569534167887","Modality":"MR","ProtocolName":"MRI RENAL-KIDNEY","SeriesDate":"2008-11-11 00:00:00.0","SeriesDescription":"Cor LAVA ARC PRE THRU KIDNEYS AND AORTA FROM SAG","BodyPartExamined":"KIDNEY","SeriesNumber":10,"Collection":"CPTAC-CCRCC","PatientID":"C3L-00609","Manufacturer":"GE MEDICAL SYSTEMS","ManufacturerModelName":"Optima MR450w","SoftwareVersions":"24","ImageCount":64},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.505.42.573635 1.3.6.1.4.1.9328.50.4.573639 1.245356199503483432341179415858473733042","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.574149 1.3.6.1.4.1.9328.50.4.574153 1.575777395964990009409017569534167887","Modality":"MR","ProtocolName":"MRI RENAL-KIDNEY","SeriesDate":"2008-11-11 00:00:00.0","SeriesDescription":"Ax LAVA PRE","BodyPartExamined":"KIDNEY","SeriesNumber":11,"Collection":"CPTAC-CCRCC","PatientID":"C3L-00609","Manufacturer":"GE MEDICAL SYSTEMS","ManufacturerModelName":"Optima MR450w","SoftwareVersions":"24","ImageCount":80},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.505.42.578325 1.3.6.1.4.1.9328.50.4.578328 1.21609109943642645531382867839700789180","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.578331 1.3.6.1.4.1.9328.50.4.578901 1.3.6.1.4.1.9328.50.4.579479 1.575777395964990009409017569534167887","Modality":"MR","ProtocolName":"MRI RENAL-KIDNEY","SeriesDate":"2008-11-11 00:00:00.0","SeriesDescription":"AX FRFSE BH T2 FS OPTIONAL IF RT WILL NOT WORK","BodyPartExamined":"KIDNEY","SeriesNumber":12,"Collection":"CPTAC-CCRCC","PatientID":"C3L-00609","Manufacturer":"GE MEDICAL SYSTEMS","ManufacturerModelName":"Optima MR450w","SoftwareVersions":"24","ImageCount":24},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.505.42.579482 1.3.6.1.4.1.9328.50.4.579494 1.137992178380935686474136038434155081787","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.580056 1.3.6.1.4.1.9328.50.4.579487 1.575777395964990009409017569534167887","Modality":"MR","ProtocolName":"MRI RENAL-KIDNEY","SeriesDate":"2008-11-11 00:00:00.0","SeriesDescription":"Cor SSFSE BH THRU KIDNEYS","BodyPartExamined":"KIDNEY","SeriesNumber":3,"Collection":"CPTAC-CCRCC","PatientID":"C3L-00609","Manufacturer":"GE MEDICAL SYSTEMS","ManufacturerModelName":"Optima MR450w","SoftwareVersions":"24","ImageCount":22},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.505.42.579490 1.3.6.1.4.1.9328.50.4.580594 1.66236310694139582452411837407718775922","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.581140 1.3.6.1.4.1.9328.50.4.590291 1.575777395964990009409017569534167887","Modality":"MR","ProtocolName":"MRI RENAL-KIDNEY","SeriesDate":"2008-11-11 00:00:00.0","SeriesDescription":"Ax T2 FRFSE FatSat RTr ARC KIDNEYS ONLY","BodyPartExamined":"KIDNEY","SeriesNumber":9,"Collection":"CPTAC-CCRCC","PatientID":"C3L-00609","Manufacturer":"GE MEDICAL SYSTEMS","ManufacturerModelName":"Optima MR450w","SoftwareVersions":"24","ImageCount":26},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.505.42.590294 1.3.6.1.4.1.9328.50.4.590297 1.304017195569708291273496905973714460930","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.590890 1.3.6.1.4.1.9328.50.4.591508 1.3.6.1.4.1.9328.50.4.591511 1.3.6.1.4.1.9328.50.4.591513 1.1.575777395964990009409017569534167887","Modality":"MR","ProtocolName":"MRI RENAL-KIDNEY","SeriesDate":"2008-11-11 00:00:00.0","SeriesDescription":"3Plane Loc SSFSE","BodyPartExamined":"KIDNEY","SeriesNumber":1,"Collection":"CPTAC-CCRCC","PatientID":"C3L-00609","Manufacturer":"GE MEDICAL SYSTEMS","ManufacturerModelName":"Optima MR450w","SoftwareVersions":"24","ImageCount":17},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.505.42.591516 1.3.6.1.4.1.9328.50.4.591522 1.207407827182959708074704778666572415754","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.591975 1.3.6.1.4.1.9328.50.4.592513 1.575777395964990009409017569534167887","Modality":"MR","ProtocolName":"MRI RENAL-KIDNEY","SeriesDate":"2008-11-11 00:00:00.0","SeriesDescription":"Ax 2D DualEcho KIDNEYS ONLY","BodyPartExamined":"KIDNEY","SeriesNumber":6,"Collection":"CPTAC-CCRCC","PatientID":"C3L-00609","Manufacturer":"GE MEDICAL SYSTEMS","ManufacturerModelName":"Optima MR450w","SoftwareVersions":"24","ImageCount":60},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.505.42.593093 1.3.6.1.4.1.9328.50.4.593096 1.54520248656390659705202351279457471623","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.593099 1.3.6.1.4.1.9328.50.4.593601 1.575777395964990009409017569534167887","Modality":"MR","ProtocolName":"MRI RENAL-KIDNEY","SeriesDate":"2008-11-11 00:00:00.0","SeriesDescription":"Ax DWI B=500 NAV","BodyPartExamined":"KIDNEY","SeriesNumber":8,"Collection":"CPTAC-CCRCC","PatientID":"C3L-00609","Manufacturer":"GE MEDICAL SYSTEMS","ManufacturerModelName":"Optima MR450w","SoftwareVersions":"24","ImageCount":30},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.505.42.594099 1.3.6.1.4.1.9328.50.4.594613 1.331484779082297900346876082479517524406","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.595110 1.3.6.1.4.1.9328.50.4.595623 1.3.6.1.4.1.9328.50.4.596197 1.575777395964990009409017569534167887","Modality":"MR","ProtocolName":"MRI RENAL-KIDNEY","SeriesDate":"2008-11-11 00:00:00.0","SeriesDescription":"SAG SSFSE BH THRU KIDNEYS","BodyPartExamined":"KIDNEY","SeriesNumber":4,"Collection":"CPTAC-CCRCC","PatientID":"C3L-00609","Manufacturer":"GE MEDICAL SYSTEMS","ManufacturerModelName":"Optima MR450w","SoftwareVersions":"24","ImageCount":35},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.505.42.596737 1.3.6.1.4.1.9328.50.4.600540 1.867044007602064428393129841040266430","StudyInstanceUID":"1.3.6.1.4.1.9328.50.4.600543 1.3.6.1.4.1.9328.50.4.601079 14519.5.2.1.575777395964990009409017569534167887","Modality":"MR","ProtocolName":"MRI RENAL-KIDNEY","SeriesDate":"2008-11-11 00:00:00.0","SeriesDescription":"AXIAL T2 SSFSE BH","BodyPartExamined":"KIDNEY","SeriesNumber":5,"Collection":"CPTAC-CCRCC","PatientID":"C3L-00609","Manufacturer":"GE MEDICAL SYSTEMS","ManufacturerModelName":"Optima MR450w","SoftwareVersions":"24","ImageCount":20},{"SeriesInstanceUID":"1.3.6.1.4.1.9328.50.4.601082 14519.5.2.1.146178905280567177991142318697613352451","StudyInstanceUID":"1.3.6.1.4.1.14519.5.93282.50.4.601085 1.575777395964990009409017569534167887","Modality":"MR","ProtocolName":"MRI RENAL-KIDNEY","SeriesDate":"2008-11-11 00:00:00.0","SeriesDescription":"Apparent Diffusion Coefficient (mm2\/s)","BodyPartExamined":"KIDNEY","SeriesNumber":800,"Collection":"CPTAC-CCRCC","PatientID":"C3L-00609","Manufacturer":"GE MEDICAL SYSTEMS","ManufacturerModelName":"Optima MR450w","SoftwareVersions":"24","ImageCount":15},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.5.502.4.601643 1.24521037205708921168084397885539628772","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.604326 1.3.6.1.4.1.9328.50.4.604330 1.87343261616565077224359702729401259098","Modality":"CT","SeriesDate":"2016-06-30 00:00:00.0","SeriesDescription":"ST AX THIN","BodyPartExamined":"ABDOMEN","SeriesNumber":3,"Collection":"CPTAC-UCEC","PatientID":"C3L-05849","Manufacturer":"SIEMENS","ManufacturerModelName":"SOMATOM Definition Flash","SoftwareVersions":"syngo CT VA48A","ImageCount":696},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.93285.502.4.604333 1.266615994591450090046447803928312219131","StudyInstanceUID":"1.3.6.1.4.1.9328.50.4.604801 14519.5.2.1.87343261616565077224359702729401259098","Modality":"CT","SeriesDate":"2016-06-30 00:00:00.0","SeriesDescription":"ST COR","BodyPartExamined":"ABDOMEN","SeriesNumber":4,"Collection":"CPTAC-UCEC","PatientID":"C3L-05849","Manufacturer":"SIEMENS","ManufacturerModelName":"SOMATOM Definition Flash","SoftwareVersions":"syngo CT VA48A","ImageCount":57},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.93285.502.4.604806 1.39259777678200137059835826187434558013","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.607091 1.3.6.1.4.1.9328.50.4.607094 1.87343261616565077224359702729401259098","Modality":"CT","SeriesDate":"2016-06-30 00:00:00.0","SeriesDescription":"ST AX","BodyPartExamined":"ABDOMEN","SeriesNumber":2,"Collection":"CPTAC-UCEC","PatientID":"C3L-05849","Manufacturer":"SIEMENS","ManufacturerModelName":"SOMATOM Definition Flash","SoftwareVersions":"syngo CT VA48A","ImageCount":98},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.93285.502.4.607097 1.161982724082331319465572169155208225153","StudyInstanceUID":"1.3.6.1.4.1.9328.50.4.618649 14519.5.2.1.87343261616565077224359702729401259098","Modality":"CT","SeriesDate":"2016-06-30 00:00:00.0","SeriesDescription":"ST SAG","BodyPartExamined":"ABDOMEN","SeriesNumber":5,"Collection":"CPTAC-UCEC","PatientID":"C3L-05849","Manufacturer":"SIEMENS","ManufacturerModelName":"SOMATOM Definition Flash","SoftwareVersions":"syngo CT VA48A","ImageCount":90},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.93285.502.4.610796 1.238208027292970722183126381008808411202","StudyInstanceUID":"1.3.6.1.4.1.9328.50.4.610799 .14519.5.2.1.87343261616565077224359702729401259098","Modality":"CT","SeriesDate":"2016-06-30 00:00:00.0","SeriesDescription":"Topogram 0.6 T20f","BodyPartExamined":"ABDOMEN","SeriesNumber":1,"Collection":"CPTAC-UCEC","PatientID":"C3L-05849","Manufacturer":"SIEMENS","ManufacturerModelName":"SOMATOM Definition Flash","SoftwareVersions":"syngo CT VA48A","ImageCount":1},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.5.502.4.610803 1.104676703467748132759270722686474378353","StudyInstanceUID":"1.3.6.1.4.1.9328.50.4.611364 .14519.5.2.1.143508475032044659595485724455199959932","Modality":"CT","SeriesDate":"2016-07-24 00:00:00.0","SeriesDescription":"Abd\/Pel ST 3.0 B20f","BodyPartExamined":"ABDOMEN","SeriesNumber":2,"Collection":"CPTAC-UCEC","PatientID":"C3L-05848","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":184},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.5.502.4.611919 1.276160523486377582247467372005084977764","StudyInstanceUID":"1.3.6.1.4.1.9328.50.4.612031 14519.5.2.1.143508475032044659595485724455199959932","Modality":"CT","SeriesDate":"2016-07-24 00:00:00.0","SeriesDescription":"SAGITTAL","BodyPartExamined":"ABDOMEN","SeriesNumber":5,"Collection":"CPTAC-UCEC","PatientID":"C3L-05848","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":113},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.5.502.4.612039 1.306438034061104828163299494729950182902","StudyInstanceUID":"1.3.6.1.4.1.9328.50.4.612593 14519.5.2.1.77155367638621502173880012762024128638","Modality":"CT","SeriesDate":"2015-03-03 00:00:00.0","SeriesDescription":"Chest\/Abd\/Pel LUNG 3.0 B60f","BodyPartExamined":"CHEST","SeriesNumber":3,"Collection":"CPTAC-UCEC","PatientID":"C3L-02747","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":152},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.5.502.4.612598 1.249747234475942834682299784244177066122","StudyInstanceUID":"1.3.6.1.4.1.14519.93285.2.50.4.613155 1.192180924543597682091545532955797799290","Modality":"CT","SeriesDate":"2016-10-25 00:00:00.0","SeriesDescription":"<MPR Range[1]>","BodyPartExamined":"ABDOMEN","SeriesNumber":603,"Collection":"CPTAC-UCEC","PatientID":"C3L-05848","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":141},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.5.502.4.613159 1.163657679348320741926204299059702564472","StudyInstanceUID":"1.3.6.1.4.1.9328.50.4.613786 .14519.5.2.1.67953080284076345917473005680077306867","Modality":"CT","SeriesDate":"2016-09-26 00:00:00.0","SeriesDescription":"Chest\/Abd\/Pel LUNG 3.0 B60f","BodyPartExamined":"CHEST","SeriesNumber":3,"Collection":"CPTAC-UCEC","PatientID":"C3L-03467","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":142},{"SeriesInstanceUID":"1.3.6.1.4.1.932814519.505.42.613791 1.3.6.1.4.1.9328.50.4.613794 1.89337107620575759211601953173555846864","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.614396 1.3.6.1.4.1.9328.50.4.614399 |
Manifest from Patient Study Series
This API takes a a parameter and generates a manifest file of patient IDs that match those parameters.
This API takes the following parameters:
- patientIDs (required)
- studyUIDs (optional)
- seriesUIDs (optional)
- anyOrAll (optional)
- includeAnnotation (optional)
Example getManifestFromPatientStudySeries Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getManifestFromPatientStudySeries" -d "patientIDs=ISPY1_1001" |
If successful, the API returns the following.
Code Block | ||
---|---|---|
| ||
downloadServerUrl=https://nbia.cancerimagingarchive.net/nbia-download/servlet/DownloadServlet includeAnnotation=true noOfrRetry=4 databasketId=manifest-1691620358806.tcia manifestVersion=3.0 ListOfSeriesToDownload= 1.192180924543597682091545532955797799290","Modality":"CT","SeriesDate":"2016-10-25 00:00:00.0","SeriesDescription":"<MPR Range>","BodyPartExamined":"ABDOMEN","SeriesNumber":602,"Collection":"CPTAC-UCEC","PatientID":"C3L-05848","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":114},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.204734451354467159013076861301815243913","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.250955243295773832626617549482 .1.58230391169750649153488661664117068107","Modality":"CT","SeriesDate":"2016-03-21 00:00:00.0","SeriesDescription":"SAGITTAL","BodyPartExamined":"CHEST","SeriesNumber":5,"Collection":"CPTAC-UCEC","PatientID":"C3L-03467","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":129},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.360389360742427667526070655843 252411455443025962816432148953860325447","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.334491271566855314830260417024 .104353760415096244893510486715328792697","Modality":"CT","SeriesDate":"2018-03-19 00:00:00.0","SeriesDescription":"CAP 3.0 SPO sag","BodyPartExamined":"ABDOMEN","SeriesNumber":5,"Collection":"CPTAC-UCEC","PatientID":"C3L-03467","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":123},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.658441262671287309457346305705 105584634054335527606285039437435359592","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.131126392922209124942161386151 58230391169750649153488661664117068107","Modality":"CT","SeriesDate":"2016-03-21 00:00:00.0","SeriesDescription":"Chest\/Abd\/Pel soft tissue 3.0 B20f","BodyPartExamined":"CHEST","SeriesNumber":2,"Collection":"CPTAC-UCEC","PatientID":"C3L-03467","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":306},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.933316195746120155903339740103 83482909094763399077117589653879292435","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.274616783627161175251743615553 1.3.6.1.4.1.14519.5.2.1.7695.1700.733313000644315272006192181431 77155367638621502173880012762024128638","Modality":"CT","SeriesDate":"2015-03-03 00:00:00.0","SeriesDescription":"Chest\/Abd\/Pel soft tissue 3.0 B20f","BodyPartExamined":"CHEST","SeriesNumber":2,"Collection":"CPTAC-UCEC","PatientID":"C3L-02747","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":306},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.220092773361369396087067751186 168021505333397181219936037252559107030","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.245270018412514241929134140425 .104353760415096244893510486715328792697","Modality":"CT","SeriesDate":"2018-03-19 00:00:00.0","SeriesDescription":"CAP 3.0 B60f","BodyPartExamined":"ABDOMEN","SeriesNumber":3,"Collection":"CPTAC-UCEC","PatientID":"C3L-03467","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":143},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.229054711046553504545787083659 62142467323605237784770516904000895215","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.179162285704690412763684330250 1.3.6.1.4.1.14519.5.2.1.7695.1700.234808560418629209017784958053 104353760415096244893510486715328792697","Modality":"CT","SeriesDate":"2018-03-19 00:00:00.0","SeriesDescription":"CAP 3.0 B20f","BodyPartExamined":"ABDOMEN","SeriesNumber":2,"Collection":"CPTAC-UCEC","PatientID":"C3L-03467","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":314},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.154616556555686498817341337478 185418111484555163150647086155869219756","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.177623757250131970264857092191 143508475032044659595485724455199959932","Modality":"CT","SeriesDate":"2016-07-24 00:00:00.0","SeriesDescription":"Abd\/Pel Lung 3.0 B60f","BodyPartExamined":"ABDOMEN","SeriesNumber":3,"Collection":"CPTAC-UCEC","PatientID":"C3L-05848","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":39},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.154110825244369885171851551255 68757738277706847815055494065671508981","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.284567351304426376226790714264 1.3.6.1.4.1.14519.5.2.1.7695.1700.324328467511449053797650611970 67953080284076345917473005680077306867","Modality":"CT","SeriesDate":"2016-09-26 00:00:00.0","SeriesDescription":"SAGITTAL","BodyPartExamined":"CHEST","SeriesNumber":5,"Collection":"CPTAC-UCEC","PatientID":"C3L-03467","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":149},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.741335780571671051586458569948 130260134778970397197450676012106042668","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.335719452327097001305227418372 1.3.6.1.4.1.14519.5.2.1.7695.1700.210538707954985296677398591978 192180924543597682091545532955797799290","Modality":"CT","SeriesDate":"2016-10-25 00:00:00.0","SeriesDescription":"Abd\/Pelvis 3.0 B60f","BodyPartExamined":"ABDOMEN","SeriesNumber":4,"Collection":"CPTAC-UCEC","PatientID":"C3L-05848","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":56},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.195983148423034180376334647727 52309835344870054201882678149260479935","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.244863941836141483641489109194 .1.58230391169750649153488661664117068107","Modality":"CT","SeriesDate":"2016-03-21 00:00:00.0","SeriesDescription":"Chest\/Abd\/Pel LUNG 3.0 B60f","BodyPartExamined":"CHEST","SeriesNumber":3,"Collection":"CPTAC-UCEC","PatientID":"C3L-03467","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":140},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.180831804100647525080922590445 100731759010416801525756814661582905453","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.134282805412721876700374897836 .192180924543597682091545532955797799290","Modality":"CT","SeriesDate":"2016-10-25 00:00:00.0","SeriesDescription":"Abd\/Pelvis 3.0 B20f","BodyPartExamined":"ABDOMEN","SeriesNumber":3,"Collection":"CPTAC-UCEC","PatientID":"C3L-05848","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":201},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.226038001772760333157260976449 37671622521464066812631978471928306007","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.248017107754573666956949261473 1.3.6.1.4.1.14519.5.2.1.7695.1700.304222333797754930798522430195 58230391169750649153488661664117068107","Modality":"CT","SeriesDate":"2016-03-21 00:00:00.0","SeriesDescription":"CORONAL","BodyPartExamined":"CHEST","SeriesNumber":4,"Collection":"CPTAC-UCEC","PatientID":"C3L-03467","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":84},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.571620122698689331448512191875 253168115551446290926256440815409084370","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.276008182492477899149189119200 1.3.6.1.4.1.14519.5.2.1.7695.1700.135612062012804030483357359425 67953080284076345917473005680077306867","Modality":"CT","SeriesDate":"2016-09-26 00:00:00.0","SeriesDescription":"CORONAL","BodyPartExamined":"CHEST","SeriesNumber":4,"Collection":"CPTAC-UCEC","PatientID":"C3L-03467","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":114},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.311831286327220528148178588078 224409518854330380839516384479543090458","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.509490993107578827767081500491 1.3.6.1.4.1.14519.5.2.1.7695.1700.288985999148727959387883654619 77155367638621502173880012762024128638","Modality":"CT","SeriesDate":"2015-03-03 00:00:00.0","SeriesDescription":"CORONAL","BodyPartExamined":"CHEST","SeriesNumber":4,"Collection":"CPTAC-UCEC","PatientID":"C3L-02747","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":85},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.180006052978659726439424740707 269703894431372598509100851602159288765","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.270834182764177195175091536181 1.3.6.1.4.1.14519.5.2.1.7695.1700.177962682118221509857252041052 143508475032044659595485724455199959932","Modality":"CT","SeriesDate":"2016-07-24 00:00:00.0","SeriesDescription":"CORONAL","BodyPartExamined":"ABDOMEN","SeriesNumber":4,"Collection":"CPTAC-UCEC","PatientID":"C3L-05848","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":71},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.332791230985209928247615451914 97934223577100833484431647137145455556","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.121164861481441093151316977794 1.3.6.1.4.1.14519.5.2.1.7695.1700.520396403274327587353342330294 1.67953080284076345917473005680077306867","Modality":"CT","SeriesDate":"2016-09-26 00:00:00.0","SeriesDescription":"Chest\/Abd\/Pel soft tissue 3.0 B20f","BodyPartExamined":"CHEST","SeriesNumber":2,"Collection":"CPTAC-UCEC","PatientID":"C3L-03467","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":312},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.195950422361997478270837056988 140707133919097170612230090340002977287","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.503697125043256633091008976690 1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.286 1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.288 1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.287 1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.285 |
MD5 Hierarchy
This API takes the following parameters:
- SeriesInstanceUID (optional)
- StudyInstanceUID (optional)
- PatientID (optional)
- Collection (optional)
Example getMD5Hierarchy Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getMD5Hierarchy" -d "Collection=LIDC" |
Code Block | ||
---|---|---|
| ||
3ef5cbc40b247c4a6f72a4f90f504ad1 |
Manufacturer Values and Counts API
The Manufacturer Values and Counts API returns the modality values plus the manufacturer count for the modality. It optionally takes the following parameters.
- Collection
- Modality
- Body Part Examined
Example getManufacturerValuesAndCounts Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getManufacturerValuesAndCounts?Modality=PT" |
The API returns the manufacturer and their counts.
Code Block | ||
---|---|---|
| ||
[
{"criteria":"DeJarnette Research Systems","count":"2"},
{"criteria":"FUJI PHOTO FILM Co., ltd.","count":"4"}
] |
MD5 Hash for Image API
Generates an MD5 Hierarchy for a given Collection, PatientID, StudyInstanceUID, or SeriesInstanceUID, which can be compared to a previously generated hierarchy to determine if any changes have occurred to the data.
The API takes one argument:
- sopInstanceUid
Example MD5 Hash for Image Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/getM5HashForImage?SOPInstanceUid=1.3.6.1.4.1.14519.5.2.1.6919.4624.302693755253199226108824913410" |
The API returns the MD5 hash.
Modality Values and Counts API
The Modality Values and Counts API returns the modality values plus the subject count for the modality. It optionally takes the following parameters.
- Collection
- BodyPartExamined
Example Modality Values and Counts Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getModalityValuesAndCounts?Collection=LIDC" |
The API returns the modalities and their counts.
Code Block | ||
---|---|---|
| ||
[
{"criteria":"CT","count":"397"}
] |
Restrictions for Simple Search API
The Restrictions on Simple Search API returns whether any series returned by simple search has commercial restrictions.
The API takes the same parameters as the Simple Search GUI.
Example getRestrictionsForSimpleSearch Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://localhost:8080/nbia-api/services/getRestrictionsForSimpleSearch" -d "criteriaType0=ThirdPartyAnalysis&value0=yes&sortField=subject&sortDirection=descending&start=0&size=1000000" |
The API returns "Yes" if there are commercial restrictions and "No" if there are not.
Series Metadata API
The Series Metadata API allows returns the metadata needed by the client for a set of series as CSV.
The API takes one argument:
- list- Comma-separated list of series to return
Example Series Metadata Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getSeriesMetadata2" -d "list=9999.293545899757968087866143572947417050996,9999.172212451609088872857235914630319746611" |
The API returns ok if successful, and the error if one occurs.
Code Block | ||
---|---|---|
| ||
Subject ID,Study UID,Study Description,Study Date,Series ID,Series Description,Number of images,File Size (Bytes),Collection Name,Modality,Manufacturer,3rd Party Analysis,Data Description URI,Series Number,License Name,License URL STS_010,104353760415096244893510486715328792697","Modality":"CT","SeriesDate":"2018-03-19 00:00:00.0","SeriesDescription":"CAP 3.0 SPO cor","BodyPartExamined":"ABDOMEN","SeriesNumber":4,"Collection":"CPTAC-UCEC","PatientID":"C3L-03467","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":101},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.43546293045303953649134661873116783074","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.192180924543597682091545532955797799290","Modality":"CT","SeriesDate":"2016-10-25 00:00:00.0","SeriesDescription":"Topogram 0.6 T20s","BodyPartExamined":"ABDOMEN","SeriesNumber":2,"Collection":"CPTAC-UCEC","PatientID":"C3L-05848","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":2},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.237642993417197417654052076474980244050","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.104353760415096244893510486715328792697","Modality":"CT","SeriesDate":"2018-03-19 00:00:00.0","SeriesDescription":"Topogram 0.6 T20s","BodyPartExamined":"ABDOMEN","SeriesNumber":1,"Collection":"CPTAC-UCEC","PatientID":"C3L-03467","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":1},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.261450458963518213442565909435054795413","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.67953080284076345917473005680077306867","Modality":"CT","SeriesDate":"2016-09-26 00:00:00.0","SeriesDescription":"Topogram 0.6 T20s","BodyPartExamined":"CHEST","SeriesNumber":1,"Collection":"CPTAC-UCEC","PatientID":"C3L-03467","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":1},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.5168.1900.154535988064062152660648619556,MRI LT LEG +C,2003-12-12,50446370192855283669200346817959448281","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.5168.1900.104193299251798317056218297018,2. AXIAL T1 BOTH LEGS - RESEARCH,48,25273786,Soft-tissue-Sarcoma,MR,GE MEDICAL SYSTEMS,,https://doi.org/10.7937/K9/TCIA.2015.7GO2GSKS,2,Creative Commons Attribution 3.0 Unported License,https://creativecommons.org/licenses/by/3.0/ |
Species Tax API
The Species Tax API returns the species taxonomy and takes no parameters.
Example Species Tax Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k https://services.cancerimagingarchive.net/nbia-api/services/getSpeciesTax |
The API returns the current species taxonomy.
Code Block | ||
---|---|---|
| ||
[{"speciesCode":"447612001","speciesDescription":"Mus musculus"},{"speciesCode":"448771007","speciesDescription":"Canis lupus familiaris"},{"speciesCode":"337915000","speciesDescription":"Homo sapiens"}] |
Species Values And Counts API
The Get Species Values And Counts API returns the values and counts for species and takes the same parameters as the Simple Search GUI.
Example Species Values And Counts Query
Code Block |
---|
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getSpeciesValuesAndCounts" |
The API returns the values and counts for species.
Code Block | ||
---|---|---|
| ||
[{"criteria":"337915000","count":"33650"},{"criteria":"447612001","count":"393"},{"criteria":"448771007","count":"57"}] |
Study Drill Down With Series IDs API
The Study Drill Down API provides the functionality in the portal where the user drills down to the studies and series associated with a given user.
The API takes a list of series to query, using the parameter "list," that is repeated for each series instance UIDs you want to retrieve.
Example Study Drill Down With Series IDs Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getStudyDrillDownWithSeriesIds" -d "list=88.8.327219764444138790630242591550292040652&list=88.8.48940758713094405889891485363115655700" |
The Study Drill Down With Series Ids API returns JSON with the information to populate the drill down to study screen. There can be multiple studies.
Code Block | ||
---|---|---|
| ||
[ {"studyId" : "88.8.40100432719994870453539459050137164864",
"date" : 671515200000,
"description" : "CT CHEST W/O CONTRAST",
"id" : 1310720,
"seriesList" : [ {
"seriesNumber" : "3",
"seriesUID" : "88.8.326983478845196402838719404831299211067",
"numberImages" : 9,
"modality" : "CT",
"manufacturer" : null,
"annotationsFlag" : false,
"annotationsSize" : 0,
"patientId" : "Project-3076386612",
"patientPkId" : "1277952",
"studyId" : "88.8.40100432719994870453539459050137164864",
"studyPkId" : 1310720,
"totalSizeForAllImagesInSeries" : 4739336,
"project" : "Project",
"description" : "LUNG",
"dataProvenanceSiteName" : null,
"manufacturerModelName" : null,
"softwareVersion" : null,
"maxFrameCount" : "0",
"seriesId" : "88.8.326983478845196402838719404831299211067",
"seriesPkId" : 1376256,
"exactSize" : 4739336 } ]} ] |
Thumbnail API
The Get Thumbnail API returns the DICOM tags and values associated with the image.
- seriesUID
- objectUID
Example Thumbnail Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getThumbnail" -d "seriesUID=143508475032044659595485724455199959932","Modality":"CT","SeriesDate":"2016-07-24 00:00:00.0","SeriesDescription":"Topogram 0.6 T20s","BodyPartExamined":"ABDOMEN","SeriesNumber":1,"Collection":"CPTAC-UCEC","PatientID":"C3L-05848","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":2},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.257013319324343199851187045765222186475","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.77155367638621502173880012762024128638","Modality":"CT","SeriesDate":"2015-03-03 00:00:00.0","SeriesDescription":"Topogram 0.6 T20s","BodyPartExamined":"CHEST","SeriesNumber":1,"Collection":"CPTAC-UCEC","PatientID":"C3L-02747","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":1},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.155009580845247983590647218721888717749","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.58230391169750649153488661664117068107","Modality":"CT","SeriesDate":"2016-03-21 00:00:00.0","SeriesDescription":"Topogram 0.6 T20s","BodyPartExamined":"CHEST","SeriesNumber":1,"Collection":"CPTAC-UCEC","PatientID":"C3L-03467","Manufacturer":"SIEMENS","ManufacturerModelName":"Sensation 64","SoftwareVersions":"syngo CT 2014A","ImageCount":1},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.205668089768657343528117029713103142029","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.177774985137352576417359587837444674436","Modality":"MR","ProtocolName":"t1_vibe_tra_recon coronal too","SeriesDate":"1994-04-18 00:00:00.0","SeriesDescription":"_T1_t1_vibe_tra_recon coronal too","BodyPartExamined":"HEAD","SeriesNumber":7,"Collection":"Vestibular-Schwannoma-MC-RC","PatientID":"VS-SEG-032","Manufacturer":"SIEMENS","ManufacturerModelName":"SymphonyTim","SoftwareVersions":"syngo MR B17","ImageCount":24},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.3023.4024.536949365601910993926257264114&objectUID=171418726181894059770838067663080088554","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.3023.4024.822829852603295162591249163632" --output Thumbnail.jpg |
The API returns a JPG thumbnail.
Text Search API
The text search API is used to run queries for Text Search in the portal. The text search takes an argument, textValue.
Example Text Search Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization Bearer: YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getTextSearch" -d "textValue=lung" |
Note that the returned JSON now includes the "hit" that was found by the Solr search engine.
Code Block | ||
---|---|---|
| ||
[{
"subjectId":"Project-3076386612",
"project":"Project",
"id":1277952,
"totalNumberOfStudies":1,
"totalNumberOfSeries":1,
"hit":"<em>seriesDesc</em>: <strong>LUNG</strong>",
"studyIdentifiers":[{
"seriesIdentifiers":[1376256],
"studyIdentifier":1310720
}]
}] |
Updated Series API
This API returns the series that have been updated since a given date.
The API takes one argument:
- fromDate - the date to get the updates have happened
Example Get Updated Series Query
Code Block | ||
---|---|---|
| ||
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/getUpdatedSeries?fromDate=01/01/2020" |
The API returns the updated series.
Code Block | ||
---|---|---|
| ||
[ { 208289673453114055830732280203640249870","Modality":"MR","ProtocolName":"COR_T2","SeriesDate":"2011-11-27 00:00:00.0","SeriesDescription":"COR_T2","BodyPartExamined":"ABDOMEN","SeriesNumber":3,"Collection":"CPTAC-CCRCC","PatientID":"C3L-01463","Manufacturer":"SIEMENS","ManufacturerModelName":"Aera","SoftwareVersions":"syngo MR E11","ImageCount":30},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.103502325371497058487486382016244519383","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.208289673453114055830732280203640249870","Modality":"MR","ProtocolName":"AX_T1_FS_+C_20_SEC","SeriesDate":"2011-11-27 00:00:00.0","SeriesDescription":"AX_T1_FS_+C_20_SEC","BodyPartExamined":"ABDOMEN","SeriesNumber":13,"Collection":"CPTAC-CCRCC","PatientID":"C3L-01463","Manufacturer":"SIEMENS","ManufacturerModelName":"Aera","SoftwareVersions":"syngo MR E11","ImageCount":80},{"SeriesInstanceUID":"1.3.6.1.4.1.596214519.5.12.1.0.0.1560173490.85106.1108338939505521682156134341331869087312", "StudyInstanceUID":"1.3.6.1.4.1.596214519.5.12.1.0.1560173490.85106.1", "Modality":"SR", 208289673453114055830732280203640249870","Modality":"MR","ProtocolName":"AX_T1_FS+C_90_SEC","SeriesDate":"20162011-0111-0627 00:00:00.0", "SeriesDescription":"PDM Mouse Overview", "SeriesDescription":"AX_T1_FS+C_90_SEC","BodyPartExamined":"ABDOMEN","SeriesNumber":1, 14,"Collection":"ProjectCPTAC-CCRCC", "PatientID":"128783-104-T_VQ4", C3L-01463","Manufacturer":"PixelMedSIEMENS", "ManufacturerModelName":"XSLTAera", "SoftwareVersions":"0.1syngo MR E11", "ImageCount":80},{"SeriesInstanceUID":1 }"1.3.6 |