Skip to content

onconova.interoperability.fhir.models.CancerFamilyMemberHistory

NoneType module-attribute

FamilyMemberConditionContributedToDeath

Bases: Extension

Whether the condition contributed to the patient's family member's death

extension class-attribute instance-attribute

url class-attribute instance-attribute

value property

valueBoolean class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerFamilyMemberHistory.py 
249
250
251
252
253
254
255
256
257
@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/CancerFamilyMemberHistory.py 
233
234
235
236
237
238
@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-family-member-condition-contributed-to-death',
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerFamilyMemberHistory.py 
226
227
228
229
230
231
@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/CancerFamilyMemberHistory.py 
240
241
242
243
244
245
246
247
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element( 
        self,
        field_types=['Boolean'],
        field_name_base="value",
        required=False,
    )

FamilyMemberHistoryCancerMorphology

Bases: Extension

The morphology of a historical cancer associated to a family member of a patient, represented by an ICD-O-3 code.

extension class-attribute instance-attribute

url class-attribute instance-attribute

value property

valueCodeableConcept class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerFamilyMemberHistory.py 
65
66
67
68
69
70
71
72
73
@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/CancerFamilyMemberHistory.py 
49
50
51
52
53
54
@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-family-history-member-cancer-morphology',
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerFamilyMemberHistory.py 
42
43
44
45
46
47
@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/CancerFamilyMemberHistory.py 
56
57
58
59
60
61
62
63
@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,
    )

FamilyMemberHistoryCancerTopography

Bases: Extension

The topography of a historical cancer associated to a family member of a patient, represented by an ICD-O-3 code.

extension class-attribute instance-attribute

url class-attribute instance-attribute

value property

valueCodeableConcept class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerFamilyMemberHistory.py 
157
158
159
160
161
162
163
164
165
@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/CancerFamilyMemberHistory.py 
141
142
143
144
145
146
@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-family-history-member-cancer-topography',
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerFamilyMemberHistory.py 
134
135
136
137
138
139
@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/CancerFamilyMemberHistory.py 
148
149
150
151
152
153
154
155
@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,
    )

OnconovaCancerFamilyMemberHistory

Bases: FamilyMemberHistory

Significant health conditions for a person related to the patient relevant in the context of care for the patient.

age property

ageAge class-attribute instance-attribute

ageRange class-attribute instance-attribute

ageString class-attribute instance-attribute

born property

bornDate class-attribute instance-attribute

bornPeriod class-attribute instance-attribute

bornString class-attribute instance-attribute

condition class-attribute instance-attribute

date class-attribute instance-attribute

deceased property

deceasedBoolean class-attribute instance-attribute

estimatedAge class-attribute instance-attribute

name class-attribute instance-attribute

patient class-attribute instance-attribute

reasonCode class-attribute instance-attribute

reasonReference class-attribute instance-attribute

relationship class-attribute instance-attribute

sex class-attribute instance-attribute

FHIR_o_fam_req_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerFamilyMemberHistory.py 
579
580
581
582
583
584
585
586
587
@model_validator(mode="after")
def FHIR_o_fam_req_1_constraint_validator(self):
    return validate_model_constraint( 
        self,
        expression='patient.exists()',
        human='The patient element is required and must be provided.',
        key='o-fam-req-1',
        severity='error',
    )

FHIR_o_fam_req_2_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerFamilyMemberHistory.py 
589
590
591
592
593
594
595
596
597
@model_validator(mode="after")
def FHIR_o_fam_req_2_constraint_validator(self):
    return validate_model_constraint( 
        self,
        expression='date.exists() and date.hasValue()',
        human='The date element is required and must be provided.',
        key='o-fam-req-2',
        severity='error',
    )

FHIR_o_fam_req_3_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerFamilyMemberHistory.py 
599
600
601
602
603
604
605
606
607
@model_validator(mode="after")
def FHIR_o_fam_req_3_constraint_validator(self):
    return validate_model_constraint( 
        self,
        expression='relationship.exists() and relationship.coding.exists()',
        human='The relationship element is required and must be provided.',
        key='o-fam-req-3',
        severity='error',
    )

age_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerFamilyMemberHistory.py 
561
562
563
564
565
566
567
568
@model_validator(mode="after")
def age_type_choice_validator(self):
    return validate_type_choice_element( 
        self,
        field_types=['Age', 'Range', 'String'],
        field_name_base="age",
        required=False,
    )

born_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerFamilyMemberHistory.py 
552
553
554
555
556
557
558
559
@model_validator(mode="after")
def born_type_choice_validator(self):
    return validate_type_choice_element( 
        self,
        field_types=['Period', 'Date', 'String'],
        field_name_base="born",
        required=False,
    )

condition_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerFamilyMemberHistory.py 
545
546
547
548
549
550
@field_validator(*('condition',), mode="after", check_fields=None)
@classmethod
def condition_slicing_cardinality_validator(cls, value):    
    return validate_slicing_cardinalities(cls, value, 
        field_name="condition",
    )

deceased_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerFamilyMemberHistory.py 
570
571
572
573
574
575
576
577
@model_validator(mode="after")
def deceased_type_choice_validator(self):
    return validate_type_choice_element( 
        self,
        field_types=['Boolean'],
        field_name_base="deceased",
        required=False,
    )

OnconovaCancerFamilyMemberHistoryCancerCondition

Bases: FamilyMemberHistoryCondition, FHIRSliceModel

The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

code class-attribute instance-attribute

extension class-attribute instance-attribute

max_cardinality class-attribute

min_cardinality class-attribute

onset property

onsetAge class-attribute instance-attribute

FHIR_code_pattern_constraint(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerFamilyMemberHistory.py 
344
345
346
347
348
349
@field_validator(*('code',), mode="after", check_fields=None)
@classmethod
def FHIR_code_pattern_constraint(cls, value):    
    return validate_FHIR_element_pattern(cls, value, 
        pattern=CodeableConcept(coding=[Coding(code='363346000', display='Malignant neoplastic disease (disorder)', system='http://snomed.info/sct')]),
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerFamilyMemberHistory.py 
337
338
339
340
341
342
@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",
    )

onset_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerFamilyMemberHistory.py 
351
352
353
354
355
356
357
358
@model_validator(mode="after")
def onset_type_choice_validator(self):
    return validate_type_choice_element( 
        self,
        field_types=['Age'],
        field_name_base="onset",
        required=False,
    )

OnconovaCancerFamilyMemberHistoryContributedToDeath

Bases: FamilyMemberConditionContributedToDeath, FHIRSliceModel

May be used to represent additional information that is not part of the basic definition of the element. 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/CancerFamilyMemberHistory.py 
433
434
435
436
437
438
439
440
441
@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/CancerFamilyMemberHistory.py 
443
444
445
446
447
448
449
450
451
@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',
    )

OnconovaCancerFamilyMemberHistoryMorphology

Bases: FamilyMemberHistoryCancerMorphology, FHIRSliceModel

May be used to represent additional information that is not part of the basic definition of the element. 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/CancerFamilyMemberHistory.py 
371
372
373
374
375
376
377
378
379
@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/CancerFamilyMemberHistory.py 
381
382
383
384
385
386
387
388
389
@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',
    )

OnconovaCancerFamilyMemberHistoryOnsetAge

Bases: Age

Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.

code class-attribute instance-attribute

FHIR_code_pattern_constraint(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerFamilyMemberHistory.py 
302
303
304
305
306
307
@field_validator(*('code',), mode="after", check_fields=None)
@classmethod
def FHIR_code_pattern_constraint(cls, value):    
    return validate_FHIR_element_pattern(cls, value, 
        pattern='a',
    )

OnconovaCancerFamilyMemberHistoryTopography

Bases: FamilyMemberHistoryCancerTopography, FHIRSliceModel

May be used to represent additional information that is not part of the basic definition of the element. 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/CancerFamilyMemberHistory.py 
402
403
404
405
406
407
408
409
410
@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/CancerFamilyMemberHistory.py 
412
413
414
415
416
417
418
419
420
@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',
    )
runner