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 |
---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getBodyPartValuesAndCounts?Modality=PT" |
Sample Results The API returns the body parts and their counts. Code Block |
---|
| [
{"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"}
] |
Collection DescriptionsThis API takes a collection name and returns the collection's description. The API takes one parameter: - collectionName (optional)
Example getCollectionDescriptions Query 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 DOIThe 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 CountsThe 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 APIThe 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> |
ResponseList created. 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: The SeriesUID is available from the Drill Down API call. 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 APIThe 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
- ImageModalityCriteria
- AnatomicalSiteCriteria
- ManufacturerCriteria
- DateRangeCriteria
- fromDate - Formatted "dd/mm/yyyy"
- toDate - Formatted "dd/mm/yyyy"
- PatientCriteria
- MinNumberOfStudiesCriteria
- SpeciesCriteria
- PhantomCriteria
- TimePointCriteria
- eventType the eventType for the timepoint
- fromDate - Formatted "dd/mm/yyyy"
- toDate - Formatted "dd/mm/yyyy"
- SortField
- SortDirection
- Start
- Size
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 APIThis 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.6919.4624.313514201353787659031503464798"
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://public.cancerimagingarchive.net/nbia-api/services/v2/getM5HashForImage?SOPInstanceUid=1.3.6.1.4.1.14519.5.2.1.6834.5010.129790817462380794533151446268" |
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 APIThe 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=1000000100" |
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=
=https://nbia.cancerimagingarchive.net/nbia-download/servlet/DownloadServlet
includeAnnotation=false
noOfrRetry=4
databasketId=manifest-1693254833353.tcia
manifestVersion=3.0
ListOfSeriesToDownload=
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1264
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1263
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1261
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1265
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1262
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1274
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1270
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1269
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1273
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1271
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1272
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1275
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1267
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1266
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1268
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1284
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1280
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1279
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1283
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1282
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1281
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1285
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1277
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1276
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1278
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1294
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1289
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1290
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1293
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1292
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1296
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1291
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1287
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1286
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1288
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1299
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1297
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1295
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.1298
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.100
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.96
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.98
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.103
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.97
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.101
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.105
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.99
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.102
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.106
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.108
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.109
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.107
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.115
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.113
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.104
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.110
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.112
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.111
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.114
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.123
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.117
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.119
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.125
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.122
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.118
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.124
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.120
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.116
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.121
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.134
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.133
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.128
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.135
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.127
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.132
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.130
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.126
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.129
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.142
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.131
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.144
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.148
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.137
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.138
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.143
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.136
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.139
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.141
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.154
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.147
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.140
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.152
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.155
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.145
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.146
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.153
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.157
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.151
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.149
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.163
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.164
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.150
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.165
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.160
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.162
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.156
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.167
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.159
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.172
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.174
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.158
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.161
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.176
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.168
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.166
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.173
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.177
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.182
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.183
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.170
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.169
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.171
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.187
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.175
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.186
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.178
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.193
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.181
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.180
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.184
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.194
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.179
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.185
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.198
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.190
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.206
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.191
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.188
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.195
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.189
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.202
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.192
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.207
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.196
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.199
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.203
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.213
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.204
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.200
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.197
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.201
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.214
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.212
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.205
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.217
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.224
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.209
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.210
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.211
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.208
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.216
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.222
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.227
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.218
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.219
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.223
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.215
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.220
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.221
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.235
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.225
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.233
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.234
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.232
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.228
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.230
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.231
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.229
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.245
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.226
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.242
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.237
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.241
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.248
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.239
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.240
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.236
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.253
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.243
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.238
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.244
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.254
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.257
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.252
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.250
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.251
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.246
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.249
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.264
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.247
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.263
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.269
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.256
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.258
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.260
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.262
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.255
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.275
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.259
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.261
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.272
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.266
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.277
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.267
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.270
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.271
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.265
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.283
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.268
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.273
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.282
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.274
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.276
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.281
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.284
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.278
1.3.6.1.4.1.5962.1.1.0.0.1548529146.50549.279
1.3.6.1.4.1.5962.1.1.0.93280.501548529146.350549.336280 |
Manifest Text APIThe 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=1.3.6.1.4.1.9328.50.3.336.14519.5.2.1.6834.5010.100089621274100103247029607723&includeAnnotation=false" |
The API returns text that can be used as a manifest file for the NBIA Data Retriever. Code Block |
---|
| "downloadServerUrl=https://servicesnbia.cancerimagingarchive.net/nbia-download/servlet/DownloadServlet
includeAnnotation=false
noOfrRetry=4
databasketId=manifest-15238665703031692722233257.tcia
manifestVersion=3.0
ListOfSeriesToDownload=
1.3.6.1.4.1.9328.50.3.33614519.5.2.1.6834.5010.100089621274100103247029607723" |
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. This API takes the following parameter: Example getManifestForTextSearch Query Code Block |
---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -X POST "https://services.cancerimagingarchive.net/nbia-api/services/getManifestForTextSearchGetManifestForTextSearch" -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.3.6.1.4.1.9328.50.4.563784
1.3.6.1.4.1.9328.50.4.568673
1.3.6.1.4.1.9328.50.4.568676
1.3.6.1.4.1.9328.50.4.568678
1.3.6.1.4.1.9328.50.4.569267
1.3.6.1.4.1.9328.50.4.569270
1.3.6.1.4.1.9328.50.4.569273
1.3.6.1.4.1.9328.50.4.569823
1.3.6.1.4.1.9328.50.4.571319
1.3.6.1.4.1.9328.50.4.571323
1.3.6.1.4.1.9328.50.4.571803
1.3.6.1.4.1.9328.50.4.571808
1.3.6.1.4.1.9328.50.4.572414
1.3.6.1.4.1.9328.50.4.572418
1.3.6.1.4.1.9328.50.4.572422
1.3.6.1.4.1.9328.50.4.572425
1.3.6.1.4.1.9328.50.4.572983
1.3.6.1.4.1.9328.50.4.573038
1.3.6.1.4.1.9328.50.4.573635
1.3.6.1.4.1.9328.50.4.573639
1.3.6.1.4.1.9328.50.4.574149
1.3.6.1.4.1.9328.50.4.574153
1.3.6.1.4.1.9328.50.4.578325
1.3.6.1.4.1.9328.50.4.578328
1.3.6.1.4.1.9328.50.4.578331
1.3.6.1.4.1.9328.50.4.578901
1.3.6.1.4.1.9328.50.4.579479
1.3.6.1.4.1.9328.50.4.579482
1.3.6.1.4.1.9328.50.4.579494
1.3.6.1.4.1.9328.50.4.580056
1.3.6.1.4.1.9328.50.4.579487
1.3.6.1.4.1.9328.50.4.579490
1.3.6.1.4.1.9328.50.4.580594
1.3.6.1.4.1.9328.50.4.581140
1.3.6.1.4.1.9328.50.4.590291
1.3.6.1.4.1.9328.50.4.590294
1.3.6.1.4.1.9328.50.4.590297
1.3.6.1.4.1.9328.50.4.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.3.6.1.4.1.9328.50.4.591516
1.3.6.1.4.1.9328.50.4.591522
1.3.6.1.4.1.9328.50.4.591975
1.3.6.1.4.1.9328.50.4.592513
1.3.6.1.4.1.9328.50.4.593093
1.3.6.1.4.1.9328.50.4.593096
1.3.6.1.4.1.9328.50.4.593099
1.3.6.1.4.1.9328.50.4.593601
1.3.6.1.4.1.9328.50.4.594099
1.3.6.1.4.1.9328.50.4.594613
1.3.6.1.4.1.9328.50.4.595110
1.3.6.1.4.1.9328.50.4.595623
1.3.6.1.4.1.9328.50.4.596197
1.3.6.1.4.1.9328.50.4.596737
1.3.6.1.4.1.9328.50.4.600540
1.3.6.1.4.1.9328.50.4.600543
1.3.6.1.4.1.9328.50.4.601079
1.3.6.1.4.1.9328.50.4.601082
1.3.6.1.4.1.9328.50.4.601085
1.3.6.1.4.1.9328.50.4.601643
1.3.6.1.4.1.9328.50.4.604326
1.3.6.1.4.1.9328.50.4.604330
1.3.6.1.4.1.9328.50.4.604333
1.3.6.1.4.1.9328.50.4.604801
1.3.6.1.4.1.9328.50.4.604806
1.3.6.1.4.1.9328.50.4.607091
1.3.6.1.4.1.9328.50.4.607094
1.3.6.1.4.1.9328.50.4.607097
1.3.6.1.4.1.9328.50.4.618649
1.3.6.1.4.1.9328.50.4.610796
1.3.6.1.4.1.9328.50.4.610799
1.3.6.1.4.1.9328.50.4.610803
1.3.6.1.4.1.9328.50.4.611364
1.3.6.1.4.1.9328.50.4.611919
1.3.6.1.4.1.9328.50.4.612031
1.3.6.1.4.1.9328.50.4.612039
1.3.6.1.4.1.9328.50.4.612593
1.3.6.1.4.1.9328.50.4.612598
1.3.6.1.4.1.9328.50.4.613155
1.3.6.1.4.1.9328.50.4.613159
1.3.6.1.4.1.9328.50.4.613786
1.3.6.1.4.1.9328.50.4.613791
1.3.6.1.4.1.9328.50.4.613794
1.3.6.1.4.1.9328.50.4.614396
1.3.6.1.4.1.9328.50.4.614399 |
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: - 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.3.6.1.4.1.14519.5.2.1.7695.1700.250955243295773832626617549482
1.3.6.1.4.1.14519.5.2.1.7695.1700.360389360742427667526070655843
1.3.6.1.4.1.14519.5.2.1.7695.1700.334491271566855314830260417024
1.3.6.1.4.1.14519.5.2.1.7695.1700.658441262671287309457346305705
1.3.6.1.4.1.14519.5.2.1.7695.1700.131126392922209124942161386151
1.3.6.1.4.1.14519.5.2.1.7695.1700.933316195746120155903339740103
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
1.3.6.1.4.1.14519.5.2.1.7695.1700.220092773361369396087067751186
1.3.6.1.4.1.14519.5.2.1.7695.1700.245270018412514241929134140425
1.3.6.1.4.1.14519.5.2.1.7695.1700.229054711046553504545787083659
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
1.3.6.1.4.1.14519.5.2.1.7695.1700.154616556555686498817341337478
1.3.6.1.4.1.14519.5.2.1.7695.1700.177623757250131970264857092191
1.3.6.1.4.1.14519.5.2.1.7695.1700.154110825244369885171851551255
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
1.3.6.1.4.1.14519.5.2.1.7695.1700.741335780571671051586458569948
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
1.3.6.1.4.1.14519.5.2.1.7695.1700.195983148423034180376334647727
1.3.6.1.4.1.14519.5.2.1.7695.1700.244863941836141483641489109194
1.3.6.1.4.1.14519.5.2.1.7695.1700.180831804100647525080922590445
1.3.6.1.4.1.14519.5.2.1.7695.1700.134282805412721876700374897836
1.3.6.1.4.1.14519.5.2.1.7695.1700.226038001772760333157260976449
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
1.3.6.1.4.1.14519.5.2.1.7695.1700.571620122698689331448512191875
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
1.3.6.1.4.1.14519.5.2.1.7695.1700.311831286327220528148178588078
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
1.3.6.1.4.1.14519.5.2.1.7695.1700.180006052978659726439424740707
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
1.3.6.1.4.1.14519.5.2.1.7695.1700.332791230985209928247615451914
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.3.6.1.4.1.14519.5.2.1.7695.1700.195950422361997478270837056988
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 HierarchyThis 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 APIThe 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 APIGenerates 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 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 APIThe 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 APIThe 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. 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
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,1.3.6.1.4.1.14519.5.2.1.5168.1900.154535988064062152660648619556,MRI LT LEG +C,2003-12-12,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 APIThe 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 APIThe 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 APIThe 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. Example Thumbnail Query Code Block |
---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getThumbnail" -d "seriesUID=1.3.6.1.4.1.14519.5.2.1.3023.4024.536949365601910993926257264114&objectUID=1.3.6.1.4.1.14519.5.2.1.3023.4024.822829852603295162591249163632" --output Thumbnail.jpg |
The API returns a JPG thumbnail. Text Search APIThe 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 APIThis 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 |
---|
| [
{
"SeriesInstanceUID":"1.3.6.1.4.1.5962.1.1.0.0.1560173490.85106.1",
"StudyInstanceUID":"1.3.6.1.4.1.5962.1.1.0.1560173490.85106.1",
"Modality":"SR",
"SeriesDate":"2016-01-06 00:00:00.0",
"SeriesDescription":"PDM Mouse Overview",
"SeriesNumber":1,
"Collection":"Project",
"PatientID":"128783-104-T_VQ4",
"Manufacturer":"PixelMed",
"ManufacturerModelName":"XSLT",
"SoftwareVersions":"0.1",
"ImageCount":1
} |
|