Skip to content

onconova.interoperability.fhir.models.CancerPatient

NoneType module-attribute

CancerPatient

Bases: USCorePatientProfile

Information about an individual or animal receiving health care services

deceased property

extension class-attribute instance-attribute

FHIR_dom_2_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2222
2223
2224
2225
2226
2227
2228
2229
2230
@model_validator(mode="after")
def FHIR_dom_2_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="contained.contained.empty()",
        human="If the resource is contained in another resource, it SHALL NOT contain nested Resources",
        key="dom-2",
        severity="error",
    )

FHIR_dom_3_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2232
2233
2234
2235
2236
2237
2238
2239
2240
@model_validator(mode="after")
def FHIR_dom_3_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
        human="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
        key="dom-3",
        severity="error",
    )

FHIR_dom_4_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2242
2243
2244
2245
2246
2247
2248
2249
2250
@model_validator(mode="after")
def FHIR_dom_4_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
        human="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
        key="dom-4",
        severity="error",
    )

FHIR_dom_5_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2252
2253
2254
2255
2256
2257
2258
2259
2260
@model_validator(mode="after")
def FHIR_dom_5_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="contained.meta.security.empty()",
        human="If a resource is contained in another resource, it SHALL NOT have a security label",
        key="dom-5",
        severity="error",
    )

FHIR_dom_6_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2262
2263
2264
2265
2266
2267
2268
2269
2270
@model_validator(mode="after")
def FHIR_dom_6_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="text.`div`.exists()",
        human="A resource should have narrative for robust management",
        key="dom-6",
        severity="warning",
    )

deceased_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2272
2273
2274
2275
2276
2277
2278
2279
@model_validator(mode="after")
def deceased_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["Boolean", "DateTime"],
        field_name_base="deceased",
        required=False,
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2213
2214
2215
2216
2217
2218
2219
2220
@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",
    )

CancerPatientAge

Bases: Extension

The approximate age of the patient.

extension class-attribute instance-attribute

url class-attribute instance-attribute

value property

valueInteger class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3153
3154
3155
3156
3157
3158
3159
3160
3161
@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/CancerPatient.py 
3135
3136
3137
3138
3139
3140
3141
3142
@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-cancer-patient-age",
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3126
3127
3128
3129
3130
3131
3132
3133
@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/CancerPatient.py 
3144
3145
3146
3147
3148
3149
3150
3151
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["Integer"],
        field_name_base="value",
        required=False,
    )

CancerPatientAgeAtDiagnosis

Bases: Extension

The approximate age of the patient at the time of diagnosis of the disease.

extension class-attribute instance-attribute

url class-attribute instance-attribute

value property

valueInteger class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3230
3231
3232
3233
3234
3235
3236
3237
3238
@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/CancerPatient.py 
3212
3213
3214
3215
3216
3217
3218
3219
@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-cancer-patient-age-at-diagnosis",
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3203
3204
3205
3206
3207
3208
3209
3210
@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/CancerPatient.py 
3221
3222
3223
3224
3225
3226
3227
3228
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["Integer"],
        field_name_base="value",
        required=False,
    )

CancerPatientBirthsex

Bases: Extension, 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

CancerPatientCauseOfDeath

Bases: Extension

The cause of death for the patient.

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/CancerPatient.py 
3419
3420
3421
3422
3423
3424
3425
3426
3427
@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/CancerPatient.py 
3401
3402
3403
3404
3405
3406
3407
3408
@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-cancer-patient-cause-of-death",
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3392
3393
3394
3395
3396
3397
3398
3399
@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/CancerPatient.py 
3410
3411
3412
3413
3414
3415
3416
3417
@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,
    )

CancerPatientClinicalCenter

Bases: Extension

The center or hospital where the patient case original records were recorded.

extension class-attribute instance-attribute

url class-attribute instance-attribute

value property

valueString class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2469
2470
2471
2472
2473
2474
2475
2476
2477
@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/CancerPatient.py 
2451
2452
2453
2454
2455
2456
2457
2458
@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-cancer-patient-clinical-center",
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2442
2443
2444
2445
2446
2447
2448
2449
@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/CancerPatient.py 
2460
2461
2462
2463
2464
2465
2466
2467
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["String"],
        field_name_base="value",
        required=False,
    )

CancerPatientConsentStatus

Bases: Extension

The status of whether the patient has given or revoked consent for research use.

extension class-attribute instance-attribute

url class-attribute instance-attribute

value property

valueCode class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2392
2393
2394
2395
2396
2397
2398
2399
2400
@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/CancerPatient.py 
2374
2375
2376
2377
2378
2379
2380
2381
@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-cancer-patient-consent-status",
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2365
2366
2367
2368
2369
2370
2371
2372
@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/CancerPatient.py 
2383
2384
2385
2386
2387
2388
2389
2390
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["Code"],
        field_name_base="value",
        required=False,
    )

CancerPatientDataCompletionRate

Bases: Extension

The percentage of data elements categories that have been completed for a patient.

extension class-attribute instance-attribute

url class-attribute instance-attribute

value property

valueDecimal class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2625
2626
2627
2628
2629
2630
2631
2632
2633
@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/CancerPatient.py 
2607
2608
2609
2610
2611
2612
2613
2614
@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-cancer-patient-data-completion-rate",
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2598
2599
2600
2601
2602
2603
2604
2605
@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/CancerPatient.py 
2616
2617
2618
2619
2620
2621
2622
2623
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["Decimal"],
        field_name_base="value",
        required=False,
    )

CancerPatientDataContributors

Bases: Extension

The individuals or organizations that contributed to the patient's case data collection.

extension class-attribute instance-attribute

url class-attribute instance-attribute

value property

valueReference class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2704
2705
2706
2707
2708
2709
2710
2711
2712
@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/CancerPatient.py 
2686
2687
2688
2689
2690
2691
2692
2693
@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-cancer-patient-data-contributors",
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2677
2678
2679
2680
2681
2682
2683
2684
@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/CancerPatient.py 
2695
2696
2697
2698
2699
2700
2701
2702
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["Reference"],
        field_name_base="value",
        required=False,
    )

CancerPatientEndOfRecords

Bases: Extension

Indicates the last known record date of a patient.

extension class-attribute instance-attribute

url class-attribute instance-attribute

value property

valueDate class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2781
2782
2783
2784
2785
2786
2787
2788
2789
@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/CancerPatient.py 
2763
2764
2765
2766
2767
2768
2769
2770
@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-cancer-patient-end-of-records",
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2754
2755
2756
2757
2758
2759
2760
2761
@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/CancerPatient.py 
2772
2773
2774
2775
2776
2777
2778
2779
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["Date"],
        field_name_base="value",
        required=False,
    )

CancerPatientOverallSurvival

Bases: Extension

The duration of time from either the date of diagnosis or the start of treatment for a disease, such as cancer, that patients diagnosed with the disease are still alive. In a clinical trial, measuring the overall survival is one way to see how well a new treatment works.

extension class-attribute instance-attribute

url class-attribute instance-attribute

value property

valueDuration class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2546
2547
2548
2549
2550
2551
2552
2553
2554
@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/CancerPatient.py 
2528
2529
2530
2531
2532
2533
2534
2535
@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-cancer-patient-overall-survival",
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2519
2520
2521
2522
2523
2524
2525
2526
@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/CancerPatient.py 
2537
2538
2539
2540
2541
2542
2543
2544
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["Duration"],
        field_name_base="value",
        required=False,
    )

CancerPatientVitalStatus

Bases: Extension

The status of whether the patient is alive or deceased or unknown.

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/CancerPatient.py 
3342
3343
3344
3345
3346
3347
3348
3349
3350
@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/CancerPatient.py 
3324
3325
3326
3327
3328
3329
3330
3331
@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-cancer-patient-vital-status",
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3315
3316
3317
3318
3319
3320
3321
3322
@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/CancerPatient.py 
3333
3334
3335
3336
3337
3338
3339
3340
@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,
    )

DataAbsentReason

Bases: Extension

Provides a reason why the expected value or elements in the element that is extended are missing.

extension class-attribute instance-attribute

url class-attribute instance-attribute

value property

valueCode class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2953
2954
2955
2956
2957
2958
2959
2960
2961
@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/CancerPatient.py 
2935
2936
2937
2938
2939
2940
2941
2942
@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://hl7.org/fhir/StructureDefinition/data-absent-reason",
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2926
2927
2928
2929
2930
2931
2932
2933
@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/CancerPatient.py 
2944
2945
2946
2947
2948
2949
2950
2951
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["Code"],
        field_name_base="value",
        required=True,
    )

OnconovaCancerPatient

Bases: CancerPatient

Information about an individual or animal receiving health care services

address class-attribute instance-attribute

birthDate class-attribute instance-attribute

communication class-attribute instance-attribute

contact class-attribute instance-attribute

deceased property

deceasedDateTime class-attribute instance-attribute

extension class-attribute instance-attribute

generalPractitioner class-attribute instance-attribute

identifier class-attribute instance-attribute

maritalStatus class-attribute instance-attribute

name class-attribute instance-attribute

photo class-attribute instance-attribute

telecom class-attribute instance-attribute

FHIR_o_pat_req_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3615
3616
3617
3618
3619
3620
3621
3622
3623
@model_validator(mode="after")
def FHIR_o_pat_req_1_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="identifier.where(type.coding.code = 'ACSN' and system = 'Onconova').exists()",
        human="The identifier element must contain the identifier for the Onconova logical pseudoidentifier slice.",
        key="o-pat-req-1",
        severity="error",
    )

FHIR_o_pat_req_2_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3625
3626
3627
3628
3629
3630
3631
3632
3633
@model_validator(mode="after")
def FHIR_o_pat_req_2_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="identifier.where(type.coding.code = 'MR').exists(system.exists() and value.exists())",
        human="The identifier element must contain the identifier for the clinical center's patient identifier slice.",
        key="o-pat-req-2",
        severity="error",
    )

FHIR_o_pat_req_3_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3635
3636
3637
3638
3639
3640
3641
3642
3643
@model_validator(mode="after")
def FHIR_o_pat_req_3_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="gender.exists()",
        human="The gender element is required and must be provided",
        key="o-pat-req-3",
        severity="error",
    )

FHIR_o_pat_req_4_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3645
3646
3647
3648
3649
3650
3651
3652
3653
@model_validator(mode="after")
def FHIR_o_pat_req_4_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="birthDate.exists() and birthDate.hasValue()",
        human="The birthDate element is required and must be provided",
        key="o-pat-req-4",
        severity="error",
    )

FHIR_o_pat_req_6_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3666
3667
3668
3669
3670
3671
3672
3673
3674
@model_validator(mode="after")
def FHIR_o_pat_req_6_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="deceasedDateTime.extension('http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.coding.code = '419099009' implies (deceasedDateTime.hasValue() and deceasedDateTime.extension('http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-cause-of-death').valueCodeableConcept.exists())",
        human="If the patient is deceased, the date of death and cause of death must be provided.",
        key="o-pat-req-6",
        severity="error",
    )

FHIR_o_pat_req_7_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3676
3677
3678
3679
3680
3681
3682
3683
3684
@model_validator(mode="after")
def FHIR_o_pat_req_7_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="deceasedDateTime.extension('http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.coding.code = '261665006' implies extension('http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-end-of-records').valueDate.hasValue()",
        human="If the patient vital status is unknown, the end of records must be provided.",
        key="o-pat-req-7",
        severity="error",
    )

FHIR_pat_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
@model_validator(mode="after")
def FHIR_pat_1_constraint_validator(self):
    return validate_element_constraint(
        self,
        elements="contact",
        expression="name.exists() or telecom.exists() or address.exists() or organization.exists()",
        human="SHALL at least contain a contact's details or a reference to an organization",
        key="pat-1",
        severity="error",
    )

FHIR_us_core_6_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
@model_validator(mode="after")
def FHIR_us_core_6_constraint_validator(self):
    return validate_element_constraint(
        self,
        elements="name",
        expression="(family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()",
        human="At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.",
        key="us-core-6",
        severity="error",
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3566
3567
3568
3569
3570
3571
3572
3573
@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",
    )

identifier_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3575
3576
3577
3578
3579
3580
3581
3582
@field_validator(*("identifier",), mode="after", check_fields=None)
@classmethod
def identifier_slicing_cardinality_validator(cls, value):
    return validate_slicing_cardinalities(
        cls,
        value,
        field_name="identifier",
    )

OnconovaCancerPatientAge

Bases: CancerPatientAge, 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

OnconovaCancerPatientAgeAtDiagnosis

Bases: CancerPatientAgeAtDiagnosis, 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

OnconovaCancerPatientAnonymizedEntry

Bases: DataAbsentReason, 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

value property

valueString class-attribute instance-attribute

FHIR_valueMeta_pattern_constraint(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2984
2985
2986
2987
2988
2989
2990
2991
@field_validator(*("valueMeta",), mode="after", check_fields=None)
@classmethod
def FHIR_valueMeta_pattern_constraint(cls, value):
    return validate_FHIR_element_pattern(
        cls,
        value,
        pattern="masked",
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=[
            "Base64Binary",
            "Boolean",
            "Canonical",
            "Code",
            "Date",
            "DateTime",
            "Decimal",
            "Id",
            "Instant",
            "Integer",
            "Markdown",
            "Oid",
            "PositiveInt",
            "String",
            "Time",
            "UnsignedInt",
            "Uri",
            "Url",
            "Uuid",
            "Address",
            "Age",
            "Annotation",
            "Attachment",
            "CodeableConcept",
            "Coding",
            "ContactPoint",
            "Count",
            "Distance",
            "Duration",
            "HumanName",
            "Identifier",
            "Money",
            "Period",
            "Quantity",
            "Range",
            "Ratio",
            "Reference",
            "SampledData",
            "Signature",
            "Timing",
            "ContactDetail",
            "Contributor",
            "DataRequirement",
            "Expression",
            "ParameterDefinition",
            "RelatedArtifact",
            "TriggerDefinition",
            "UsageContext",
            "Dosage",
            "Meta",
        ],
        field_name_base="value",
        required=False,
    )

OnconovaCancerPatientBirthDate

Bases: Date

The date of birth for the individual.

extension class-attribute instance-attribute

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3277
3278
3279
3280
3281
3282
3283
3284
@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",
    )

OnconovaCancerPatientBirthsex

Bases: Extension, 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

OnconovaCancerPatientCauseOfDeath

Bases: CancerPatientCauseOfDeath, 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

OnconovaCancerPatientClinicalCenter

Bases: CancerPatientClinicalCenter, 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

OnconovaCancerPatientClinicalIdentifier

Bases: USCorePatientProfileIdentifier, FHIRSliceModel

An identifier for this patient.

max_cardinality class-attribute

min_cardinality class-attribute

type class-attribute instance-attribute

FHIR_type_pattern_constraint(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
@field_validator(*("type",), mode="after", check_fields=None)
@classmethod
def FHIR_type_pattern_constraint(cls, value):
    return validate_FHIR_element_pattern(
        cls,
        value,
        pattern=CodeableConcept(
            coding=[
                Coding(
                    code="MR",
                    display="Medical Record Number",
                    system="http://terminology.hl7.org/CodeSystem/v2-0203",
                )
            ]
        ),
    )

OnconovaCancerPatientConsentStatus

Bases: CancerPatientConsentStatus, 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

OnconovaCancerPatientContributors

Bases: CancerPatientDataContributors, 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

OnconovaCancerPatientDataCompletionRate

Bases: CancerPatientDataCompletionRate, 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

OnconovaCancerPatientDeceasedDateTime

Bases: DateTime

Indicates if the individual is deceased or not.

extension class-attribute instance-attribute

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3459
3460
3461
3462
3463
3464
3465
3466
@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",
    )

OnconovaCancerPatientEndOfRecords

Bases: CancerPatientEndOfRecords, 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

OnconovaCancerPatientGenderIdentity

Bases: Extension, 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

OnconovaCancerPatientName

Bases: USCorePatientProfileName

Not used in this profile

extension class-attribute instance-attribute

FHIR_us_core_6_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3087
3088
3089
3090
3091
3092
3093
3094
3095
@model_validator(mode="after")
def FHIR_us_core_6_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="(family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()",
        human="At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.",
        key="us-core-6",
        severity="error",
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
3078
3079
3080
3081
3082
3083
3084
3085
@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",
    )

OnconovaCancerPatientOnconovaIdentifier

Bases: USCorePatientProfileIdentifier, FHIRSliceModel

An identifier for this patient.

max_cardinality class-attribute

min_cardinality class-attribute

system class-attribute instance-attribute

type class-attribute instance-attribute

FHIR_system_pattern_constraint(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2847
2848
2849
2850
2851
2852
2853
2854
@field_validator(*("system",), mode="after", check_fields=None)
@classmethod
def FHIR_system_pattern_constraint(cls, value):
    return validate_FHIR_element_pattern(
        cls,
        value,
        pattern="Onconova",
    )

FHIR_type_pattern_constraint(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
@field_validator(*("type",), mode="after", check_fields=None)
@classmethod
def FHIR_type_pattern_constraint(cls, value):
    return validate_FHIR_element_pattern(
        cls,
        value,
        pattern=CodeableConcept(
            coding=[
                Coding(
                    code="ACSN",
                    display="Accession Identifier",
                    system="http://terminology.hl7.org/CodeSystem/v2-0203",
                )
            ]
        ),
    )

OnconovaCancerPatientOverallSurvival

Bases: CancerPatientOverallSurvival, 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

OnconovaCancerPatientRace

Bases: Extension, 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

OnconovaCancerPatientSex

Bases: Extension, FHIRSliceModel

Not used in this profile

max_cardinality class-attribute

min_cardinality class-attribute

OnconovaCancerPatientTribalAffiliation

Bases: Extension, FHIRSliceModel

Not used in this profile

max_cardinality class-attribute

min_cardinality class-attribute

OnconovaCancerPatientVitalStatus

Bases: CancerPatientVitalStatus, 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

USCoreBirthSexExtension

Bases: Extension

A code classifying the person's sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC).

url class-attribute instance-attribute

value property

valueCode class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
1695
1696
1697
1698
1699
1700
1701
1702
1703
@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/CancerPatient.py 
1677
1678
1679
1680
1681
1682
1683
1684
@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://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
1686
1687
1688
1689
1690
1691
1692
1693
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["Code"],
        field_name_base="value",
        required=True,
    )

USCoreEthnicityExtension

Bases: Extension

Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the CDC ethnicity and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.

extension class-attribute instance-attribute

url class-attribute instance-attribute

value property

valueAddress class-attribute instance-attribute

valueAge class-attribute instance-attribute

valueAnnotation class-attribute instance-attribute

valueAttachment class-attribute instance-attribute

valueBase64Binary class-attribute instance-attribute

valueBoolean class-attribute instance-attribute

valueCanonical class-attribute instance-attribute

valueCode class-attribute instance-attribute

valueCodeableConcept class-attribute instance-attribute

valueCoding class-attribute instance-attribute

valueContactDetail class-attribute instance-attribute

valueContactPoint class-attribute instance-attribute

valueContributor class-attribute instance-attribute

valueCount class-attribute instance-attribute

valueDataRequirement class-attribute instance-attribute

valueDate class-attribute instance-attribute

valueDateTime class-attribute instance-attribute

valueDecimal class-attribute instance-attribute

valueDistance class-attribute instance-attribute

valueDosage class-attribute instance-attribute

valueDuration class-attribute instance-attribute

valueExpression class-attribute instance-attribute

valueHumanName class-attribute instance-attribute

valueId class-attribute instance-attribute

valueIdentifier class-attribute instance-attribute

valueInstant class-attribute instance-attribute

valueInteger class-attribute instance-attribute

valueMarkdown class-attribute instance-attribute

valueMeta class-attribute instance-attribute

valueMoney class-attribute instance-attribute

valueOid class-attribute instance-attribute

valueParameterDefinition class-attribute instance-attribute

valuePeriod class-attribute instance-attribute

valuePositiveInt class-attribute instance-attribute

valueQuantity class-attribute instance-attribute

valueRange class-attribute instance-attribute

valueRatio class-attribute instance-attribute

valueReference class-attribute instance-attribute

valueRelatedArtifact class-attribute instance-attribute

valueSampledData class-attribute instance-attribute

valueSignature class-attribute instance-attribute

valueString class-attribute instance-attribute

valueTime class-attribute instance-attribute

valueTiming class-attribute instance-attribute

valueTriggerDefinition class-attribute instance-attribute

valueUnsignedInt class-attribute instance-attribute

valueUri class-attribute instance-attribute

valueUrl class-attribute instance-attribute

valueUsageContext class-attribute instance-attribute

valueUuid class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
1129
1130
1131
1132
1133
1134
1135
1136
1137
@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/CancerPatient.py 
1060
1061
1062
1063
1064
1065
1066
1067
@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://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
1051
1052
1053
1054
1055
1056
1057
1058
@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/CancerPatient.py 
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=[
            "Base64Binary",
            "Boolean",
            "Canonical",
            "Code",
            "Date",
            "DateTime",
            "Decimal",
            "Id",
            "Instant",
            "Integer",
            "Markdown",
            "Oid",
            "PositiveInt",
            "String",
            "Time",
            "UnsignedInt",
            "Uri",
            "Url",
            "Uuid",
            "Address",
            "Age",
            "Annotation",
            "Attachment",
            "CodeableConcept",
            "Coding",
            "ContactPoint",
            "Count",
            "Distance",
            "Duration",
            "HumanName",
            "Identifier",
            "Money",
            "Period",
            "Quantity",
            "Range",
            "Ratio",
            "Reference",
            "SampledData",
            "Signature",
            "Timing",
            "ContactDetail",
            "Contributor",
            "DataRequirement",
            "Expression",
            "ParameterDefinition",
            "RelatedArtifact",
            "TriggerDefinition",
            "UsageContext",
            "Dosage",
            "Meta",
        ],
        field_name_base="value",
        required=False,
    )

USCoreEthnicityExtensionDetailed

Bases: Extension, FHIRSliceModel

The 41 CDC ethnicity codes that are grouped under one of the 2 OMB ethnicity category codes.

max_cardinality class-attribute

min_cardinality class-attribute

url class-attribute instance-attribute

value property

valueCoding class-attribute instance-attribute

FHIR_ele_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
725
726
727
728
729
730
731
732
733
@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/CancerPatient.py 
744
745
746
747
748
749
750
751
752
@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/CancerPatient.py 
716
717
718
719
720
721
722
723
@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="detailed",
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
735
736
737
738
739
740
741
742
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["Coding"],
        field_name_base="value",
        required=True,
    )

USCoreEthnicityExtensionOmbCategory

Bases: Extension, FHIRSliceModel

The 2 ethnicity category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.

max_cardinality class-attribute

min_cardinality class-attribute

url class-attribute instance-attribute

value property

valueCoding class-attribute instance-attribute

FHIR_ele_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
662
663
664
665
666
667
668
669
670
@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/CancerPatient.py 
681
682
683
684
685
686
687
688
689
@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/CancerPatient.py 
653
654
655
656
657
658
659
660
@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="ombCategory",
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
672
673
674
675
676
677
678
679
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["Coding"],
        field_name_base="value",
        required=True,
    )

USCoreEthnicityExtensionText

Bases: Extension, FHIRSliceModel

Plain text representation of the ethnicity concept(s).

max_cardinality class-attribute

min_cardinality class-attribute

url class-attribute instance-attribute

value property

valueString class-attribute instance-attribute

FHIR_ele_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
788
789
790
791
792
793
794
795
796
@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/CancerPatient.py 
807
808
809
810
811
812
813
814
815
@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/CancerPatient.py 
779
780
781
782
783
784
785
786
@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="text",
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
798
799
800
801
802
803
804
805
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["String"],
        field_name_base="value",
        required=True,
    )

USCoreGenderIdentityExtension

Bases: Extension

An individual's personal sense of being a man, woman, boy, girl, nonbinary, or something else.

url class-attribute instance-attribute

value property

valueCodeableConcept class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
1865
1866
1867
1868
1869
1870
1871
1872
1873
@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/CancerPatient.py 
1847
1848
1849
1850
1851
1852
1853
1854
@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://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity",
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
1856
1857
1858
1859
1860
1861
1862
1863
@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,
    )

USCorePatientProfile

Bases: Patient

Information about an individual or animal receiving health care services

address class-attribute instance-attribute

birthDate class-attribute instance-attribute

communication class-attribute instance-attribute

deceased property

deceasedBoolean class-attribute instance-attribute

deceasedDateTime class-attribute instance-attribute

extension class-attribute instance-attribute

gender class-attribute instance-attribute

identifier class-attribute instance-attribute

name class-attribute instance-attribute

telecom class-attribute instance-attribute

FHIR_dom_2_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2097
2098
2099
2100
2101
2102
2103
2104
2105
@model_validator(mode="after")
def FHIR_dom_2_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="contained.contained.empty()",
        human="If the resource is contained in another resource, it SHALL NOT contain nested Resources",
        key="dom-2",
        severity="error",
    )

FHIR_dom_3_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2107
2108
2109
2110
2111
2112
2113
2114
2115
@model_validator(mode="after")
def FHIR_dom_3_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
        human="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
        key="dom-3",
        severity="error",
    )

FHIR_dom_4_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2117
2118
2119
2120
2121
2122
2123
2124
2125
@model_validator(mode="after")
def FHIR_dom_4_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
        human="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
        key="dom-4",
        severity="error",
    )

FHIR_dom_5_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2127
2128
2129
2130
2131
2132
2133
2134
2135
@model_validator(mode="after")
def FHIR_dom_5_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="contained.meta.security.empty()",
        human="If a resource is contained in another resource, it SHALL NOT have a security label",
        key="dom-5",
        severity="error",
    )

FHIR_dom_6_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2137
2138
2139
2140
2141
2142
2143
2144
2145
@model_validator(mode="after")
def FHIR_dom_6_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="text.`div`.exists()",
        human="A resource should have narrative for robust management",
        key="dom-6",
        severity="warning",
    )

FHIR_us_core_6_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
@model_validator(mode="after")
def FHIR_us_core_6_constraint_validator(self):
    return validate_element_constraint(
        self,
        elements="name",
        expression="(family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()",
        human="At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.",
        key="us-core-6",
        severity="error",
    )

deceased_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2147
2148
2149
2150
2151
2152
2153
2154
@model_validator(mode="after")
def deceased_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["Boolean", "DateTime"],
        field_name_base="deceased",
        required=False,
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
2088
2089
2090
2091
2092
2093
2094
2095
@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",
    )

USCorePatientProfileAddress

Bases: Address

An address for the individual.

city class-attribute instance-attribute

line class-attribute instance-attribute

period class-attribute instance-attribute

postalCode class-attribute instance-attribute

state class-attribute instance-attribute

use class-attribute instance-attribute

USCorePatientProfileBirthsex

Bases: USCoreBirthSexExtension, 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/CancerPatient.py 
1716
1717
1718
1719
1720
1721
1722
1723
1724
@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/CancerPatient.py 
1726
1727
1728
1729
1730
1731
1732
1733
1734
@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",
    )

USCorePatientProfileCommunication

Bases: PatientCommunication

A language which may be used to communicate with the patient about his or her health.

language class-attribute instance-attribute

USCorePatientProfileEthnicity

Bases: USCoreEthnicityExtension, 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/CancerPatient.py 
1150
1151
1152
1153
1154
1155
1156
1157
1158
@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/CancerPatient.py 
1160
1161
1162
1163
1164
1165
1166
1167
1168
@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",
    )

USCorePatientProfileGenderIdentity

Bases: USCoreGenderIdentityExtension, 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/CancerPatient.py 
1886
1887
1888
1889
1890
1891
1892
1893
1894
@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/CancerPatient.py 
1896
1897
1898
1899
1900
1901
1902
1903
1904
@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",
    )

USCorePatientProfileIdentifier

Bases: Identifier

An identifier for this patient.

system class-attribute instance-attribute

value class-attribute instance-attribute

USCorePatientProfileName

Bases: HumanName

A name associated with the individual.

family class-attribute instance-attribute

given class-attribute instance-attribute

period class-attribute instance-attribute

suffix class-attribute instance-attribute

use class-attribute instance-attribute

FHIR_us_core_6_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
1948
1949
1950
1951
1952
1953
1954
1955
1956
@model_validator(mode="after")
def FHIR_us_core_6_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="(family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()",
        human="At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.",
        key="us-core-6",
        severity="error",
    )

USCorePatientProfileRace

Bases: USCoreRaceExtension, 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/CancerPatient.py 
608
609
610
611
612
613
614
615
616
@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/CancerPatient.py 
618
619
620
621
622
623
624
625
626
@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",
    )

USCorePatientProfileSex

Bases: USCoreSexExtension, 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/CancerPatient.py 
1800
1801
1802
1803
1804
1805
1806
1807
1808
@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/CancerPatient.py 
1810
1811
1812
1813
1814
1815
1816
1817
1818
@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",
    )

USCorePatientProfileTelecom

Bases: ContactPoint

A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

system class-attribute instance-attribute

use class-attribute instance-attribute

value class-attribute instance-attribute

USCorePatientProfileTribalAffiliation

Bases: USCoreTribalAffiliationExtension, 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/CancerPatient.py 
1632
1633
1634
1635
1636
1637
1638
1639
1640
@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/CancerPatient.py 
1642
1643
1644
1645
1646
1647
1648
1649
1650
@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",
    )

USCoreRaceExtension

Bases: Extension

Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the CDC Race and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:

  • American Indian or Alaska Native
  • Asian
  • Black or African American
  • Native Hawaiian or Other Pacific Islander
  • White.

extension class-attribute instance-attribute

url class-attribute instance-attribute

value property

valueAddress class-attribute instance-attribute

valueAge class-attribute instance-attribute

valueAnnotation class-attribute instance-attribute

valueAttachment class-attribute instance-attribute

valueBase64Binary class-attribute instance-attribute

valueBoolean class-attribute instance-attribute

valueCanonical class-attribute instance-attribute

valueCode class-attribute instance-attribute

valueCodeableConcept class-attribute instance-attribute

valueCoding class-attribute instance-attribute

valueContactDetail class-attribute instance-attribute

valueContactPoint class-attribute instance-attribute

valueContributor class-attribute instance-attribute

valueCount class-attribute instance-attribute

valueDataRequirement class-attribute instance-attribute

valueDate class-attribute instance-attribute

valueDateTime class-attribute instance-attribute

valueDecimal class-attribute instance-attribute

valueDistance class-attribute instance-attribute

valueDosage class-attribute instance-attribute

valueDuration class-attribute instance-attribute

valueExpression class-attribute instance-attribute

valueHumanName class-attribute instance-attribute

valueId class-attribute instance-attribute

valueIdentifier class-attribute instance-attribute

valueInstant class-attribute instance-attribute

valueInteger class-attribute instance-attribute

valueMarkdown class-attribute instance-attribute

valueMeta class-attribute instance-attribute

valueMoney class-attribute instance-attribute

valueOid class-attribute instance-attribute

valueParameterDefinition class-attribute instance-attribute

valuePeriod class-attribute instance-attribute

valuePositiveInt class-attribute instance-attribute

valueQuantity class-attribute instance-attribute

valueRange class-attribute instance-attribute

valueRatio class-attribute instance-attribute

valueReference class-attribute instance-attribute

valueRelatedArtifact class-attribute instance-attribute

valueSampledData class-attribute instance-attribute

valueSignature class-attribute instance-attribute

valueString class-attribute instance-attribute

valueTime class-attribute instance-attribute

valueTiming class-attribute instance-attribute

valueTriggerDefinition class-attribute instance-attribute

valueUnsignedInt class-attribute instance-attribute

valueUri class-attribute instance-attribute

valueUrl class-attribute instance-attribute

valueUsageContext class-attribute instance-attribute

valueUuid class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
587
588
589
590
591
592
593
594
595
@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/CancerPatient.py 
518
519
520
521
522
523
524
525
@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://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
509
510
511
512
513
514
515
516
@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/CancerPatient.py 
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=[
            "Base64Binary",
            "Boolean",
            "Canonical",
            "Code",
            "Date",
            "DateTime",
            "Decimal",
            "Id",
            "Instant",
            "Integer",
            "Markdown",
            "Oid",
            "PositiveInt",
            "String",
            "Time",
            "UnsignedInt",
            "Uri",
            "Url",
            "Uuid",
            "Address",
            "Age",
            "Annotation",
            "Attachment",
            "CodeableConcept",
            "Coding",
            "ContactPoint",
            "Count",
            "Distance",
            "Duration",
            "HumanName",
            "Identifier",
            "Money",
            "Period",
            "Quantity",
            "Range",
            "Ratio",
            "Reference",
            "SampledData",
            "Signature",
            "Timing",
            "ContactDetail",
            "Contributor",
            "DataRequirement",
            "Expression",
            "ParameterDefinition",
            "RelatedArtifact",
            "TriggerDefinition",
            "UsageContext",
            "Dosage",
            "Meta",
        ],
        field_name_base="value",
        required=False,
    )

USCoreRaceExtensionDetailed

Bases: Extension, FHIRSliceModel

The 900+ CDC race codes that are grouped under one of the 5 OMB race category codes:.

max_cardinality class-attribute

min_cardinality class-attribute

url class-attribute instance-attribute

value property

valueCoding class-attribute instance-attribute

FHIR_ele_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
177
178
179
180
181
182
183
184
185
@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/CancerPatient.py 
196
197
198
199
200
201
202
203
204
@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/CancerPatient.py 
168
169
170
171
172
173
174
175
@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="detailed",
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
187
188
189
190
191
192
193
194
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["Coding"],
        field_name_base="value",
        required=True,
    )

USCoreRaceExtensionOmbCategory

Bases: Extension, FHIRSliceModel

The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.

max_cardinality class-attribute

min_cardinality class-attribute

url class-attribute instance-attribute

value property

valueCoding class-attribute instance-attribute

FHIR_ele_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
114
115
116
117
118
119
120
121
122
@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/CancerPatient.py 
133
134
135
136
137
138
139
140
141
@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/CancerPatient.py 
105
106
107
108
109
110
111
112
@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="ombCategory",
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
124
125
126
127
128
129
130
131
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["Coding"],
        field_name_base="value",
        required=True,
    )

USCoreRaceExtensionText

Bases: Extension, FHIRSliceModel

Plain text representation of the race concept(s).

max_cardinality class-attribute

min_cardinality class-attribute

url class-attribute instance-attribute

value property

valueString class-attribute instance-attribute

FHIR_ele_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
240
241
242
243
244
245
246
247
248
@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/CancerPatient.py 
259
260
261
262
263
264
265
266
267
@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/CancerPatient.py 
231
232
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="text",
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
250
251
252
253
254
255
256
257
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["String"],
        field_name_base="value",
        required=True,
    )

USCoreSexExtension

Bases: Extension

The US Core Sex Extension is used to reflect the documentation of a person's sex. It aligns with the C-CDA Sex Observation (LOINC 46098-0).

url class-attribute instance-attribute

value property

valueCode class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
1779
1780
1781
1782
1783
1784
1785
1786
1787
@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/CancerPatient.py 
1761
1762
1763
1764
1765
1766
1767
1768
@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://hl7.org/fhir/us/core/StructureDefinition/us-core-sex",
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
1770
1771
1772
1773
1774
1775
1776
1777
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["Code"],
        field_name_base="value",
        required=True,
    )

USCoreTribalAffiliationExtension

Bases: Extension

A tribe or band with which a person associates whether or not they are an enrolled member.

extension class-attribute instance-attribute

url class-attribute instance-attribute

value property

valueAddress class-attribute instance-attribute

valueAge class-attribute instance-attribute

valueAnnotation class-attribute instance-attribute

valueAttachment class-attribute instance-attribute

valueBase64Binary class-attribute instance-attribute

valueBoolean class-attribute instance-attribute

valueCanonical class-attribute instance-attribute

valueCode class-attribute instance-attribute

valueCodeableConcept class-attribute instance-attribute

valueCoding class-attribute instance-attribute

valueContactDetail class-attribute instance-attribute

valueContactPoint class-attribute instance-attribute

valueContributor class-attribute instance-attribute

valueCount class-attribute instance-attribute

valueDataRequirement class-attribute instance-attribute

valueDate class-attribute instance-attribute

valueDateTime class-attribute instance-attribute

valueDecimal class-attribute instance-attribute

valueDistance class-attribute instance-attribute

valueDosage class-attribute instance-attribute

valueDuration class-attribute instance-attribute

valueExpression class-attribute instance-attribute

valueHumanName class-attribute instance-attribute

valueId class-attribute instance-attribute

valueIdentifier class-attribute instance-attribute

valueInstant class-attribute instance-attribute

valueInteger class-attribute instance-attribute

valueMarkdown class-attribute instance-attribute

valueMeta class-attribute instance-attribute

valueMoney class-attribute instance-attribute

valueOid class-attribute instance-attribute

valueParameterDefinition class-attribute instance-attribute

valuePeriod class-attribute instance-attribute

valuePositiveInt class-attribute instance-attribute

valueQuantity class-attribute instance-attribute

valueRange class-attribute instance-attribute

valueRatio class-attribute instance-attribute

valueReference class-attribute instance-attribute

valueRelatedArtifact class-attribute instance-attribute

valueSampledData class-attribute instance-attribute

valueSignature class-attribute instance-attribute

valueString class-attribute instance-attribute

valueTime class-attribute instance-attribute

valueTiming class-attribute instance-attribute

valueTriggerDefinition class-attribute instance-attribute

valueUnsignedInt class-attribute instance-attribute

valueUri class-attribute instance-attribute

valueUrl class-attribute instance-attribute

valueUsageContext class-attribute instance-attribute

valueUuid class-attribute instance-attribute

FHIR_ext_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
1609
1610
1611
1612
1613
1614
1615
1616
1617
@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/CancerPatient.py 
1540
1541
1542
1543
1544
1545
1546
1547
@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://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation",
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
1531
1532
1533
1534
1535
1536
1537
1538
@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/CancerPatient.py 
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=[
            "Base64Binary",
            "Boolean",
            "Canonical",
            "Code",
            "Date",
            "DateTime",
            "Decimal",
            "Id",
            "Instant",
            "Integer",
            "Markdown",
            "Oid",
            "PositiveInt",
            "String",
            "Time",
            "UnsignedInt",
            "Uri",
            "Url",
            "Uuid",
            "Address",
            "Age",
            "Annotation",
            "Attachment",
            "CodeableConcept",
            "Coding",
            "ContactPoint",
            "Count",
            "Distance",
            "Duration",
            "HumanName",
            "Identifier",
            "Money",
            "Period",
            "Quantity",
            "Range",
            "Ratio",
            "Reference",
            "SampledData",
            "Signature",
            "Timing",
            "ContactDetail",
            "Contributor",
            "DataRequirement",
            "Expression",
            "ParameterDefinition",
            "RelatedArtifact",
            "TriggerDefinition",
            "UsageContext",
            "Dosage",
            "Meta",
        ],
        field_name_base="value",
        required=False,
    )

USCoreTribalAffiliationExtensionIsEnrolled

Bases: Extension, FHIRSliceModel

Whether the individual is an enrolled tribe member

max_cardinality class-attribute

min_cardinality class-attribute

url class-attribute instance-attribute

value property

valueBoolean class-attribute instance-attribute

FHIR_ele_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
1267
1268
1269
1270
1271
1272
1273
1274
1275
@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/CancerPatient.py 
1286
1287
1288
1289
1290
1291
1292
1293
1294
@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/CancerPatient.py 
1258
1259
1260
1261
1262
1263
1264
1265
@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="isEnrolled",
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
1277
1278
1279
1280
1281
1282
1283
1284
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["Boolean"],
        field_name_base="value",
        required=True,
    )

USCoreTribalAffiliationExtensionTribalAffiliation

Bases: Extension, FHIRSliceModel

Affiliated tribe or band name

max_cardinality class-attribute

min_cardinality class-attribute

url class-attribute instance-attribute

value property

valueCodeableConcept class-attribute instance-attribute

FHIR_ele_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
1204
1205
1206
1207
1208
1209
1210
1211
1212
@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/CancerPatient.py 
1223
1224
1225
1226
1227
1228
1229
1230
1231
@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/CancerPatient.py 
1195
1196
1197
1198
1199
1200
1201
1202
@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="tribalAffiliation",
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/CancerPatient.py 
1214
1215
1216
1217
1218
1219
1220
1221
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["CodeableConcept"],
        field_name_base="value",
        required=True,
    )
runner