omidb.client

class omidb.client.Client(id: str, episodes: List[omidb.episode.Episode], site: omidb.client.Site)

A client represents a patient who has attended the NHS screening programme.

Each client will have one or more omidb.episode.Episode s, for which (anonymised and pseudonymised) NBSS information can be found.

Parameters

• id (str) – Client identifier, typically a four letter ID followed by a series of digits, e.g. optm1, demd7050

• episodes (List[Episode]) – A list of omidb.episode.Episode s associated with the client

• site (Site) – Enumeration signifying the clinical site/centre where screening took place

property status

Determines the omidb.client.Status by first classifying each episode according to its type and the surgery and biopsy opinions, and subsequently applying the following precedence rules (from top to bottom: highest to lowest precedence):

• Status.CI: if any interval cancer episode

• Status.M: if any malignant episode (based on surgery/biopsy opinions)

• Status.B: if any benign episode (based on surgery/biopsy opinions)

• Status.N: otherwise

Return type

Status

class omidb.client.Site

Site/centre where the medical examination took place

adde = 'adde'

jarv = 'jarv'

stge = 'stge'

class omidb.client.Status

Summarises the overall status of a client according to the event opinions within an episode, and the type of episode itself.

B = 'Benign'

CI = 'Interval Cancer'

M = 'Malignant'

N = 'Normal'