...
The NBIA Advanced REST APIs, described in the NBIA Advanced REST API Guide, provide advanced features geared towards developers seeking to integrate searching and downloading TCIA data into their own web and desktop applications.
Run APIs Live on the Cloud
You can find examples for using the NBIA APIs with Python in these Jupyter Notebooks. They are set up so that you can run them in Google Colab without the need to configure your own development environment.
NBIA Search REST API URL and Format
A call includes a base URL followed by the API and query parameters, in that order. The base URL to access public data is https://services.cancerimagingarchive.net/nbia-api/services/v1.
For example, in the following URL:
Note | ||
---|---|---|
| ||
To access National Lung Screening Trial (NLST) data, use the following base URL instead: https://nlst.cancerimagingarchive.net/nbia-api/services/ |
For example, in the following URL:
https:https://services.cancerimagingarchive.net/nbia-api/services/v1/getSeries?Collection=RIDER%20Pilot&PatientID=1.3.6.1.4.1.9328.50.1.0001&StudyInstanceUID=1.3.6.1.4.1.9328.50.1.2&format=csv
- The base URL is https://services.cancerimagingarchive.net/nbia-api/services/v1/.
- The API endpoint is
getSeries
. - The four query parameters are provided as follows:
Collection=RIDER Pilot&PatientID=1.3.6.1.4.1.9328.50.1.0001&StudyInstanceUID=1.3.6.1.4.1.9328.50.1.2&format=csv
- Data can be obtained in the following formats: CSV, HTML, XML, and JSON. JSON is the default return format if no format parameter is specified
Note |
---|
|
...
Excerpt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Image Download APIsUse the APIs in the following table to download images from TCIA.
Image Metadata APIsUse the APIs in the following table to explore the metadata of objects in the TCIA database. Queries Queries return a file in one of these data formats: CSV, HTML, XML, and JSON. JSON is the default return format if no format parameter is specified.
|
Return Values
This section lists and explains the return values of the APIs included in both tables above.
|
Return Values
This section lists and explains the return values of the APIs included in both tables above.
Note |
---|
If the value for an attribute is not populated in the specified collection, it will not appear in the returned values. |
Table of Content Zone | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
getBodyPartValues
| ||||||||
Table of Content Zone | ||||||||
| ||||||||
getBodyPartValues
| ||||||||
Attribute | DICOM Tag | Description | ||||||
BodyPartExamined | 0018, 0015 | Standard DICOM definition |
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getCollectionValues |
getContentsByName
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getContentsByName?name=TCIA_TCGA-PRAD_08-09-2016-v3 |
Attribute | DICOM Tag | Description |
---|---|---|
SeriesInstanceUID | 0020, 000E | Has been de-identified as part of submission process |
StudyInstanceUID | 0020, 000D | Has been de-identified as part of submission process. |
Modality | 0008, 0060 | Standard DICOM definition |
ProtocolName | 0018, 1030 | Standard DICOM definition. Has been inspected and cleaned of any PHI. |
SeriesDate | 0008, 0021 | Standard DICOM definition |
SeriesDescription | 0008, 103E | Standard DICOM definition. Has been inspected and cleaned of any PHI. |
BodyPartExamined | 0018, 0015 | Standard DICOM definition | SeriesNumber
Code Block |
---|
Collection
PatientID
Manufacturer
ManufacturerModelName
SoftwareVersions
ImageCount
getImage
The license file, which includes the data usage agreement, is included in the returned ZIP file.
| ||
"[
{ },
{
BodyPartExamined: ""ABD PEL""
},
{
BodyPartExamined: ""ABD PELV""
},
{
BodyPartExamined: ""ABDOMEN""
},
{
BodyPartExamined: ""ABDOMENPELVIS""
}," |
getCollectionValues
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getCollectionValues |
Attribute | DICOM Tag | Description |
---|---|---|
Collection | N/A | A label used to name a set of images collected for a specific trial or other reason. Assigned during the process of curating the data. |
Code Block | ||
---|---|---|
| ||
[
{
Collection: "4D-Lung"
},
{
Collection: "AAPM-RT-MAC"
},
{
Collection: "ACRIN-FLT-Breast"
},
{
Collection: "ACRIN-FMISO-Brain"
},
{
Collection: "ACRIN-NSCLC-FDG-PET"
}, |
getContentsByName
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getContentsByName?name=TCIA_TCGA-PRAD_08-09-2016-v3 |
Attribute | DICOM Tag | Description |
---|---|---|
SeriesInstanceUID | 0020, 000E | Has been de-identified as part of submission process |
StudyInstanceUID | 0020, 000D | Has been de-identified as part of submission process. |
Modality | 0008, 0060 | Standard DICOM definition |
ProtocolName | 0018, 1030 | Standard DICOM definition. Has been inspected and cleaned of any PHI. |
SeriesDate | 0008, 0021 | Standard DICOM definition |
SeriesDescription | 0008, 103E | Standard DICOM definition. Has been inspected and cleaned of any PHI. |
BodyPartExamined | 0018, 0015 | Standard DICOM definition |
SeriesNumber | 0020, 0011 | Standard DICOM definition |
AnnotationsFlag | N/A | Indicates if there are annotations for a collection |
Collection | N/A | A label used to name a set of images collected for a specific trial or other reason. Assigned during the process of curating the data. |
PatientID | 0010, 0020 | Has been de-identified as part of submission process. |
Manufacturer | 0008, 0070 | Standard DICOM definition |
ManufacturerModelName | 0008, 1090 | Standard DICOM definition |
SoftwareVersions | 0018, 1020 | Standard DICOM definition |
ImageCount | N/A | Number of images in the specified series |
DateReleased | N/A | The date that TCIA published the series |
getImage
The license file, which includes the data usage agreement, is included in the returned ZIP file.
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getImage?SeriesInstanceUID=1.3.6.1.4.1.9328.50.1.216116555221814778114703363464001196508 |
Attribute | DICOM Tag | Description |
---|---|---|
N/A | N/A | Set of images in a ZIP file |
getImageWithMD5Hash
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getImageWithMD5Hash?SeriesInstanceUID=1.3.6.1.4.1.14519.5.2.1.6919.4624.313514201353787659031503464798 |
Attribute | DICOM Tag | Description |
---|---|---|
N/A | N/A | Set of images in a ZIP file |
getManufacturerValues
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getManufacturerValues |
Attribute | DICOM Tag | Description |
---|---|---|
Manufacturer | 0008, 0070 | Standard DICOM definition |
getModalityValues
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getModalityValues |
Attribute | DICOM Tag | Description |
---|---|---|
Modality | 0008, 0060 | Standard DICOM definition |
NewPatientsInCollection
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getImage?SeriesInstanceUID=1.3.6.1.4.1.9328.50.1.216116555221814778114703363464001196508NewPatientsInCollection?Collection=CBIS-DDSM&Date=2010/08/16 |
Attribute | DICOM Tag | Description | ||||
---|---|---|---|---|---|---|
PatientID | 0010, 0020 | Has been de-identified as part of submission process. | ||||
PatientName | 0010, 0010 | Has been de-identified as part of submission process. | ||||
PatientBirthDate | 0010,0030 | Has been de-identified as part of submission process. | ||||
PatientSex | 0010,0040 | Standard DICOM definition | ||||
EthnicGroup | 0010,2160 | Standard DICOM definition | ||||
Collection | Attribute | DICOM Tag | DescriptionN/A | N/A | Set of images in a ZIP file |
getImageWithMD5Hash
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getImageWithMD5Hash?SeriesInstanceUID=1.3.6.1.4.1.14519.5.2.1.6919.4624.313514201353787659031503464798 |
Attribute
DICOM Tag
Description
A label used to name a set of images collected for a specific trial or other reason. Assigned during the process of curating the data. | ||
Phantom | 0010, 0200 | Indicates whether or not the subject is a quality control phantom. |
SpeciesCode | 0010,2202 | The taxonomic rank value (e.g., genus, subgenus, species or subspecies) of the Patient. |
SpeciesDescription | 0010,2201 | The taxonomic rank value (e.g., genus, subgenus, species or subspecies) of the Patient. |
NewStudiesInPatientCollection
getManufacturerValuesCode Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getManufacturerValues/NewStudiesInPatientCollection?Collection=CBIS-DDSM&Date=2010/08/16 |
Attribute | DICOM Tag | Description |
---|---|---|
StudyInstanceUID | 0020, 000D | Has been de-identified as part of submission process. |
StudyDate | 0008, 0020 | Has been de-identified as part of submission process. Longitudinal information is preserved. |
StudyDescriptionManufacturer | 0008, 00701030 | Standard DICOM definition |
getModalityValues
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getModalityValues |
. Has been inspected and cleaned of any PHI. | ||
AdmittingDiagnosesDescription | 0008, 1080 | Standard DICOM definition. Has been inspected and cleaned of any PHI. |
StudyID | 0020, 0010 | Has been de-identified as part of submission process. |
PatientAge | 0010, 1010 | |
Attribute | DICOM Tag | Description |
---|---|---|
Modality | 0008, 0060 | Standard DICOM definition |
PatientID |
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/NewPatientsInCollection?Collection=CBIS-DDSM&Date=2010/08/16 |
0010, 0020 | Has been de-identified as part of submission process. | ||
PatientName | 0010, 0010 | ||
Attribute | DICOM Tag | Description | |
---|---|---|---|
PatientID | 0010, 0020 | Has been de-identified as part of submission process. | |
PatientBirthDate | 0010, | 00100030 | Has been de-identified as part of submission process. |
PatientSex | 0010, 0040 | Standard DICOM definition | |
EthnicGroup | 0010, 2160 | Standard DICOM definition | |
Collection | N/A | A label used to name a set of images collected for a specific trial or other reason. Assigned during the process of curating the data. | |
Phantom | 0010, 0200 | Indicates whether or not the subject is a quality control phantom. | |
SpeciesCode | 0010,2202 | The taxonomic rank value (e.g., genus, subgenus, species or subspecies) of the Patient. | |
SpeciesDescription | 0010,2201 | The taxonomic rank value (e.g., genus, subgenus, species or subspecies) of the Patient. |
SeriesCount | N/A | Computed number of series |
LongitudinalTemporalEventType | 0012, 0053 | The type of event to which Longitudinal Temporal Offset from Event (0012,0052) is relative. |
LongitudinalTemportalOffsetFromEvent | 0012, 0052 | An offset in days from a particular event of significance. May be fractional. In the context of a clinical trial, this is often the days since enrollment, or the baseline imaging Study. |
getPatient
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/NewStudiesInPatientCollection?Collection=CBIS-DDSM&Date=2010/08/16getPatient |
Attribute | DICOM Tag | Description | |
---|---|---|---|
StudyInstanceUIDPatientId | 0010, 0020 | Has been de-identified as part of submission process. | |
PatientName | 0010, 0010, 000D | Has been de-identified as part of submission process. | |
PatientBirthDate | 00080010, | 00200030 | Has been de-identified as part of submission process. | Longitudinal information is preserved.
StudyID | 0020, 0010 | Has been de-identified as part of submission process. | |
PatientID | 0010, 0020 | Has been de-identified as part of submission process. | |
PatientName | 0010, 0010 | Has been de-identified as part of submission process. | |
Collection | N/A | A label used to name a set of images collected for a specific trial or other reason. Assigned during the process of curating the data. | |
SeriesCount | N/A | Computed number of series |
PatientSex | 0010, 0040 | Standard DICOM definition |
EthnicGroup | 0010, 2160 | Standard DICOM definition |
Collection | N/A | A label used to name a set of images collected for a specific trial or other reason. Assigned during the process of curating the data. |
Phantom | 0010, 0200 | Indicates whether or not the subject is a quality control phantom. |
SpeciesCode | 0010,2202 | The taxonomic rank value (e.g., genus, subgenus, species or subspecies) of the Patient. |
SpeciesDescription | 0010,2201 | The taxonomic rank value (e.g., genus, subgenus, species or subspecies) of the Patient. |
getPatientByCollectionAndModality
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getPatientByCollectionAndModality?Collection=VICTRE&Modality=MG |
Attribute | DICOM Tag | Description |
---|---|---|
PatientId | 0010, 0020 | A list of patient IDs for a specified collection and modality |
getPatientStudy
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getPatientgetPatientStudy?Collection=VICTRE&Modality=MG |
Attribute | DICOM Tag | Description | ||
---|---|---|---|---|
PatientID | 0010, 0020 | Has been de-identified as part of submission process. | ||
PatientName | 0010, 0010 | Has been de-identified as part of submission process. | ||
StudyInstanceUID | 0020, 000D | Has been de-identified as part of submission process. | ||
StudyDate | 0008, 0020 | Has been de-identified as part of submission process. Longitudinal information is preserved. | ||
StudyDescription | 0008, 1030 | Standard DICOM definition. Has been inspected and cleaned of any PHI. | ||
AdmittingDiagnosesDescription | 0008, 1080 | Standard DICOM definition. Has been inspected and cleaned of any PHI. | ||
StudyID | 0020, 0010 | PatientBirthDate | 0010, 0030 | Has been de-identified as part of submission process. |
PatientSexPatientAge | 0010, 00401010 | Standard DICOM definition | ||
EthnicGroupPatientID | 0010, 2160 | Standard DICOM definition | ||
Collection | N/A | A label used to name a set of images collected for a specific trial or other reason. Assigned during the process of curating the data. | ||
Phantom | 0010, 0200 | Indicates whether or not the subject is a quality control phantom. | ||
SpeciesCode | 0010,2202 | The taxonomic rank value (e.g., genus, subgenus, species or subspecies) of the Patient. | ||
SpeciesDescription | 0010,2201 | The taxonomic rank value (e.g., genus, subgenus, species or subspecies) of the Patient. |
getPatientByCollectionAndModality
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getPatientByCollectionAndModality?Collection=VICTRE&Modality=MG |
0020 | Has been de-identified as part of submission process. | |
PatientName | 0010, 0010 | Has been de-identified as part of submission process. |
PatientBirthDate | 0010, 0030 | Has been de-identified (emptied) as part of submission process. |
PatientSex | 0010, 0040 | Standard DICOM definition |
EthnicGroup | 0010, 2160 | Standard DICOM definition |
Collection | N/A | A label used to name a set of images collected for a specific trial or other reason. Assigned during the process of curating the data. |
SeriesCount | N/A | Computed number of series |
LongitudinalTemporalEventType | 0012, 0053 | The type of event to which Longitudinal Temporal Offset from Event (0012,0052) is relative. |
LongitudinalTemporalOffsetFromEvent | 0012, 0052 | An offset in days from a particular event of significance. May be fractional. In the context of a clinical trial, this is often the days since enrollment, or the baseline imaging Study. |
getSeries
getPatientStudyCode Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getPatientStudygetSeries?Collection=VICTRE&Modality=MG |
Attribute | DICOM Tag | Description | ||
---|---|---|---|---|
StudyInstanceUIDSeriesInstanceUID | 0020, 000D000E | Has been de-identified as part of submission process. | ||
StudyDateStudyInstanceUID | 00080020, 0020000D | Has been de-identified as part of submission process. Longitudinal information is preserved. | ||
Modality | 0008, 0060 | Standard DICOM definition | ||
ProtocolName | 0018, 1030 | Standard DICOM definition. Has been inspected and cleaned of any PHI. | ||
SeriesDate | 0008, 0021 | Standard DICOM definition | ||
SeriesDescription | 0008, 103E | StudyDescription | 0008, 1030 | Standard DICOM definition. Has been inspected and cleaned of any PHI. |
AdmittingDiagnosesDescription | 0008, 1080 | Standard DICOM definition. Has been inspected and cleaned of any PHI. | ||
BodyPartExamined | 0018, 0015 | Entered on a per-collection basis using relevant SNOMED terms | ||
SeriesNumber | 0020, 0011 | Standard DICOM definition | ||
AnnotationsFlag | N/A | Indicates if there are annotations for a collection | ||
Collection | N/A | A label used to name a set of images collected for a specific trial or other reason. Assigned during the process of curating the data. | ||
PatientID | 0010, 0020 | StudyID | 0020, 0010 | Has been de-identified as part of submission process. |
PatientAgeManufacturer | 00100008, 10100070 | Standard DICOM definition | ||
PatientIDManufacturerModelName | 00100008, 0020 | Has been de-identified as part of submission process. | ||
PatientName | 0010, 0010 | Has been de-identified as part of submission process. | ||
PatientBirthDate | 0010, 0030 | Has been de-identified (emptied) as part of submission process. | ||
PatientSex | 0010, 0040 | Standard DICOM definition | ||
EthnicGroup | 0010, 2160 | Standard DICOM definition | ||
Collection | N/A | A label used to name a set of images collected for a specific trial or other reason. Assigned during the process of curating the data. | ||
SeriesCount | N/A | Computed number of series | 0012, 0053 | The type of event to which Longitudinal Temporal Offset from Event (0012,0052) is relative. |
longitudinalTemporalOffsetFromEvent | 0012, 0052 | An offset in days from a particular event of significance. May be fractional. In the context of a clinical trial, this is often the days since enrollment, or the baseline imaging Study. |
1090 | Standard DICOM definition | |
SoftwareVersions | 0018, 1020 | Standard DICOM definition |
ImageCount | N/A | Computed number of images in this series |
TimeStamp | N/A | The time that TCIA received the data, which is before curation and publishing |
LicenseName | N/A | License that applies to this series |
LicenseURI | N/A | URL of license source |
CollectionURI | N/A | URI of collection |
FileSize | N/A | File size |
DateReleased | N/A | The date that TCIA published the series |
StudyDescription | 0008,1030 | Institution-generated description or classification of the Study performed |
StudyDate | 0008,0020 | Date the study started |
getSeriesMetaData
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getSeriesgetSeriesMetaData?SeriesInstanceUID=1.3.6.1.4.1.14519.5.2.1.6834.5010.322628904903035357840500590726 |
Attribute | DICOM Tag | Description |
---|---|---|
Series UID | 0020, 000E | Standard DICOM definition |
Attribute | DICOM Tag | Description |
SeriesInstanceUID | 0020, 000E | Has been de-identified as part of submission process |
StudyInstanceUID | 0020, 000D | Has been de-identified as part of submission process |
Modality | 0008, 0060 | Standard DICOM definition |
ProtocolName | 0018, 1030 | Standard DICOM definition. Has been inspected and cleaned of any PHI. |
SeriesDate | 0008, 0021 | Standard DICOM definition |
SeriesDescription | 0008, 103E | Standard DICOM definition. Has been inspected and cleaned of any PHI. |
BodyPartExamined | 0018, 0015 | Entered on a per collection basis using relevant SNOMED terms |
SeriesNumber | 0020, 0011 | Standard DICOM definition |
AnnotationsFlag | N/A | Indicates if there are annotations for a collection |
Collection | N/A | A label used to name a set of images collected for a specific trial or other reason. Assigned during the process of curating the data. |
PatientID | 0010, 0020 | Has been de-identified as part of submission process |
Manufacturer | 0008, 0070 | Standard DICOM definition |
ManufacturerModelName | 0008, 1090 | Standard DICOM definition |
SoftwareVersions | 0018, 1020 | Standard DICOM definition |
ImageCount | N/A | Computed number of images in this series |
max_TimeStamp (NBIA at TCIA 7.8) | N/A | Last update to the series |
getSeriesMetaData
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getSeriesMetaData?SeriesInstanceUID=1.3.6.1.4.1.9590.100.1.2.374115997511889073021386151921807063992 |
other reason. Assigned during the process of curating the data. | ||
3rd Party Analysis | N/A | Data from third-party analysis results |
Data Description URI | N/A | Location of the data description |
Subject ID | N/A | Unique identifier for the subject |
Study UID | 0020, 000D | Standard DICOM definition |
Study Description | 0008, 1030 | Institution-generated description or classification of the Study (component) performed |
Study Date | 0008, 0020 | Has been de-identified as part of submission process. Longitudinal information is preserved. |
Series Description | 0020, 0011 | Standard DICOM definition. Has been inspected and cleaned of any PHI. |
Manufacturer | 0008, 0070 | Standard DICOM definition |
Modality | 0008, 0060 | Standard DICOM definition |
SOP Class UID | N/A | Unique identifier of the SOP Class |
Number of Images | N/A | Number of images in this series |
File Size | N/A | File size in bytes |
File Location | N/A | Location of the file in the file system |
Series Number | 0020,0011 | Standard DICOM definition |
License Name | N/A | License that applies to this series |
License URL | N/A | URL of license source |
Annotation Size | N/A | Size of annotation files in bytes |
Date Released | N/A | The date that TCIA published the series |
SeriesDate | 0008, 0021 | Standard DICOM definition |
ProtocolName | 0018,1030 | Name of the protocol |
BodyPartExamined | 0018, 0015 | Entered on a per-collection basis using relevant SNOMED terms |
AnnotationsFlag | N/A | Indicates if there are annotations for a collection |
ManufacturerModelName | 0008, 1090 | Standard DICOM definition |
SoftwareVersions | 0018, 1020 | Standard DICOM definition |
TimeStamp | N/A | The time that TCIA received the data, which is before curation and publishing |
Attribute | DICOM Tag | Description |
---|---|---|
Series UID | 0020, 000E | Standard DICOM definition |
Collection | N/A | A label used to name a set of images collected for a specific trial or other reason. Assigned during the process of curating the data. |
Data Description URI | N/A | Location of the data description |
Subject ID | N/A | Unique identifier for the subject |
Study UID | 0020, 000D | Standard DICOM definition |
Study Date | 0008, 0020 | Has been de-identified as part of submission process. Longitudinal information is preserved. |
Series Description | 0020, 0011 | Standard DICOM definition. Has been inspected and cleaned of any PHI. |
Modality | 0008, 0060 | Standard DICOM definition |
SOP Class UID | N/A | Unique identifier of the SOP Class |
Number of Images | N/A | Number of images in this series |
File Size | N/A | File size in bytes |
File Location | N/A | Location of the file in the file system |
Series Number | 0020,0011 | Standard DICOM definition |
License Name | N/A | License that applies to this series |
License URL | N/A | URL of license source |
Annotation Size | N/A | Size of annotation files in bytes
getSeriesSize
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getSeriesSize?SeriesInstanceUID=1.3.6.1.4.1.959014519.5.1002.1.26834.5010.374115997511889073021386151921807063992322628904903035357840500590726 |
Attribute | DICOM Tag | Description |
---|---|---|
TotalSizeInBytes | N/A | Byte size of the specified series |
ObjectCount | N/A | Number of objects in the specified series |
getSingleImage
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getSingleImage?SeriesInstanceUID=1.3.6.1.4.1.9590.100.1.2.374115997511889073021386151921807063992&SOPInstanceUID:1.3.6.1.4.1.9590.100.1.2.289923739312470966435676008311959891294=143.284188174537413748743284550513035752067&SOPInstanceUID=143.53599064898089361503082484556513429004 |
Attribute | DICOM Tag | Description |
---|---|---|
N/A | N/A | Single image in DICOM format |
getSOPInstanceUIDs
Code Block | title | Sample Call
---|
https://services.cancerimagingarchive.net/nbia-api/services/v1/getSOPInstanceUIDs?SeriesInstanceUID=1.3.6.1.4.1.9590.100.1.2.374115997511889073021386151921807063992 |
Attribute | DICOM Tag | Description |
---|---|---|
SOPInstanceUID | 0008, 0018 | Uniquely identifies the SOP Instance |
getUpdatedSeries
Code Block | ||
---|---|---|
| ||
https://services.cancerimagingarchive.net/nbia-api/services/v1/getUpdatedSeries?fromDate=0128/0103/20202023 |
Attribute | DICOM Tag | Description |
---|---|---|
SeriesInstanceUID | 0020, 000E | Has been de-identified as part of submission process |
StudyInstanceUID | 0020, 000D | Has been de-identified as part of submission process |
Modality | 0008, 0060 | Standard DICOM definition |
ProtocolName | 0018, 1030 | Standard DICOM definition. Has been inspected and cleaned of any PHI. |
SeriesDate | 0008, 0021 | Standard DICOM definition |
SeriesDescription | 0008, 103E | Standard DICOM definition. Has been inspected and cleaned of any PHI. |
BodyPartExamined | 0018, 0015 | Entered on a per collection basis using relevant SNOMED terms |
SeriesNumber | 0020, 0011 | Standard DICOM definition |
AnnotationsFlag | N/A | Indicates if there are annotations for a collection |
Collection | N/A | A label used to name a set of images collected for a specific trial or other reason. Assigned during the process of curating the data. |
PatientID | 0010, 0020 | Has been de-identified as part of submission process. |
Manufacturer | 0008, 0070 | Standard DICOM definition |
ManufacturerModelName | 0008, 1090 | Standard DICOM definition |
SoftwareVersions | 0018, 1020 | Standard DICOM definition |
ImageCount | N/A | Number of images in the specified series |
DateReleased | N/A | The date that TCIA published the series |