Body Part Values and CountsExample 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" |
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 DescriptionsExample getCollectionDescriptions Query Code Block |
---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getCollectionDescriptions?collectionName=4D-Lung" |
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 DOIExample 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" |
Return Value for Collection Code Block |
---|
| [{""collection"":""4D-Lung"",""seriesInstanceUID"":null,""thirdPartyAnanlysis"":null}] |
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 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 CountsExample Collection Values And Counts Query Code Block |
---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getCollectionValuesAndCounts" |
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 CartExample 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> 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 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 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 HashExample Image with MD5 Hash Query Code Block |
---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN” -k "https://public.cancerimagingarchive.net/nbia-api/services/v2/getImageWithMD5Hash?SeriesInstanceUID=1.3.6.1.4.1.14519.5.2.1.6834.5010.100089621274100103247029607723" |
Manifest for Simple SearchExample 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=100" |
Code Block |
---|
| downloadServerUrl=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 |
Manifest TextExample 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.14519.5.2.1.6834.5010.100089621274100103247029607723&includeAnnotation=false" |
Code Block |
---|
| "downloadServerUrl=https://nbia.cancerimagingarchive.net/nbia-download/servlet/DownloadServlet
includeAnnotation=false
noOfrRetry=4
databasketId=manifest-1692722233257.tcia
manifestVersion=3.0
ListOfSeriesToDownload=
1.3.6.1.4.1.14519.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. 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.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 |
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-1692722426170.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 |
MD5 HierarchyExample getMD5Hierarchy Query Code Block |
---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getMD5Hierarchy" -d "Collection=ISPY1" |
Code Block |
---|
| ce9ec0fd7cb437e5cd6b65cf358eea6a |
Manufacturer Values and Counts APIExample getManufacturerValuesAndCounts Query Code Block |
---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getManufacturerValuesAndCounts?Collection=4D-Lung" |
Code Block |
---|
| [{"criteria":"ADAC","count":"20"},{"criteria":"Varian Imaging Laboratories, Switzerland","count":"20"}] |
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 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.6834.5010.129790817462380794533151446268" |
Code Block |
---|
| f9a9afbc6a5295cead66f43a5965080d |
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. - 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=VICTRE" |
The API returns the modalities and their counts. Code Block |
---|
| [{"criteria":"MG","count":"2994"}] |
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 Code Block |
---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/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. Code Block |
---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k https://services.cancerimagingarchive.net/nbia-api/services/getSeriesMetadata2" -d "list=2.25.110315838408248624082166543013557943798" |
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","Date Released","Series Date","Protocol Name","Body Part Examined","Annotations Flag","Manufacturer Model Name","Software Versions","TimeStamp"
"9189822998","2.25.144594706293612984382396531662084750838","CT HIP W/O CONTRAST,BILAT","1989-02-15","2.25.110315838408248624082166543013557943798","Surview Test","5","3414180","Col4","CT","Philips","NO","","5865","Creative Commons Attribution 3.0 Unported License","http://creativecommons.org/licenses/by/3.0/","","","Abd/Pelvis W/C/Abdomen/Sv","BLADDER","","Mx8000 IDT 16","3.2.0","2023-11-28 20:29:48.0" |
Species TaxThe 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 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 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":"33793"},{"criteria":"447612001","count":"393"},{"criteria":"448771007","count":"57"}] |
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 Code Block |
---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/getStudyDrillDownWithSeriesIds" -d "list=1.3.6.1.4.1.14519.5.2.1.6834.5010.322628904903035357840500590726" |
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":"1.3.6.1.4.1.14519.5.2.1.6834.5010.335014117706890137582032169351","date":874299600000,"description":"p4","id":221806615,"study_id":null,"excludeCommercial":null,"seriesList":[{"seriesNumber":"500","seriesUID":"1.3.6.1.4.1.14519.5.2.1.6834.5010.322628904903035357840500590726","numberImages":50,"modality":"CT","manufacturer":"Varian Imaging Laboratories, Switzerland","annotationsFlag":false,"annotationsSize":0,"patientId":"100_HM10395","patientPkId":"221773824","studyId":"1.3.6.1.4.1.14519.5.2.1.6834.5010.335014117706890137582032169351","studyPkId":221806615,"totalSizeForAllImagesInSeries":26405888,"project":"4D-Lung","description":"P4^P100^S100^I0, Gated, 0.0%","dataProvenanceSiteName":null,"manufacturerModelName":null,"softwareVersion":null,"maxFrameCount":"0","studyDate":null,"studyDesc":null,"bodyPartExamined":"LUNG","study_id":null,"thirdPartyAnalysis":null,"descriptionURI":"https://doi.org/10.7937/K9/TCIA.2016.ELN8YGLE","sopClassUID":null,"licenseName":null,"licenseUrl":null,"commercialRestrictions":false,"seriesId":"1.3.6.1.4.1.14519.5.2.1.6834.5010.322628904903035357840500590726","studyDateString":"","seriesPkId":221872172,"exactSize":26405888}]}] |
ThumbnailThe 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. Code Block |
---|
| " % Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 13757 0 13608 100 149 13608 149 0:00:01 --:--:-- 0:00:01 14435" |
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 Code Block |
---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -X POST "https://services.cancerimagingarchive.net/nbia-api/services/getTextSearch" -d "textValue=mouse" |
Note that the returned JSON now includes the "hit" that was found by the Solr search engine. Code Block |
---|
| [{"subjectId":"292921-168-R-1404","project":"PDMR-292921-168-R","id":716669003,"totalNumberOfStudies":4,"totalNumberOfSeries":7,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[716734938,716734939],"seriesAndModality":[],"studyIdentifier":716701807},{"seriesIdentifiers":[716734940,716734941],"seriesAndModality":[],"studyIdentifier":716701808},{"seriesIdentifiers":[716734942,716734943],"seriesAndModality":[],"studyIdentifier":716701809},{"seriesIdentifiers":[716734944],"seriesAndModality":[],"studyIdentifier":716701810}]},{"subjectId":"292921-168-R-1405","project":"PDMR-292921-168-R","id":679608323,"totalNumberOfStudies":5,"totalNumberOfSeries":9,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[679706630,679706631],"seriesAndModality":[],"studyIdentifier":679641091},{"seriesIdentifiers":[716734890,716734891],"seriesAndModality":[],"studyIdentifier":716701780},{"seriesIdentifiers":[716734892],"seriesAndModality":[],"studyIdentifier":716701781},{"seriesIdentifiers":[716734893,716734894],"seriesAndModality":[],"studyIdentifier":716701782},{"seriesIdentifiers":[716734895,716734896],"seriesAndModality":[],"studyIdentifier":716701783}]},{"subjectId":"292921-168-R-1406","project":"PDMR-292921-168-R","id":716668994,"totalNumberOfStudies":4,"totalNumberOfSeries":7,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[716734867],"seriesAndModality":[],"studyIdentifier":716701766},{"seriesIdentifiers":[716734868,716734869],"seriesAndModality":[],"studyIdentifier":716701767},{"seriesIdentifiers":[716734870,716734871],"seriesAndModality":[],"studyIdentifier":716701768},{"seriesIdentifiers":[716734872,716734873],"seriesAndModality":[],"studyIdentifier":716701769}]},{"subjectId":"292921-168-R-1407","project":"PDMR-292921-168-R","id":679608326,"totalNumberOfStudies":5,"totalNumberOfSeries":9,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[679706636,679706637],"seriesAndModality":[],"studyIdentifier":679641094},{"seriesIdentifiers":[716734966,716734967],"seriesAndModality":[],"studyIdentifier":716701823},{"seriesIdentifiers":[716734968,716734969],"seriesAndModality":[],"studyIdentifier":716701824},{"seriesIdentifiers":[716734970,716734971],"seriesAndModality":[],"studyIdentifier":716701825},{"seriesIdentifiers":[716734972],"seriesAndModality":[],"studyIdentifier":716701826}]},{"subjectId":"292921-168-R-1408","project":"PDMR-292921-168-R","id":679608325,"totalNumberOfStudies":5,"totalNumberOfSeries":9,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[679706634,679706635],"seriesAndModality":[],"studyIdentifier":679641093},{"seriesIdentifiers":[716734981,716734982],"seriesAndModality":[],"studyIdentifier":716701832},{"seriesIdentifiers":[716734983,716734984],"seriesAndModality":[],"studyIdentifier":716701833},{"seriesIdentifiers":[716734985],"seriesAndModality":[],"studyIdentifier":716701834},{"seriesIdentifiers":[716734986,716734987],"seriesAndModality":[],"studyIdentifier":716701835}]},{"subjectId":"292921-168-R-1409","project":"PDMR-292921-168-R","id":716668996,"totalNumberOfStudies":4,"totalNumberOfSeries":7,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[716734875,716734876],"seriesAndModality":[],"studyIdentifier":716701771},{"seriesIdentifiers":[716734877,716734878],"seriesAndModality":[],"studyIdentifier":716701772},{"seriesIdentifiers":[716734879,716734880],"seriesAndModality":[],"studyIdentifier":716701773},{"seriesIdentifiers":[716734881],"seriesAndModality":[],"studyIdentifier":716701774}]},{"subjectId":"292921-168-R-1410","project":"PDMR-292921-168-R","id":679608327,"totalNumberOfStudies":5,"totalNumberOfSeries":9,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[679706638,679706639],"seriesAndModality":[],"studyIdentifier":679641095},{"seriesIdentifiers":[716734918,716734919],"seriesAndModality":[],"studyIdentifier":716701796},{"seriesIdentifiers":[716734920,716734921],"seriesAndModality":[],"studyIdentifier":716701797},{"seriesIdentifiers":[716734922],"seriesAndModality":[],"studyIdentifier":716701798},{"seriesIdentifiers":[716734923,716734924],"seriesAndModality":[],"studyIdentifier":716701799}]},{"subjectId":"292921-168-R-1411","project":"PDMR-292921-168-R","id":679608321,"totalNumberOfStudies":5,"totalNumberOfSeries":9,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[679706626,679706627],"seriesAndModality":[],"studyIdentifier":679641089},{"seriesIdentifiers":[716734996],"seriesAndModality":[],"studyIdentifier":716701841},{"seriesIdentifiers":[716734997,716734998],"seriesAndModality":[],"studyIdentifier":716701842},{"seriesIdentifiers":[716734999,716735000],"seriesAndModality":[],"studyIdentifier":716701843},{"seriesIdentifiers":[716735001,716735002],"seriesAndModality":[],"studyIdentifier":716701844}]},{"subjectId":"292921-168-R-1412","project":"PDMR-292921-168-R","id":716668993,"totalNumberOfStudies":4,"totalNumberOfSeries":7,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[716734860],"seriesAndModality":[],"studyIdentifier":716701762},{"seriesIdentifiers":[716734861,716734862],"seriesAndModality":[],"studyIdentifier":716701763},{"seriesIdentifiers":[716734863,716734864],"seriesAndModality":[],"studyIdentifier":716701764},{"seriesIdentifiers":[716734865,716734866],"seriesAndModality":[],"studyIdentifier":716701765}]},{"subjectId":"292921-168-R-1413","project":"PDMR-292921-168-R","id":679608328,"totalNumberOfStudies":5,"totalNumberOfSeries":9,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[679706640,679706641],"seriesAndModality":[],"studyIdentifier":679641096},{"seriesIdentifiers":[716734904,716734905],"seriesAndModality":[],"studyIdentifier":716701788},{"seriesIdentifiers":[716734906,716734907],"seriesAndModality":[],"studyIdentifier":716701789},{"seriesIdentifiers":[716734908],"seriesAndModality":[],"studyIdentifier":716701790},{"seriesIdentifiers":[716734909,716734910],"seriesAndModality":[],"studyIdentifier":716701791}]},{"subjectId":"292921-168-R-1414","project":"PDMR-292921-168-R","id":716669004,"totalNumberOfStudies":4,"totalNumberOfSeries":7,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[716734945],"seriesAndModality":[],"studyIdentifier":716701811},{"seriesIdentifiers":[716734946,716734947],"seriesAndModality":[],"studyIdentifier":716701812},{"seriesIdentifiers":[716734948,716734949],"seriesAndModality":[],"studyIdentifier":716701813},{"seriesIdentifiers":[716734950,716734951],"seriesAndModality":[],"studyIdentifier":716701814}]},{"subjectId":"292921-168-R-1415","project":"PDMR-292921-168-R","id":679608329,"totalNumberOfStudies":5,"totalNumberOfSeries":9,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[679706642,679706643],"seriesAndModality":[],"studyIdentifier":679641097},{"seriesIdentifiers":[716734988,716734989],"seriesAndModality":[],"studyIdentifier":716701836},{"seriesIdentifiers":[716734990,716734991],"seriesAndModality":[],"studyIdentifier":716701837},{"seriesIdentifiers":[716734992,716734993],"seriesAndModality":[],"studyIdentifier":716701838},{"seriesIdentifiers":[716734994],"seriesAndModality":[],"studyIdentifier":716701839}]},{"subjectId":"292921-168-R-1416","project":"PDMR-292921-168-R","id":679608324,"totalNumberOfStudies":5,"totalNumberOfSeries":9,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[679706632,679706633],"seriesAndModality":[],"studyIdentifier":679641092},{"seriesIdentifiers":[716734959,716734960],"seriesAndModality":[],"studyIdentifier":716701819},{"seriesIdentifiers":[716734961],"seriesAndModality":[],"studyIdentifier":716701820},{"seriesIdentifiers":[716734962,716734963],"seriesAndModality":[],"studyIdentifier":716701821},{"seriesIdentifiers":[716734964,716734965],"seriesAndModality":[],"studyIdentifier":716701822}]},{"subjectId":"292921-168-R-1417","project":"PDMR-292921-168-R","id":716668999,"totalNumberOfStudies":4,"totalNumberOfSeries":7,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[716734911],"seriesAndModality":[],"studyIdentifier":716701792},{"seriesIdentifiers":[716734912,716734913],"seriesAndModality":[],"studyIdentifier":716701793},{"seriesIdentifiers":[716734914,716734915],"seriesAndModality":[],"studyIdentifier":716701794},{"seriesIdentifiers":[716734916,716734917],"seriesAndModality":[],"studyIdentifier":716701795}]},{"subjectId":"292921-168-R-1418","project":"PDMR-292921-168-R","id":716669006,"totalNumberOfStudies":4,"totalNumberOfSeries":7,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[716734974],"seriesAndModality":[],"studyIdentifier":716701828},{"seriesIdentifiers":[716734975,716734976],"seriesAndModality":[],"studyIdentifier":716701829},{"seriesIdentifiers":[716734977,716734978],"seriesAndModality":[],"studyIdentifier":716701830},{"seriesIdentifiers":[716734979,716734980],"seriesAndModality":[],"studyIdentifier":716701831}]},{"subjectId":"292921-168-R-1419","project":"PDMR-292921-168-R","id":679608330,"totalNumberOfStudies":5,"totalNumberOfSeries":9,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[679706644,679706645],"seriesAndModality":[],"studyIdentifier":679641098},{"seriesIdentifiers":[716734882,716734883],"seriesAndModality":[],"studyIdentifier":716701775},{"seriesIdentifiers":[716734884,716734885],"seriesAndModality":[],"studyIdentifier":716701776},{"seriesIdentifiers":[716734886],"seriesAndModality":[],"studyIdentifier":716701777},{"seriesIdentifiers":[716734887,716734888],"seriesAndModality":[],"studyIdentifier":716701778}]},{"subjectId":"292921-168-R-1420","project":"PDMR-292921-168-R","id":679608322,"totalNumberOfStudies":5,"totalNumberOfSeries":9,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[679706628,679706629],"seriesAndModality":[],"studyIdentifier":679641090},{"seriesIdentifiers":[716734952,716734953],"seriesAndModality":[],"studyIdentifier":716701815},{"seriesIdentifiers":[716734954,716734955],"seriesAndModality":[],"studyIdentifier":716701816},{"seriesIdentifiers":[716734956,716734957],"seriesAndModality":[],"studyIdentifier":716701817},{"seriesIdentifiers":[716734958],"seriesAndModality":[],"studyIdentifier":716701818}]},{"subjectId":"292921-168-R-1421","project":"PDMR-292921-168-R","id":716668998,"totalNumberOfStudies":4,"totalNumberOfSeries":7,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[716734897,716734898],"seriesAndModality":[],"studyIdentifier":716701784},{"seriesIdentifiers":[716734899],"seriesAndModality":[],"studyIdentifier":716701785},{"seriesIdentifiers":[716734900,716734901],"seriesAndModality":[],"studyIdentifier":716701786},{"seriesIdentifiers":[716734902,716734903],"seriesAndModality":[],"studyIdentifier":716701787}]},{"subjectId":"425362-245-T-1505","project":"PDMR-425362-245-T","id":737935370,"totalNumberOfStudies":4,"totalNumberOfSeries":7,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738000906],"seriesAndModality":[],"studyIdentifier":737968138},{"seriesIdentifiers":[738000907,738000909],"seriesAndModality":[],"studyIdentifier":737968139},{"seriesIdentifiers":[738000908,738000911],"seriesAndModality":[],"studyIdentifier":737968140},{"seriesIdentifiers":[738000910,738000912],"seriesAndModality":[],"studyIdentifier":737968141}]},{"subjectId":"425362-245-T-1506","project":"PDMR-425362-245-T","id":737935371,"totalNumberOfStudies":6,"totalNumberOfSeries":11,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738000913,738000916],"seriesAndModality":[],"studyIdentifier":737968142},{"seriesIdentifiers":[738000914],"seriesAndModality":[],"studyIdentifier":737968143},{"seriesIdentifiers":[738000915,738000918],"seriesAndModality":[],"studyIdentifier":737968144},{"seriesIdentifiers":[738000917,738000919],"seriesAndModality":[],"studyIdentifier":737968145},{"seriesIdentifiers":[738000920,738000921],"seriesAndModality":[],"studyIdentifier":737968146},{"seriesIdentifiers":[738000922,738000925],"seriesAndModality":[],"studyIdentifier":737968147}]},{"subjectId":"425362-245-T-1507","project":"PDMR-425362-245-T","id":737935372,"totalNumberOfStudies":4,"totalNumberOfSeries":7,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738000923,738000927],"seriesAndModality":[],"studyIdentifier":737968148},{"seriesIdentifiers":[738000924],"seriesAndModality":[],"studyIdentifier":737968149},{"seriesIdentifiers":[738000926,738000929],"seriesAndModality":[],"studyIdentifier":737968150},{"seriesIdentifiers":[738000928,738000932],"seriesAndModality":[],"studyIdentifier":737968151}]},{"subjectId":"425362-245-T-1508","project":"PDMR-425362-245-T","id":737935373,"totalNumberOfStudies":7,"totalNumberOfSeries":13,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738000930,738000934],"seriesAndModality":[],"studyIdentifier":737968152},{"seriesIdentifiers":[738000931],"seriesAndModality":[],"studyIdentifier":737968153},{"seriesIdentifiers":[738000933,738000935],"seriesAndModality":[],"studyIdentifier":737968154},{"seriesIdentifiers":[738000936,738000938],"seriesAndModality":[],"studyIdentifier":737968155},{"seriesIdentifiers":[738000937,738000942],"seriesAndModality":[],"studyIdentifier":737968156},{"seriesIdentifiers":[738000939,738000941],"seriesAndModality":[],"studyIdentifier":737968157},{"seriesIdentifiers":[738000940,738000943],"seriesAndModality":[],"studyIdentifier":737968158}]},{"subjectId":"425362-245-T-1509","project":"PDMR-425362-245-T","id":737935374,"totalNumberOfStudies":6,"totalNumberOfSeries":11,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738000944,738000946],"seriesAndModality":[],"studyIdentifier":737968159},{"seriesIdentifiers":[738000945,738000949],"seriesAndModality":[],"studyIdentifier":737968160},{"seriesIdentifiers":[738000947],"seriesAndModality":[],"studyIdentifier":737968161},{"seriesIdentifiers":[738000948,738000950],"seriesAndModality":[],"studyIdentifier":737968162},{"seriesIdentifiers":[738000951,738000953],"seriesAndModality":[],"studyIdentifier":737968163},{"seriesIdentifiers":[738000952,738000954],"seriesAndModality":[],"studyIdentifier":737968164}]},{"subjectId":"425362-245-T-1510","project":"PDMR-425362-245-T","id":737935375,"totalNumberOfStudies":7,"totalNumberOfSeries":13,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738000955],"seriesAndModality":[],"studyIdentifier":737968165},{"seriesIdentifiers":[738000956,738000957],"seriesAndModality":[],"studyIdentifier":737968166},{"seriesIdentifiers":[738000958,738000960],"seriesAndModality":[],"studyIdentifier":737968167},{"seriesIdentifiers":[738000959,738000961],"seriesAndModality":[],"studyIdentifier":737968168},{"seriesIdentifiers":[738000962,738000964],"seriesAndModality":[],"studyIdentifier":737968169},{"seriesIdentifiers":[738000963,738000966],"seriesAndModality":[],"studyIdentifier":737968170},{"seriesIdentifiers":[738000965,738000967],"seriesAndModality":[],"studyIdentifier":737968171}]},{"subjectId":"425362-245-T-1511","project":"PDMR-425362-245-T","id":737935376,"totalNumberOfStudies":7,"totalNumberOfSeries":13,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738000968,738000969],"seriesAndModality":[],"studyIdentifier":737968172},{"seriesIdentifiers":[738000970,738000972],"seriesAndModality":[],"studyIdentifier":737968173},{"seriesIdentifiers":[738000971],"seriesAndModality":[],"studyIdentifier":737968174},{"seriesIdentifiers":[738000973,738000975],"seriesAndModality":[],"studyIdentifier":737968175},{"seriesIdentifiers":[738000974,738000977],"seriesAndModality":[],"studyIdentifier":737968176},{"seriesIdentifiers":[738000976,738000981],"seriesAndModality":[],"studyIdentifier":737968177},{"seriesIdentifiers":[738000978,738000980],"seriesAndModality":[],"studyIdentifier":737968178}]},{"subjectId":"425362-245-T-1512","project":"PDMR-425362-245-T","id":737935377,"totalNumberOfStudies":3,"totalNumberOfSeries":5,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738000979,738000986],"seriesAndModality":[],"studyIdentifier":737968179},{"seriesIdentifiers":[738000982],"seriesAndModality":[],"studyIdentifier":737968180},{"seriesIdentifiers":[738000983,738000984],"seriesAndModality":[],"studyIdentifier":737968181}]},{"subjectId":"425362-245-T-1513","project":"PDMR-425362-245-T","id":737935378,"totalNumberOfStudies":4,"totalNumberOfSeries":7,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738000985,738000991],"seriesAndModality":[],"studyIdentifier":737968182},{"seriesIdentifiers":[738000987],"seriesAndModality":[],"studyIdentifier":737968183},{"seriesIdentifiers":[738000988,738000989],"seriesAndModality":[],"studyIdentifier":737968184},{"seriesIdentifiers":[738000990,738000993],"seriesAndModality":[],"studyIdentifier":737968185}]},{"subjectId":"425362-245-T-1514","project":"PDMR-425362-245-T","id":737935379,"totalNumberOfStudies":4,"totalNumberOfSeries":7,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738000992,738000996],"seriesAndModality":[],"studyIdentifier":737968186},{"seriesIdentifiers":[738000994,738000997],"seriesAndModality":[],"studyIdentifier":737968187},{"seriesIdentifiers":[738000995],"seriesAndModality":[],"studyIdentifier":737968188},{"seriesIdentifiers":[738000998,738001001],"seriesAndModality":[],"studyIdentifier":737968189}]},{"subjectId":"425362-245-T-1515","project":"PDMR-425362-245-T","id":737935380,"totalNumberOfStudies":7,"totalNumberOfSeries":13,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738000999,738001003],"seriesAndModality":[],"studyIdentifier":737968190},{"seriesIdentifiers":[738001000],"seriesAndModality":[],"studyIdentifier":737968191},{"seriesIdentifiers":[738001002,738001005],"seriesAndModality":[],"studyIdentifier":737968192},{"seriesIdentifiers":[738001004,738001007],"seriesAndModality":[],"studyIdentifier":737968193},{"seriesIdentifiers":[738001006,738001011],"seriesAndModality":[],"studyIdentifier":737968194},{"seriesIdentifiers":[738001008,738001010],"seriesAndModality":[],"studyIdentifier":737968195},{"seriesIdentifiers":[738001009,738001012],"seriesAndModality":[],"studyIdentifier":737968196}]},{"subjectId":"425362-245-T-1516","project":"PDMR-425362-245-T","id":737935381,"totalNumberOfStudies":7,"totalNumberOfSeries":13,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738001013,738001016],"seriesAndModality":[],"studyIdentifier":737968197},{"seriesIdentifiers":[738001014,738001017],"seriesAndModality":[],"studyIdentifier":737968198},{"seriesIdentifiers":[738001015],"seriesAndModality":[],"studyIdentifier":737968199},{"seriesIdentifiers":[738001018,738001020],"seriesAndModality":[],"studyIdentifier":737968200},{"seriesIdentifiers":[738001019,738001022],"seriesAndModality":[],"studyIdentifier":737968201},{"seriesIdentifiers":[738001021,738001024],"seriesAndModality":[],"studyIdentifier":737968202},{"seriesIdentifiers":[738001023,738001027],"seriesAndModality":[],"studyIdentifier":737968203}]},{"subjectId":"425362-245-T-1517","project":"PDMR-425362-245-T","id":737935382,"totalNumberOfStudies":8,"totalNumberOfSeries":15,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738001025,738001028],"seriesAndModality":[],"studyIdentifier":737968204},{"seriesIdentifiers":[738001026],"seriesAndModality":[],"studyIdentifier":737968205},{"seriesIdentifiers":[738001029,738001031],"seriesAndModality":[],"studyIdentifier":737968206},{"seriesIdentifiers":[738001030,738001033],"seriesAndModality":[],"studyIdentifier":737968207},{"seriesIdentifiers":[738001032,738001035],"seriesAndModality":[],"studyIdentifier":737968208},{"seriesIdentifiers":[738001034,738001036],"seriesAndModality":[],"studyIdentifier":737968209},{"seriesIdentifiers":[738001037,738001039],"seriesAndModality":[],"studyIdentifier":737968210},{"seriesIdentifiers":[738001038,738001043],"seriesAndModality":[],"studyIdentifier":737968211}]},{"subjectId":"425362-245-T-1518","project":"PDMR-425362-245-T","id":737935383,"totalNumberOfStudies":7,"totalNumberOfSeries":13,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738001040,738001044],"seriesAndModality":[],"studyIdentifier":737968212},{"seriesIdentifiers":[738001041],"seriesAndModality":[],"studyIdentifier":737968213},{"seriesIdentifiers":[738001042,738001046],"seriesAndModality":[],"studyIdentifier":737968214},{"seriesIdentifiers":[738001045,738001048],"seriesAndModality":[],"studyIdentifier":737968215},{"seriesIdentifiers":[738001047,738001050],"seriesAndModality":[],"studyIdentifier":737968216},{"seriesIdentifiers":[738001049,738001051],"seriesAndModality":[],"studyIdentifier":737968217},{"seriesIdentifiers":[738001052,738001054],"seriesAndModality":[],"studyIdentifier":737968218}]},{"subjectId":"425362-245-T-1519","project":"PDMR-425362-245-T","id":737935384,"totalNumberOfStudies":9,"totalNumberOfSeries":17,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738001053,738001057],"seriesAndModality":[],"studyIdentifier":737968219},{"seriesIdentifiers":[738001055,738001059],"seriesAndModality":[],"studyIdentifier":737968220},{"seriesIdentifiers":[738001056],"seriesAndModality":[],"studyIdentifier":737968221},{"seriesIdentifiers":[738001058,738001061],"seriesAndModality":[],"studyIdentifier":737968222},{"seriesIdentifiers":[738001060,738001065],"seriesAndModality":[],"studyIdentifier":737968223},{"seriesIdentifiers":[738001062,738001064],"seriesAndModality":[],"studyIdentifier":737968224},{"seriesIdentifiers":[738001063,738001066],"seriesAndModality":[],"studyIdentifier":737968225},{"seriesIdentifiers":[738001067,738001071],"seriesAndModality":[],"studyIdentifier":737968226},{"seriesIdentifiers":[738001068,738001072],"seriesAndModality":[],"studyIdentifier":737968227}]},{"subjectId":"425362-245-T-1520","project":"PDMR-425362-245-T","id":737935385,"totalNumberOfStudies":5,"totalNumberOfSeries":9,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738001069,738001074],"seriesAndModality":[],"studyIdentifier":737968228},{"seriesIdentifiers":[738001070],"seriesAndModality":[],"studyIdentifier":737968229},{"seriesIdentifiers":[738001073,738001076],"seriesAndModality":[],"studyIdentifier":737968230},{"seriesIdentifiers":[738001075,738001079],"seriesAndModality":[],"studyIdentifier":737968231},{"seriesIdentifiers":[738001077,738001080],"seriesAndModality":[],"studyIdentifier":737968232}]},{"subjectId":"425362-245-T-1521","project":"PDMR-425362-245-T","id":737935386,"totalNumberOfStudies":8,"totalNumberOfSeries":15,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738001078,738001083],"seriesAndModality":[],"studyIdentifier":737968233},{"seriesIdentifiers":[738001081],"seriesAndModality":[],"studyIdentifier":737968234},{"seriesIdentifiers":[738001082,738001085],"seriesAndModality":[],"studyIdentifier":737968235},{"seriesIdentifiers":[738001084,738001087],"seriesAndModality":[],"studyIdentifier":737968236},{"seriesIdentifiers":[738001086,738001089],"seriesAndModality":[],"studyIdentifier":737968237},{"seriesIdentifiers":[738001088,738001092],"seriesAndModality":[],"studyIdentifier":737968238},{"seriesIdentifiers":[738001090,738001093],"seriesAndModality":[],"studyIdentifier":737968239},{"seriesIdentifiers":[738001091,738001095],"seriesAndModality":[],"studyIdentifier":737968240}]},{"subjectId":"425362-245-T-1522","project":"PDMR-425362-245-T","id":737935387,"totalNumberOfStudies":4,"totalNumberOfSeries":7,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738001094,738001098],"seriesAndModality":[],"studyIdentifier":737968241},{"seriesIdentifiers":[738001096],"seriesAndModality":[],"studyIdentifier":737968242},{"seriesIdentifiers":[738001097,738001100],"seriesAndModality":[],"studyIdentifier":737968243},{"seriesIdentifiers":[738001099,738001102],"seriesAndModality":[],"studyIdentifier":737968244}]},{"subjectId":"425362-245-T-1523","project":"PDMR-425362-245-T","id":737935388,"totalNumberOfStudies":5,"totalNumberOfSeries":9,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738001101,738001105],"seriesAndModality":[],"studyIdentifier":737968245},{"seriesIdentifiers":[738001103],"seriesAndModality":[],"studyIdentifier":737968246},{"seriesIdentifiers":[738001104,738001107],"seriesAndModality":[],"studyIdentifier":737968247},{"seriesIdentifiers":[738001106,738001109],"seriesAndModality":[],"studyIdentifier":737968248},{"seriesIdentifiers":[738001108,738001112],"seriesAndModality":[],"studyIdentifier":737968249}]},{"subjectId":"425362-245-T-1524","project":"PDMR-425362-245-T","id":737935389,"totalNumberOfStudies":3,"totalNumberOfSeries":5,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[738001110,738001113],"seriesAndModality":[],"studyIdentifier":737968250},{"seriesIdentifiers":[738001111],"seriesAndModality":[],"studyIdentifier":737968251},{"seriesIdentifiers":[738001114,738001115],"seriesAndModality":[],"studyIdentifier":737968252}]},{"subjectId":"521955-158-R4-2160","project":"PDMR-521955-158-R4","id":942342194,"totalNumberOfStudies":8,"totalNumberOfSeries":15,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[942442571,942442722],"seriesAndModality":[],"studyIdentifier":942375280},{"seriesIdentifiers":[942442585,942442676],"seriesAndModality":[],"studyIdentifier":942375294},{"seriesIdentifiers":[942442604,942442822],"seriesAndModality":[],"studyIdentifier":942375313},{"seriesIdentifiers":[942442617,942442707],"seriesAndModality":[],"studyIdentifier":942375325},{"seriesIdentifiers":[942442637,942442824],"seriesAndModality":[],"studyIdentifier":942375342},{"seriesIdentifiers":[942442654,942442766],"seriesAndModality":[],"studyIdentifier":942375357},{"seriesIdentifiers":[942442691,942442724],"seriesAndModality":[],"studyIdentifier":942375390},{"seriesIdentifiers":[942442814],"seriesAndModality":[],"studyIdentifier":942375415}]},{"subjectId":"521955-158-R4-2161","project":"PDMR-521955-158-R4","id":942342197,"totalNumberOfStudies":8,"totalNumberOfSeries":15,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[942442575,942442816],"seriesAndModality":[],"studyIdentifier":942375284},{"seriesIdentifiers":[942442592,942442740],"seriesAndModality":[],"studyIdentifier":942375301},{"seriesIdentifiers":[942442623,942442747],"seriesAndModality":[],"studyIdentifier":942375331},{"seriesIdentifiers":[942442625,942442829],"seriesAndModality":[],"studyIdentifier":942375333},{"seriesIdentifiers":[942442663,942442767],"seriesAndModality":[],"studyIdentifier":942375366},{"seriesIdentifiers":[942442677,942442805],"seriesAndModality":[],"studyIdentifier":942375377},{"seriesIdentifiers":[942442681,942442731],"seriesAndModality":[],"studyIdentifier":942375381},{"seriesIdentifiers":[942442801],"seriesAndModality":[],"studyIdentifier":942375414}]},{"subjectId":"521955-158-R4-2162","project":"PDMR-Texture-Analysis","id":1000412680,"totalNumberOfStudies":5,"totalNumberOfSeries":9,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[1000501150,1000501867],"seriesAndModality":[],"studyIdentifier":1000446952},{"seriesIdentifiers":[1000501567,1000502219],"seriesAndModality":[],"studyIdentifier":1000447348},{"seriesIdentifiers":[1000501623,1000501982],"seriesAndModality":[],"studyIdentifier":1000447396},{"seriesIdentifiers":[1000501748,1000501952],"seriesAndModality":[],"studyIdentifier":1000447481},{"seriesIdentifiers":[1000502311],"seriesAndModality":[],"studyIdentifier":1000447628}]},{"subjectId":"521955-158-R4-2162","project":"PDMR-521955-158-R4","id":942342203,"totalNumberOfStudies":6,"totalNumberOfSeries":11,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[942442584,942442796],"seriesAndModality":[],"studyIdentifier":942375293},{"seriesIdentifiers":[942442586,942442717],"seriesAndModality":[],"studyIdentifier":942375295},{"seriesIdentifiers":[942442589,942442613],"seriesAndModality":[],"studyIdentifier":942375298},{"seriesIdentifiers":[942442590,942442786],"seriesAndModality":[],"studyIdentifier":942375299},{"seriesIdentifiers":[942442596,942442812],"seriesAndModality":[],"studyIdentifier":942375305},{"seriesIdentifiers":[942442800],"seriesAndModality":[],"studyIdentifier":942375413}]},{"subjectId":"521955-158-R4-2163","project":"PDMR-521955-158-R4","id":942342206,"totalNumberOfStudies":7,"totalNumberOfSeries":13,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[942442597,942442818],"seriesAndModality":[],"studyIdentifier":942375306},{"seriesIdentifiers":[942442598,942442714],"seriesAndModality":[],"studyIdentifier":942375307},{"seriesIdentifiers":[942442607,942442775],"seriesAndModality":[],"studyIdentifier":942375316},{"seriesIdentifiers":[942442641,942442756],"seriesAndModality":[],"studyIdentifier":942375346},{"seriesIdentifiers":[942442684,942442820],"seriesAndModality":[],"studyIdentifier":942375384},{"seriesIdentifiers":[942442703,942442804],"seriesAndModality":[],"studyIdentifier":942375397},{"seriesIdentifiers":[942442774],"seriesAndModality":[],"studyIdentifier":942375407}]},{"subjectId":"521955-158-R4-2163","project":"PDMR-Texture-Analysis","id":1000412795,"totalNumberOfStudies":5,"totalNumberOfSeries":9,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[1000501359,1000502285],"seriesAndModality":[],"studyIdentifier":1000447153},{"seriesIdentifiers":[1000501436,1000501679],"seriesAndModality":[],"studyIdentifier":1000447229},{"seriesIdentifiers":[1000501485,1000502301],"seriesAndModality":[],"studyIdentifier":1000447273},{"seriesIdentifiers":[1000501560,1000502055],"seriesAndModality":[],"studyIdentifier":1000447342},{"seriesIdentifiers":[1000502194],"seriesAndModality":[],"studyIdentifier":1000447592}]},{"subjectId":"521955-158-R4-2164","project":"PDMR-521955-158-R4","id":942342189,"totalNumberOfStudies":7,"totalNumberOfSeries":13,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[942442566],"seriesAndModality":[],"studyIdentifier":942375275},{"seriesIdentifiers":[942442600,942442635],"seriesAndModality":[],"studyIdentifier":942375309},{"seriesIdentifiers":[942442609,942442773],"seriesAndModality":[],"studyIdentifier":942375318},{"seriesIdentifiers":[942442629,942442713],"seriesAndModality":[],"studyIdentifier":942375336},{"seriesIdentifiers":[942442642,942442760],"seriesAndModality":[],"studyIdentifier":942375347},{"seriesIdentifiers":[942442644,942442712],"seriesAndModality":[],"studyIdentifier":942375349},{"seriesIdentifiers":[942442692,942442729],"seriesAndModality":[],"studyIdentifier":942375391}]},{"subjectId":"521955-158-R4-2165","project":"PDMR-521955-158-R4","id":942342208,"totalNumberOfStudies":7,"totalNumberOfSeries":13,"hit":"<em>seriesDesc</em>: PDM <strong>Mouse</strong> Overview","studyIdentifiers":[{"seriesIdentifiers":[942442610,942442798],"seriesAndModality":[],"studyIdentifier":942375319},{"seriesIdentifiers":[942442612,942442770],"seriesAndModality":[],"studyIdentifier":942375321},{"seriesIdentifiers":[94244262 |
Updated SeriesThis 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=08/08/2023" |
The API returns the updated series. Code Block |
---|
| [{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.231066926328783978070723153778823810093","StudyInstanceUID": | . 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://public.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://public.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"":""56000972057571133036084570908178306645","Modality":"CT","ProtocolName":"6.1 ABD W\/O DR 30%","SeriesDate":"2009-06-30 00:00:00.0","SeriesDescription":"Cor 2x2","BodyPartExamined":"KIDNEY","SeriesNumber":601,"Collection":"CPTAC-CCRCC","PatientID":"C3L-01960","Manufacturer":"GE MEDICAL SYSTEMS","ManufacturerModelName":"LightSpeed VCT","ImageCount":157},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.6834.5010.100049789635984645130991826991338463752676705634450982320712559523156"",""thirdPartyAnanlysis"":null},{""collection"":""4D-Lung"",""seriesInstanceUID"StudyInstanceUID":""1.3.6.1.4.1.14519.5.2.1.6834.5010.100055011459662871005613719886"",""thirdPartyAnanlysis"":null},{""collection"":""4D-Lung"",""seriesInstanceUID"":""56000972057571133036084570908178306645","Modality":"CT","ProtocolName":"6.1 ABD W\/O DR 30%","SeriesDate":"2009-06-30 00:00:00.0","SeriesDescription":"Sag 2x2","BodyPartExamined":"KIDNEY","SeriesNumber":602,"Collection":"CPTAC-CCRCC","PatientID":"C3L-01960","Manufacturer":"GE MEDICAL SYSTEMS","ManufacturerModelName":"LightSpeed VCT","ImageCount":194},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.6834.5010.100089621274100103247029607723"",""thirdPartyAnanlysis"":null},{""collection"":""4D-Lung"",""seriesInstanceUID"279821837986892082518668410584927449356","StudyInstanceUID":""1.3.6.1.4.1.14519.5.2.1.6834.5010.100137773791956790807544371448"86824010805243638814214821163735641447","Modality":"CT","SeriesDate":"2015-02-19 00:00:00.0","SeriesDescription":"coronal","BodyPartExamined":"ABDOMEN","SeriesNumber"thirdPartyAnanlysis:4,"Collection":null},{""collection""CPTAC-UCEC","PatientID":"C3L-02744","Manufacturer":""4D-Lung"",""seriesInstanceUID"":""SIEMENS","ManufacturerModelName":"SOMATOM Definition AS+","SoftwareVersions":"syngo CT 2012B","ImageCount":105},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.6834.5010.10031787057203575948731985155674919488492708134547701339668104450233"",""thirdPartyAnanlysis"StudyInstanceUID":null},{""collection"":""4D-Lung"",""seriesInstanceUID"":""1.3.6.1.4.1.14519.5.2.1.6834.5010.100356687286872672203671297553"86824010805243638814214821163735641447","Modality"thirdPartyAnanlysis:"CT":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=88.8.133841977708353813381069288155921822331&list=88.8.326983478845196402838719404831299211067&name=LIST_NAME&description=mydescription&url=LIST_URL" |
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=9999.266036705757333804188405684898037929022 |
The API sends back triples of all DICOM element, name, data in the file. Code Block |
---|
| [
{"element":"(0002,0001)","name":"File Meta Information Version","data":"00\\01"},
{"element":"(0002,0002)","name":"Media Storage SOP Class UID","data":"1.2.840.10008.5.1.4.1.1.2"}
................................... |
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="SeriesDate":"2015-02-19 00:00:00.0","SeriesDescription":"Abd Pelvis 3.0 B20f","BodyPartExamined":"ABDOMEN","SeriesNumber":2,"Collection":"CPTAC-UCEC","PatientID":"C3L-02744","Manufacturer":"SIEMENS","ManufacturerModelName":"SOMATOM Definition AS+","SoftwareVersions":"syngo CT 2012B","ImageCount":230},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.320141851691120016143208833306786278153","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.86824010805243638814214821163735641447","Modality":"CT","SeriesDate":"2015-02-19 00:00:00.0","SeriesDescription":"Lung 3.0 B60f","BodyPartExamined":"ABDOMEN","SeriesNumber":3,"Collection":"CPTAC-UCEC","PatientID":"C3L-02744","Manufacturer":"SIEMENS","ManufacturerModelName":"SOMATOM Definition AS+","SoftwareVersions":"syngo CT 2012B","ImageCount":65},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.335450077231104425936065403096497651093","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.86824010805243638814214821163735641447","Modality":"CT","SeriesDate":"2015-02-19 00:00:00.0","SeriesDescription":"Topogram 0.6 T20s","BodyPartExamined":"ABDOMEN","SeriesNumber":1,"Collection":"CPTAC-UCEC","PatientID":"C3L-02744","Manufacturer":"SIEMENS","ManufacturerModelName":"SOMATOM Definition AS+","SoftwareVersions":"syngo CT 2012B","ImageCount":2},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7085.2626.122609176912260142101104222441","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":"CAP 3.0 I40f 3","BodyPartExamined":"CHEST","SeriesNumber":2,"Collection":"CPTAC-UCEC","PatientID":"C3N-02436","Manufacturer":"SIEMENS","ManufacturerModelName":"SOMATOM Definition Flash","SoftwareVersions":"syngo CT 2012B","ImageCount":223},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7085.2626.175983909800082543172686238818","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":"LUNG","BodyPartExamined":"CHEST","SeriesNumber":3,"Collection":"CPTAC-UCEC","PatientID":"C3N-02436","Manufacturer":"SIEMENS","ManufacturerModelName":"SOMATOM Definition Flash","SoftwareVersions":"syngo CT 2012B","ImageCount":97},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7085.2626.197130263049983111653952595086","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":"SAGITTAL","BodyPartExamined":"CHEST","SeriesNumber":5,"Collection":"CPTAC-UCEC","PatientID":"C3N-02436","Manufacturer":"SIEMENS","ManufacturerModelName":"SOMATOM Definition Flash","SoftwareVersions":"syngo CT 2012B","ImageCount":182},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7085.2626.305388984280460946361929178734","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":"DELAY 3.0 I40f 3","BodyPartExamined":"CHEST","SeriesNumber":6,"Collection":"CPTAC-UCEC","PatientID":"C3N-02436","Manufacturer":"SIEMENS","ManufacturerModelName":"SOMATOM Definition Flash","SoftwareVersions":"syngo CT 2012B","ImageCount":52},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7085.2626.207255344192647296488076446666","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":"CORONALS","BodyPartExamined":"CHEST","SeriesNumber":4,"Collection":"CPTAC-UCEC","PatientID":"C3N-02436","Manufacturer":"SIEMENS","ManufacturerModelName":"SOMATOM Definition Flash","SoftwareVersions":"syngo CT 2012B","ImageCount":146},{"SeriesInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7085.2626.191696586241637374878426886752","StudyInstanceUID":"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 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=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=
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.5.2.1.211008142524560003951886355912626063954","StudyInstanceUID":"1.3.6.1.4.1.9328.50.3.336 |
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=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.5.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.190738758608436907826741043480210378147","StudyInstanceUID":"1.3.6.1.4.1.9328.50.3.336 |
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/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.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.505.42.563784
1.3.6.1.4.1.9328.50.4.568673
1.255655949940392130215771845301489961005","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.4.568676
1.3.6.1.4.1.9328.50.4.568678
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.5.502.4.569267
1.62348259564270653822457602313155874057","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.569270
1.3.6.1.4.1.9328.50.4.569273
1.3.6.1.4.1.9328.50.4.569823
1.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.571319
1.3.6.1.4.1.9328.50.4.571323
1.183148327278950087954671503508917919131","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.571803
1.3.109145130435628734336383566463376219652","Modality":"CT","ProtocolName":"6.1.4.1.9328.50.4.571808
1.3.6.1.4.1.9328.50.4.572414
1. 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.932814519.505.42.572418
1.3.6.1.4.1.9328.50.4.572422
1.75656900515008159651347291284155973982","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.9328.50.4.572425
.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.572983
1.3.6.1.4.1.9328.50.4.573038
1.245356199503483432341179415858473733042","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.573635
1.3.6.1.4.1.9328.50.4.573639
1.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.574149
1.3.6.1.4.1.9328.50.4.574153
1.21609109943642645531382867839700789180","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.578325
1.3.6.1.4.1.9328.50.4.578328
1.3.6.1.4.1.9328.50.4.578331
1.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.4.578901
1.3.6.1.4.1.9328.50.4.579479
2.1.137992178380935686474136038434155081787","StudyInstanceUID":"1.3.6.1.4.1.9328.50.4.579482
14519.5.2.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.5.502.4.579494
1.66236310694139582452411837407718775922","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":"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.579490
1.3.6.1.4.1.9328.50.4.580594
1.1.304017195569708291273496905973714460930","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.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.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.590890
1.3.6.1.4.1.9328.50.4.591508
1.207407827182959708074704778666572415754","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.591511
1.3.6.1.4.1.9328.50.4.591513
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.5.502.4.591516
1.54520248656390659705202351279457471623","StudyInstanceUID":"1.3.6.1.4.1.9328.50.4.591522
14519.5.2.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.591975
1.3.6.1.4.1.9328.50.4.592513
1.1.331484779082297900346876082479517524406","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.593093
1.3.6.1.4.1.9328.50.4.593096
1.3.6.1.4.1.9328.50.4.593099
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.593601
1.3.6.1.4.1.9328.50.4.594099
1.867044007602064428393129841040266430","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.594613
1.3.6.1.4.1.9328.50.4.595110
1.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.932814519.505.42.595623
1.3.6.1.4.1.9328.50.4.596197
1.146178905280567177991142318697613352451","StudyInstanceUID":"1.3.6.1.4.1.9328.50.4.596737
.14519.5.2.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.14519.93285.502.4.600540
1.24521037205708921168084397885539628772","StudyInstanceUID":"1.3.6.1.4.1.14519.93285.2.50.4.600543
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.601079
1.266615994591450090046447803928312219131","StudyInstanceUID":"1.3.6.1.4.1.9328.50.4.601082
.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.932814519.5.502.4.601085
1.39259777678200137059835826187434558013","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.601643
1.3.6.1.4.1.9328.50.4.604326
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.932814519.50.4.604330
1.3.6.1.4.1.9328.50.4.604333
5.2.1.161982724082331319465572169155208225153","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.604801
1.3.6.1.4.1.9328.50.4.604806
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.932814519.505.42.607091
1.3.6.1.4.1.9328.50.4.607094
1.1.238208027292970722183126381008808411202","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.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.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.505.42.610803
1.3.6.1.4.1.9328.50.4.611364
1.104676703467748132759270722686474378353","StudyInstanceUID":"1.3.6.1.4.1.9328.50.4.611919
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":"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.14519.5.93282.50.4.612039
1.276160523486377582247467372005084977764","StudyInstanceUID":"1.3.6.1.4.1.9328.50.4.612593
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.612598
1.306438034061104828163299494729950182902","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.613155
1.3.6.1.4.1.9328.50.4.613159
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.613786
1.249747234475942834682299784244177066122","StudyInstanceUID":"1.3.6.1.4.1.932814519.505.42.613791
1.3.6.1.4.1.9328.50.4.613794
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.614396
1.163657679348320741926204299059702564472","StudyInstanceUID":"1.3.6.1.4.1.932814519.5.502.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.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.14519.5.2.1.89337107620575759211601953173555846864","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.250955243295773832626617549482
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.7695.1700.360389360742427667526070655843
204734451354467159013076861301815243913","StudyInstanceUID":"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
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.131126392922209124942161386151
252411455443025962816432148953860325447","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.933316195746120155903339740103
.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.274616783627161175251743615553
105584634054335527606285039437435359592","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.733313000644315272006192181431
.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.220092773361369396087067751186
83482909094763399077117589653879292435","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.245270018412514241929134140425
.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.229054711046553504545787083659
168021505333397181219936037252559107030","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.179162285704690412763684330250
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.234808560418629209017784958053
62142467323605237784770516904000895215","StudyInstanceUID":"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
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.154110825244369885171851551255
185418111484555163150647086155869219756","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.284567351304426376226790714264
.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.324328467511449053797650611970
68757738277706847815055494065671508981","StudyInstanceUID":"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.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.210538707954985296677398591978
130260134778970397197450676012106042668","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.195983148423034180376334647727
.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.244863941836141483641489109194
52309835344870054201882678149260479935","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.180831804100647525080922590445
.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.134282805412721876700374897836
100731759010416801525756814661582905453","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.7695.1700.226038001772760333157260976449
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.248017107754573666956949261473
37671622521464066812631978471928306007","StudyInstanceUID":"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
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.276008182492477899149189119200
253168115551446290926256440815409084370","StudyInstanceUID":"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.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.509490993107578827767081500491
224409518854330380839516384479543090458","StudyInstanceUID":"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 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=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.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,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.50446370192855283669200346817959448281","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.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.5168.1900.154535988064062152660648619556,MRI LT LEG +C,2003-12-12,257013319324343199851187045765222186475","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 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 |
---|
| [
{
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.171418726181894059770838067663080088554","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.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.14519.59625.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":1
}80},{"SeriesInstanceUID":"1.3.6 |
|