Repository navigation
Image
The following metadata fields are currently recognized, and will be parsed and validated. Any additional metadata fields (not matching one of these names) will be stored without validation as inaccessible "unstructured" metadata.
-
image_type- Allowed values:
dermoscopicclinical: close-upclinical: overviewTBP tile: close-upTBP tile: overview
- Stored as:
meta.acquisition.image_type
- Allowed values:
The following metadata fields only apply when meta.acquisition.image_type is dermoscopic:
-
dermoscopic_type- Allowed values:
contact polarizedcontact non-polarizednon-contact polarized
- Stored as:
meta.acquisition.dermoscopic_type
- Allowed values:
The following metadata fields only apply when meta.acquisition.image_type is TBP tile: close-up or TBP tile: overview:
-
tbp_tile_type- Allowed values:
3D: white3D: XP2D
- Stored as:
meta.acquisition.tbp_tile_type
- Allowed values:
-
anatom_site_general- Allowed values:
head/neckupper extremitylower extremityanterior torsoposterior torsopalms/soleslateral torsooral/genital
- Stored as:
meta.clinical.anatom_site_general
- Allowed values:
-
age- Allowed values:
- any integer
-
85(aliases:85+)
- Stored as:
meta.clinical.age_approx - Note: this value will be automatically clipped at
85, where any value greater than this will be stored as85. - Note: this value will automatically rounded to 5-year intervals, to ensure data de-identification. However, the original value will continue to be stored internally as private metadata.
- Allowed values:
-
sex- Allowed values:
malefemale
- Stored as:
meta.clinical.sex
- Allowed values:
-
family_hx_mm- Allowed values:
-
true(aliases:yes) -
false(aliases:no)
-
- Stored as:
meta.clinical.family_hx_mm
- Allowed values:
-
personal_hx_mm- Allowed values:
-
true(aliases:yes) -
false(aliases:no)
-
- Stored as:
meta.clinical.personal_hx_mm
- Allowed values:
-
clin_size_long_diam_mm- Allowed values:
- floating-point value with units of
um,mm, orcm- e.g.
4.5 mm, or1cm
- e.g.
- floating-point value with units of
- Stored as:
meta.clinical.clin_size_long_diam_mm - Note: this value will automatically be converted to units of
mm, once stored.
- Allowed values:
-
diagnosis- Allowed values:
actinic keratosisadnexal tumorAIMPangiokeratomaangiomabasal cell carcinomacafe-au-lait maculedermatofibromaephelislentigo NOSlentigo simplexlichenoid keratosismelanomamelanoma metastasismerkel cell carcinomamucosal melanosisnevusnevus spilusseborrheic keratosissolar lentigosquamous cell carcinomaclear cell acanthomaatypical spitz tumoracrochordonangiofibroma or fibrous papuleneurofibromapyogenic granulomascarsebaceous adenomasebaceous hyperplasiaverrucaatypical melanocytic proliferationepidermal nevuspigmented benign keratosisvascular lesionother
- Stored as:
meta.clinical.diagnosis
- Allowed values:
-
melanocytic- Allowed values:
-
true(aliases:yes) -
false(aliases:no)
-
- Stored as:
meta.clinical.melanocytic
- Allowed values:
-
benign_malignant- Allowed values:
benignmalignantindeterminateindeterminate/benignindeterminate/malignant
- Stored as:
meta.clinical.benign_malignant - Note: the value of
benign_malignantinteracts withmeta.clinical.diagnosis:- If
meta.clinical.diagnosisismelanoma, thenbenign_malignantmust bemalignant. - If
meta.clinical.diagnosisisnevus, thenbenign_malignantmust bebenign,indeterminate/benign, orindeterminate.
- If
- Allowed values:
-
diagnosis_confirm_type- Allowed values:
histopathologyserial imaging showing no changesingle image expert consensusconfocal microscopy with consensus dermoscopysingle contributor clinical assessment
- Stored as:
meta.clinical.diagnosis_confirm_type - Note: the value of
diagnosis_confirm_typeinteracts withmeta.clinical.benign_malignant:- If
meta.clinical.benign_malignantisindeterminate/benign,indeterminate/malignant,indeterminate, ormalignant(i.e. anything other thanbenignor absent), thendiagnosis_confirm_typemust behistopathology.
- If
- Allowed values:
-
patient_id- Allowed values:
- any string
- Stored as:
meta.clinical.patient_id - Note: the value stored will be mapped to a well structured patient id of the format:
IP_1234567. The original value will never be publicly accessible. - Note: the interaction with the
lesion_idfield.
- Allowed values:
-
lesion_id- Allowed values:
- any string
- Stored as:
meta.clinical.lesion_id - Note: the value stored will be mapped to a well structured lesion id of the format:
IL_1234567. The original value will never be publicly accessible. - Note: the same
lesion_idvalue can't belong to multiple instances of the samepatient_id.
- Allowed values:
-
acquisition_day- Allowed values:
- any integer
- Allowed values:
The following metadata fields only apply when meta.clinical.diagnosis is nevus or nevus spilus:
-
nevus_type- Allowed values:
bluecombinednevus NOSdeep penetratinghalopersistent/recurrentpigmented spindle cell of reedplexiform spindle cellspecial sitespitz
- Stored as:
meta.clinical.nevus_type
- Allowed values:
The following metadata fields only apply when meta.clinical.diagnosis is melanoma:
-
mel_thick_mm- Allowed values:
- floating-point value with units of
mm- e.g.
4.5 mm,1mm, or3.25
- e.g.
- floating-point value with units of
- Stored as:
meta.clinical.mel_thick_mm
- Allowed values:
-
mel_class- Allowed values:
melanoma in situinvasive melanomarecurrent/persistent melanoma, in siturecurrent/persistent melanoma, invasivemelanoma NOS
- Stored as:
meta.clinical.mel_class
- Allowed values:
-
mel_type- Allowed values:
superficial spreading melanomanodular melanomalentigo maligna melanomaacral lentiginous melanomamelanoma NOS
- Stored as:
meta.clinical.mel_type
- Allowed values:
-
mel_mitotic_index- Allowed values:
0/mm^2<1/mm^21/mm^22/mm^23/mm^24/mm^2>4/mm^2
- Stored as:
meta.clinical.mel_mitotic_index
- Allowed values:
-
mel_ulcer- Allowed values:
-
true(aliases:yes) -
false(aliases:no)
-
- Stored as:
meta.clinical.mel_ulcer
- Allowed values: