Skip to content

onconova.interoperability.fhir.models.CancerRiskAssessment

NoneType module-attribute

CancerRiskAssessment

Bases: USCoreSimpleObservationProfile

assessment observation

code class-attribute instance-attribute

device class-attribute instance-attribute

focus class-attribute instance-attribute

hasMember class-attribute instance-attribute

referenceRange class-attribute instance-attribute

subject class-attribute instance-attribute

value property

valueCodeableConcept class-attribute instance-attribute

FHIR_obs_3_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@model_validator(mode="after")
def FHIR_obs_3_constraint_validator(self):
    return validate_element_constraint(
        self,
        elements="referenceRange",
        expression="low.exists() or high.exists() or text.exists()",
        human="Must have at least a low or a high or text",
        key="obs-3",
        severity="error",
    )

FHIR_obs_6_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@model_validator(mode="after")
def FHIR_obs_6_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="dataAbsentReason.empty() or value.empty()",
        human="dataAbsentReason SHALL only be present if Observation.value[x] is not present",
        key="obs-6",
        severity="error",
    )

FHIR_obs_7_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@model_validator(mode="after")
def FHIR_obs_7_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()",
        human="If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present",
        key="obs-7",
        severity="error",
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["CodeableConcept"],
        field_name_base="value",
        required=False,
    )

OnconovaCancerRiskAssessment

Bases: CancerRiskAssessment

assessment observation

basedOn class-attribute instance-attribute

category class-attribute instance-attribute

component class-attribute instance-attribute

dataAbsentReason class-attribute instance-attribute

derivedFrom class-attribute instance-attribute

effective property

encounter class-attribute instance-attribute

extension class-attribute instance-attribute

hasMember class-attribute instance-attribute

interpretation class-attribute instance-attribute

partOf class-attribute instance-attribute

performer class-attribute instance-attribute

status class-attribute instance-attribute

value property

FHIR_o_ria_req_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@model_validator(mode="after")
def FHIR_o_ria_req_1_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="subject.exists()",
        human="The subject element is required and must be provided.",
        key="o-ria-req-1",
        severity="error",
    )

FHIR_o_ria_req_2_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@model_validator(mode="after")
def FHIR_o_ria_req_2_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="effectiveDateTime.exists() and effectiveDateTime.hasValue()",
        human="The effectiveDateTime element is required and must be provided.",
        key="o-ria-req-2",
        severity="error",
    )

FHIR_o_ria_req_3_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@model_validator(mode="after")
def FHIR_o_ria_req_3_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="code.exists() and code.coding.exists()",
        human="The code element is required and must be provided.",
        key="o-ria-req-3",
        severity="error",
    )

FHIR_o_ria_req_4_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@model_validator(mode="after")
def FHIR_o_ria_req_4_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="valueCodeableConcept.exists() and valueCodeableConcept.coding.exists()",
        human="The valueCodeableConcept element is required and must be provided.",
        key="o-ria-req-4",
        severity="error",
    )

category_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@field_validator(*("category",), mode="after", check_fields=None)
@classmethod
def category_slicing_cardinality_validator(cls, value):
    return validate_slicing_cardinalities(
        cls,
        value,
        field_name="category",
    )

effective_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@model_validator(mode="after")
def effective_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["DateTime"],
        field_name_base="effective",
        required=True,
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@field_validator(*("extension",), mode="after", check_fields=None)
@classmethod
def extension_slicing_cardinality_validator(cls, value):
    return validate_slicing_cardinalities(
        cls,
        value,
        field_name="extension",
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["CodeableConcept"],
        field_name_base="value",
        required=False,
    )

OnconovaCancerRiskAssessmentRiskAssessmentScore

Bases: RiskAssessmentScore, FHIRSliceModel

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

max_cardinality class-attribute

min_cardinality class-attribute

FHIR_ele_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@model_validator(mode="after")
def FHIR_ele_1_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="hasValue() or (children().count() > id.count())",
        human="All FHIR elements must have a @value or children",
        key="ele-1",
        severity="error",
    )

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@model_validator(mode="after")
def FHIR_ext_1_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="extension.exists() != value.exists()",
        human="Must have either extensions or value[x], not both",
        key="ext-1",
        severity="error",
    )

RiskAssessmentScore

Bases: Extension

The numerical score of the risk assessment.

extension class-attribute instance-attribute

url class-attribute instance-attribute

value property

valueDecimal class-attribute instance-attribute

valueInteger class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@model_validator(mode="after")
def FHIR_ext_1_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="extension.exists() != value.exists()",
        human="Must have either extensions or value[x], not both",
        key="ext-1",
        severity="error",
    )

FHIR_url_fixed_value_constraint(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@field_validator(*("url",), mode="after", check_fields=None)
@classmethod
def FHIR_url_fixed_value_constraint(cls, value):
    return validate_FHIR_element_fixed_value(
        cls,
        value,
        constant="http://onconova.github.io/fhir/StructureDefinition/onconova-ext-risk-assessment-score",
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@field_validator(*("extension",), mode="after", check_fields=None)
@classmethod
def extension_slicing_cardinality_validator(cls, value):
    return validate_slicing_cardinalities(
        cls,
        value,
        field_name="extension",
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["Decimal", "Integer"],
        field_name_base="value",
        required=False,
    )

USCoreSimpleObservationProfile

Bases: Observation

assessment observation

category class-attribute instance-attribute

code class-attribute instance-attribute

derivedFrom class-attribute instance-attribute

effective property

effectiveDateTime class-attribute instance-attribute

effectiveInstant class-attribute instance-attribute

effectivePeriod class-attribute instance-attribute

effectiveTiming class-attribute instance-attribute

performer class-attribute instance-attribute

status class-attribute instance-attribute

subject class-attribute instance-attribute

value property

valueBoolean class-attribute instance-attribute

valueCodeableConcept class-attribute instance-attribute

valueDateTime class-attribute instance-attribute

valueInteger class-attribute instance-attribute

valuePeriod class-attribute instance-attribute

valueQuantity class-attribute instance-attribute

valueRange class-attribute instance-attribute

valueRatio class-attribute instance-attribute

valueSampledData class-attribute instance-attribute

valueString class-attribute instance-attribute

valueTime class-attribute instance-attribute

FHIR_obs_6_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@model_validator(mode="after")
def FHIR_obs_6_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="dataAbsentReason.empty() or value.empty()",
        human="dataAbsentReason SHALL only be present if Observation.value[x] is not present",
        key="obs-6",
        severity="error",
    )

FHIR_obs_7_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@model_validator(mode="after")
def FHIR_obs_7_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()",
        human="If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present",
        key="obs-7",
        severity="error",
    )

category_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@field_validator(*("category",), mode="after", check_fields=None)
@classmethod
def category_slicing_cardinality_validator(cls, value):
    return validate_slicing_cardinalities(
        cls,
        value,
        field_name="category",
    )

effective_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@model_validator(mode="after")
def effective_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["DateTime", "Period", "Timing", "Instant"],
        field_name_base="effective",
        required=False,
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerRiskAssessment.py
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=[
            "Quantity",
            "CodeableConcept",
            "String",
            "Boolean",
            "Integer",
            "Range",
            "Ratio",
            "SampledData",
            "Time",
            "DateTime",
            "Period",
        ],
        field_name_base="value",
        required=False,
    )

USCoreSimpleObservationProfileUsCore

Bases: CodeableConcept, FHIRSliceModel

A code that classifies the general type of observation being made.

max_cardinality class-attribute

min_cardinality class-attribute

runner