idc_index_schema.json

{
  "table_description": "This is the main metadata table provided by idc-index. Each row corresponds to a DICOM series, and contains attributes at the collection, patient, study, and series levels. The table also contains download-related attributes, such as the AWS S3 bucket and URL to download the series.",
  "columns": [
    {
      "name": "collection_id",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "short string with the identifier of the collection the series belongs to"
    },
    {
      "name": "analysis_result_id",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "this string is not empty if the specific series is part of an analysis results collection; analysis results can be added to a given collection over time"
    },
    {
      "name": "PatientID",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "identifier of the patient within the collection (DICOM attribute)"
    },
    {
      "name": "SeriesInstanceUID",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": ""
    },
    {
      "name": "StudyInstanceUID",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "unique identifier of the DICOM study (DICOM attribute)"
    },
    {
      "name": "source_DOI",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "Digital Object Identifier of the dataset that contains the given series; follow this DOI to learn more about the activity that produced this series"
    },
    {
      "name": "PatientAge",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "age of the subject at the time of imaging (DICOM attribute)"
    },
    {
      "name": "PatientSex",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "subject sex (DICOM attribute)"
    },
    {
      "name": "StudyDate",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "date of the study (de-identified) (DICOM attribute)"
    },
    {
      "name": "StudyDescription",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "textual description of the study content (DICOM attribute)"
    },
    {
      "name": "BodyPartExamined",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "body part imaged (not applicable for SM series) (DICOM attribute). For derived series (SEG, RTSTRUCT) this reflects the source acquisition, not the segmented anatomy -- what was segmented is recorded in the seg_index table (SegmentedPropertyType_CodeMeanings) and in rtstruct_index."
    },
    {
      "name": "Modality",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "acquisition modality (DICOM attribute)"
    },
    {
      "name": "SOPClassUID",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "SOP Class UID identifying the type of DICOM object (e.g., CT Image Storage, Segmentation Storage); more specific than Modality for distinguishing object types (DICOM attribute)"
    },
    {
      "name": "sop_class_name",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "human-readable name of the SOP Class (e.g., \"CT Image Storage\", \"Segmentation Storage\"); derived from SOPClassUID"
    },
    {
      "name": "TransferSyntaxUID",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "Transfer Syntax UID identifying the encoding of the stored instances (e.g., Explicit VR Little Endian, JPEG 2000, HTJ2K); comma-separated when a series contains instances with different encodings, which is common for SM (DICOM attribute)"
    },
    {
      "name": "transfer_syntax_name",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "human-readable name of the Transfer Syntax (e.g., \"JPEG 2000\", \"Explicit VR Little Endian\"); comma-separated when a series contains instances with different encodings; derived from TransferSyntaxUID"
    },
    {
      "name": "PhotometricInterpretation",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "intended interpretation of the pixel data, e.g., MONOCHROME2 (grayscale), RGB or YBR_FULL_422 (color); NULL for non-image objects (e.g., SEG, SR, RTSTRUCT); comma-separated when a series contains instances with different values (DICOM attribute)"
    },
    {
      "name": "PixelRepresentation",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "data representation of pixel sample values: \"0\" for unsigned integers, \"1\" for signed integers; NULL for non-image objects; comma-separated when a series contains instances with different values (DICOM attribute)"
    },
    {
      "name": "Manufacturer",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "manufacturer of the equipment that produced the series (DICOM attribute)"
    },
    {
      "name": "ManufacturerModelName",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "model name of the equipment that produced the series (DICOM attribute)"
    },
    {
      "name": "SeriesDate",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "date of the series (de-identified) (DICOM attribute)"
    },
    {
      "name": "SeriesDescription",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "textual description of the series content (DICOM attribute)"
    },
    {
      "name": "SeriesNumber",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "series number (DICOM attribute)"
    },
    {
      "name": "instanceCount",
      "type": "INTEGER",
      "mode": "NULLABLE",
      "description": "number of instances in the series"
    },
    {
      "name": "license_short_name",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "short name of the license that applies to this series"
    },
    {
      "name": "series_init_idc_version",
      "type": "INTEGER",
      "mode": "NULLABLE",
      "description": "IDC data release version number when this series first appeared in IDC (integer, e.g., 1 for v1)"
    },
    {
      "name": "series_revised_idc_version",
      "type": "INTEGER",
      "mode": "NULLABLE",
      "description": "IDC data release version number when this series was most recently revised in IDC (integer, e.g., 24 for v24)"
    },
    {
      "name": "aws_bucket",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "name of the AWS S3 bucket that contains the series"
    },
    {
      "name": "crdc_series_uuid",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "unique identifier of the series within the IDC"
    },
    {
      "name": "series_aws_url",
      "type": "STRING",
      "mode": "NULLABLE",
      "description": "public AWS S3 URL to download the series in bulk (each instance is a separate file)"
    },
    {
      "name": "series_size_MB",
      "type": "FLOAT",
      "mode": "NULLABLE",
      "description": "total size of the series in megabytes"
    }
  ]
}