Skip to content

DicomMetadataMapping

Source code in docs_src/capo_medical_imaging/types/dicom_metadata_mapping.py
class DicomMetadataMapping(TypedDict, closed=True):
    study_instance_uid: (
        "capo_medical_imaging.types.dicom_study_instance_uid.DICOMStudyInstanceUID"
    )
    """<p>The Study Instance UID that identifies the study.</p>"""
    series_instance_uid: NotRequired[
        "capo_medical_imaging.types.dicom_series_instance_uid.DICOMSeriesInstanceUID"
    ]
    """<p>The Series Instance UID that identifies the series. This parameter is optional because the mapping might be at the study level.</p>"""
    metadata_file_path: "capo_medical_imaging.types.metadata_file_path.MetadataFilePath"
    """<p>The path to the JSON metadata file relative to inputS3Uri.</p>"""

metadata_file_path instance-attribute

metadata_file_path: MetadataFilePath

The path to the JSON metadata file relative to inputS3Uri.

series_instance_uid instance-attribute

series_instance_uid: NotRequired[DICOMSeriesInstanceUID]

The Series Instance UID that identifies the series. This parameter is optional because the mapping might be at the study level.

study_instance_uid instance-attribute

study_instance_uid: DICOMStudyInstanceUID

The Study Instance UID that identifies the study.