omidb.events

class omidb.events.BaseEvent(left_opinion: Optional[omidb.events.SideOpinion] = None, right_opinion: Optional[omidb.events.SideOpinion] = None, dates: Optional[List[datetime.date]] = None)

Generic NBSS information pertaining to a medical procedure.

Parameters

• left_opinion (Optional[SideOpinion]) – Code summarising the diagnosis of the left breast

• right_opinion (Optional[SideOpinion]) – Code summarising the diagnosis of the right breast

• dates (Optional[List[date]]) – Dates extracted from left and right lesion data

class omidb.events.BreastScreeningData(date: Optional[datetime.date] = None, equipment_make_model: Optional[str] = None, opinion: Optional[omidb.events.Opinion] = None)

Side-specific breast-screening data.

Parameters

• date (Optional[date]) – Date that the examination took place

• equipment_make_model (Optional[str]) – Short description of the equipment used for the examination. Typically the manufacturer of the imaging device.

• opinion (Optional[Opinion]) – Enumeration representing the opinion code

class omidb.events.Screening(left_opinion: Optional[omidb.events.SideOpinion] = None, right_opinion: Optional[omidb.events.SideOpinion] = None, dates: Optional[List[datetime.date]] = None, left: Optional[omidb.events.BreastScreeningData] = None, right: Optional[omidb.events.BreastScreeningData] = None)

Bases: omidb.events.BaseEvent

NBSS information pertaining to a screening procedure.

Parameters

• left (Optional[BreastScreeningData]) – Screening information for the left breast

• right (Optional[BreastScreeningData]) – Screening information for the right breast

class omidb.events.Event

Type of event. Corresponds to the fields of omidb.events.Events

assessment = 'assessment'

biopsy_fine = 'biopsy_fine'

biopsy_wide = 'biopsy_wide'

clinical = 'clinical'

screening = 'screening'

surgery = 'surgery'

class omidb.events.Events(screening: Optional[List[omidb.events.Screening]] = None, assessment: Optional[omidb.events.BaseEvent] = None, clinical: Optional[omidb.events.BaseEvent] = None, biopsy_wide: Optional[omidb.events.BaseEvent] = None, biopsy_fine: Optional[omidb.events.BaseEvent] = None, surgery: Optional[omidb.events.BaseEvent] = None)

A collection of events, for a given omidb.core.Episode.

assessment = None

biopsy_fine = None

biopsy_wide = None

clinical = None

screening = None

surgery = None

class omidb.events.Opinion

Opinion after a procedure

A1 = 'Assess normal'

A2 = 'Assess benign'

A3 = "Assess uncert'n"

A4 = 'Assess suspic'

A5 = 'Assess malig'

B1 = 'Unsatis/Normal'

B2 = 'Benign'

B3 = 'Benign unc mal'

B4 = 'Susp of malig'

B5 = 'Malignant'

BA = 'Clinical'

C1 = 'Cyt unsatis'

C2 = 'Cyt benign'

C3 = 'Cyt atypia'

C4 = 'Cyt susp malig'

C5 = 'Cyt malig'

H0 = 'Hist unreported'

H1 = 'Histol normal'

H2 = 'Histol benign'

H5 = 'Hist malignant'

I1 = 'Imaging normal'

I2 = 'Imaging benign'

I3 = 'Imaging uncertain'

I4 = 'Imaging suspicious'

I5 = 'Imaging malig'

MRI1 = 'MRI normal'

MRI2 = 'MRI benign'

MRI3 = 'MRI indeterminate'

MRI4 = 'MRI suspicious'

MRI5 = 'MRI malig'

OB = 'O Benign'

OM = 'O Malignant'

ON = 'O Normal'

OS = 'O Suspicious'

OU = 'O Uncertain'

P1 = 'Clin normal'

P2 = 'Clin benign'

P3 = 'Clin uncertain'

P4 = 'Clin suspicious'

P5 = 'Clin malignant'

R1 = 'Rad normal'

R2 = 'Rad benign'

R3 = 'Rad uncertain'

R4 = 'Rad suspicious'

R5 = 'Rad malig'

RB = 'R Benign'

RM = 'R Malignant'

RN = 'R Normal'

RO = 'R Unreported'

RS = 'R Suspicious'

RU = 'R Uncertain'

SH = 'History suspic'

U1 = 'USS normal'

U2 = 'USS benign'

U3 = 'USS uncertain'

U4 = 'USS suspicious'

U5 = 'USS malig'

class omidb.events.SideOpinion

Side-specific opinion

OB = 'Benign'

OM = 'Malignant'

ON = 'Normal'

OS = 'Suspicious'

OU = 'Uncertain'