getBodyPartValues| Code Block |
|---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/getBodyPartValues" |
| Return Values |
|---|
| Attribute | DICOM Tag | Description |
|---|
| BodyPartExamined | 0018, 0015 | Standard DICOM definition |
getCollectionValues| Code Block |
|---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/getCollectionValues" |
| Return Values |
|---|
| 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. |
getContentsByName| Code Block |
|---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/getContentsByName?name=TCIA_TCGA-PRAD_08-09-2016-v3" |
| Return Values |
|---|
| 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 | 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 |
getImageThe license file, which includes the data usage agreement, is included in the returned ZIP file. | Code Block |
|---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/getImage?SeriesInstanceUID=1.3.6.1.4.1.9590.100.1.2.374115997511889073021386151921807063992" |
| Return Values |
|---|
| Attribute | DICOM Tag | Description |
|---|
| N/A | N/A | Set of images in a ZIP file |
getImageWithMD5Hash| Code Block |
|---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/getImageWithMD5Hash?SeriesInstanceUID=1.3.6.1.4.1.14519.5.2.1.6919.4624.313514201353787659031503464798" |
| Return Values |
|---|
Attribute | DICOM Tag | Description |
|---|
| N/A | N/A | Set of images in a ZIP file |
getManufacturerValues| Code Block |
|---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/getManufacturerValues" |
| Return Values |
|---|
Attribute | DICOM Tag | Description |
|---|
Manufacturer | 0008, 0070 | Standard DICOM definition |
getModalityValues| Code Block |
|---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/getModalityValues" |
| Return Values |
|---|
| Attribute | DICOM Tag | Description |
|---|
| Modality | 0008, 0060 | Standard DICOM definition |
NewPatientsInCollection| Code Block |
|---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/NewPatientsInCollection?Collection=CBIS-DDSM&Date=2010/08/16" |
| Return Values |
|---|
| 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. | | 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. |
NewStudiesInPatientCollection | Code Block |
|---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/NewStudiesInPatientCollection?Collection=CBIS-DDSM&Date=2010/08/16" |
| Return Values |
|---|
| 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. | 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 | Has been de-identified as part of submission process. | PatientAge | 0010, 1010 | Standard DICOM definition | 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 | 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. | 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 |
|---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/getPatient" |
| Return Values |
|---|
| 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 | 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 |
|---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/getPatientByCollectionAndModality?Collection=VICTRE&Modality=MG" |
| Return Values |
|---|
| Attribute | DICOM Tag | Description |
|---|
| PatientId | 0010, 0020 | A list of patient IDs for a specified collection and modality |
getPatientStudy| Code Block |
|---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/getPatientStudy" |
| Return Values |
|---|
| 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. | | 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 | Has been de-identified as part of submission process. | | PatientAge | 0010, 1010 | Standard DICOM definition | | 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 (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| Code Block |
|---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/getSeries |
| Return Values |
|---|
| 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 | | 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 |
| Code Block |
|---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/getSeriesMetaData?SeriesInstanceUID=1.3.6.1.4.1.9590.100.1.2.374115997511889073021386151921807063992" |
| Return Values |
|---|
| Attribute | DICOM Tag | Description |
|---|
Series UIDID | 0020, 000E | Standard DICOM definition | Collection Name | 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. | 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 |
getSeriesSize| Code Block |
|---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/getSeriesSize?SeriesInstanceUID=1.3.6.1.4.1.9590.100.1.2.374115997511889073021386151921807063992" |
| Return Values |
|---|
| 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 |
|---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/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" |
| Return Values |
|---|
| Attribute | DICOM Tag | Description |
|---|
| N/A | N/A | Single image in DICOM format |
getSOPInstanceUIDs| Code Block |
|---|
| curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/getSOPInstanceUIDs?SeriesInstanceUID=1.3.6.1.4.1.9590.100.1.2.374115997511889073021386151921807063992" |
| Return Values |
|---|
| Attribute | DICOM Tag | Description |
|---|
| SOPInstanceUID | 0008, 0018 | Uniquely identifies the SOP Instance |
getUpdatedSeries| Code Block |
|---|
curl -H "Authorization:Bearer YOUR_ACCESS_TOKEN" -k "https://services.cancerimagingarchive.net/nbia-api/services/v2/getUpdatedSeries?fromDate=28/03/2023" |
| Return Values |
|---|
| 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 |
|