onconova.oncology.models.tumor_marker
ANALYTES_DATA
module-attribute
¶
AnalyteDetails
¶
Bases: BaseModel
Represents details about a tumor marker analyte.
Attributes:
| Name | Type | Description |
|---|---|---|
acronym |
str
|
The acronym or short name for the analyte. |
display |
str
|
The display name or description of the analyte. |
valueTypes |
List[AnalyteResultType]
|
List of possible result types for the analyte. |
AnalyteResultType
¶
Bases: Enum
Enum representing the various types of analyte results that can be reported for tumor markers.
Members
mass_concentration: Quantitative measurement of mass per unit volume (e.g., ng/mL). arbitary_concentration: Measurement based on arbitrary units, often used when no standard exists. substance_concentration: Quantitative measurement of substance amount per unit volume (e.g., mol/L). multiple_of_median: Value expressed as a multiple of the median value in a reference population. fraction: Proportion or percentage of a particular analyte present. presence: Indicates the presence or absence of the analyte. combined_positive_score: Composite score reflecting combined positivity of multiple markers. immmune_cells_score: Score representing the presence or activity of immune cells. tumor_proportion_score: Score indicating the proportion of tumor cells expressing a marker. immunohistochemical_score: Score derived from immunohistochemical staining results. nuclear_expression_status: Status indicating expression of a marker in the cell nucleus.
arbitary_concentration
class-attribute
instance-attribute
¶
combined_positive_score
class-attribute
instance-attribute
¶
fraction
class-attribute
instance-attribute
¶
immmune_cells_score
class-attribute
instance-attribute
¶
immunohistochemical_score
class-attribute
instance-attribute
¶
mass_concentration
class-attribute
instance-attribute
¶
multiple_of_median
class-attribute
instance-attribute
¶
nuclear_expression_status
class-attribute
instance-attribute
¶
presence
class-attribute
instance-attribute
¶
substance_concentration
class-attribute
instance-attribute
¶
tumor_proportion_score
class-attribute
instance-attribute
¶
TumorMarker
¶
Bases: BaseModel
Represents a tumor marker result associated with a patient case.
Attributes:
| Name | Type | Description |
|---|---|---|
case |
ForeignKey[PatientCase]
|
Reference to the related patient case. |
date |
DateField
|
Date when the tumor marker was analyzed. |
related_entities |
ManyToManyField[NeoplasticEntity]
|
Neoplastic entities related to the tumor marker analysis. |
analyte |
CodedConceptField[TumorMarkerAnalyte]
|
The chemical or biological substance/agent analyzed. |
mass_concentration |
MeasurementField[MassConcentration]
|
Mass concentration of the analyte (optional). |
arbitrary_concentration |
MeasurementField[ArbitraryConcentration]
|
Arbitrary concentration of the analyte (optional). |
substance_concentration |
MeasurementField[SubstanceConcentration]
|
Substance concentration of the analyte (optional). |
fraction |
MeasurementField[Fraction]
|
Analyte fraction (optional). |
multiple_of_median |
MeasurementField[MultipleOfMedian]
|
Multiples of the median analyte (optional). |
tumor_proportion_score |
CharField[TumorMarkerTumorProportionScoreChoices]
|
Tumor proportion score (TPS) for PD-L1 expression (optional). |
immune_cell_score |
CharField[TumorMarkerImmuneCellScoreChoices]
|
Immune cell score (ICS) for PD-L1 positive immune cells (optional). |
combined_positive_score |
MeasurementField[Fraction]
|
Combined positive score (CPS) for PD-L1 (optional). |
immunohistochemical_score |
CharField[TumorMarkerImmunohistochemicalScoreChoices]
|
Immunohistochemical score for analyte-positive cells (optional). |
presence |
CharField[TumorMarkerPresenceChoices]
|
Indicates if the analyte tested positive or negative (optional). |
nuclear_expression_status |
CharField[TumorMarkerNuclearExpressionStatusChoices]
|
Status of nuclear expression of the analyte (optional). |
value |
str
|
Returns a string representation of the first available value among the measurement and score fields. |
description |
str
|
Returns a human-readable description combining the analyte and its value. |
Constraints
Ensures at least one value field is set for each tumor marker instance.
analyte
class-attribute
instance-attribute
¶
arbitrary_concentration
class-attribute
instance-attribute
¶
case
class-attribute
instance-attribute
¶
combined_positive_score
class-attribute
instance-attribute
¶
date
class-attribute
instance-attribute
¶
description
property
¶
fraction
class-attribute
instance-attribute
¶
immune_cell_score
class-attribute
instance-attribute
¶
immunohistochemical_score
class-attribute
instance-attribute
¶
mass_concentration
class-attribute
instance-attribute
¶
multiple_of_median
class-attribute
instance-attribute
¶
nuclear_expression_status
class-attribute
instance-attribute
¶
presence
class-attribute
instance-attribute
¶
related_entities
class-attribute
instance-attribute
¶
substance_concentration
class-attribute
instance-attribute
¶
tumor_proportion_score
class-attribute
instance-attribute
¶
value
property
¶
TumorMarkerImmuneCellScoreChoices
¶
TumorMarkerImmunohistochemicalScoreChoices
¶
Bases: TextChoices
An enumeration representing possible immunohistochemical scoring values for tumor markers.
Attributes:
| Name | Type | Description |
|---|---|---|
ZERO |
str
|
Score of "0", indicating no detectable staining. |
ONE |
str
|
Score of "1+", indicating weak staining. |
TWO |
str
|
Score of "2+", indicating moderate staining. |
THREE |
str
|
Score of "3+", indicating strong staining. |
INDETERMINATE |
str
|
Score of "indeterminate", indicating that the result cannot be determined. |
TumorMarkerNuclearExpressionStatusChoices
¶
Bases: TextChoices
An enumeration representing the status of nuclear expression for a tumor marker.
Attributes:
| Name | Type | Description |
|---|---|---|
INTACT |
str
|
Indicates that nuclear expression is intact. |
LOSS |
str
|
Indicates a loss of nuclear expression. |
INDETERMINATE |
str
|
Indicates that the nuclear expression status is indeterminate. |
TumorMarkerPresenceChoices
¶
Bases: TextChoices
An enumeration representing the possible presence states of an analyte in a tumor marker test.
Attributes:
| Name | Type | Description |
|---|---|---|
POSITIVE |
Indicates the analyte is present. |
|
NEGATIVE |
Indicates the analyte is absent. |
|
INDETERMINATE |
Indicates the presence of the analyte could not be determined. |