Skip to content

onconova.interoperability.fhir.models.SurgicalProcedure

NoneType module-attribute

BodyLocationQualifier

Bases: Extension

Qualifier to refine an body location. These include qualifiers for relative location, directionality, number, and plane, and exclude qualifiers for laterality.

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/SurgicalProcedure.py 
228
229
230
231
232
233
234
235
236
@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/SurgicalProcedure.py 
212
213
214
215
216
217
@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/mcode/StructureDefinition/mcode-body-location-qualifier',
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/SurgicalProcedure.py 
205
206
207
208
209
210
@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/SurgicalProcedure.py 
219
220
221
222
223
224
225
226
@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,
    )

CancerRelatedSurgicalProcedure

Bases: USCoreProcedureProfile

An action that is being or was performed on a patient

bodySite class-attribute instance-attribute

extension class-attribute instance-attribute

reasonCode class-attribute instance-attribute

reasonReference class-attribute instance-attribute

subject class-attribute instance-attribute

FHIR_mcode_reason_required_constraint_validator()

Source code in onconova/interoperability/fhir/models/SurgicalProcedure.py 
376
377
378
379
380
381
382
383
384
@model_validator(mode="after")
def FHIR_mcode_reason_required_constraint_validator(self):
    return validate_model_constraint( 
        self,
        expression='reasonCode.exists() or reasonReference.exists()',
        human='One of reasonCode or reasonReference SHALL be present',
        key='mcode-reason-required',
        severity='warning',
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/SurgicalProcedure.py 
369
370
371
372
373
374
@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",
    )

CancerRelatedSurgicalProcedureBodySite

Bases: CodeableConcept

Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.

extension class-attribute instance-attribute

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/SurgicalProcedure.py 
333
334
335
336
337
338
@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",
    )

CancerRelatedSurgicalProcedureLateralityQualifier

Bases: LateralityQualifier, FHIRSliceModel

Laterality qualifier for this bodySite

max_cardinality class-attribute

min_cardinality class-attribute

CancerRelatedSurgicalProcedureLocationQualifier

Bases: BodyLocationQualifier, FHIRSliceModel

General location qualifier (excluding laterality) for this bodySite

max_cardinality class-attribute

min_cardinality class-attribute

CancerRelatedSurgicalProcedureTreatmentIntent

Bases: ProcedureIntent, 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/SurgicalProcedure.py 
157
158
159
160
161
162
163
164
165
@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/SurgicalProcedure.py 
167
168
169
170
171
172
173
174
175
@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',
    )

LateralityQualifier

Bases: Extension

Qualifier to specify laterality.

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/SurgicalProcedure.py 
300
301
302
303
304
305
306
307
308
@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/SurgicalProcedure.py 
284
285
286
287
288
289
@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/mcode/StructureDefinition/mcode-laterality-qualifier',
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/SurgicalProcedure.py 
277
278
279
280
281
282
@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/SurgicalProcedure.py 
291
292
293
294
295
296
297
298
@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,
    )

OnconovaSurgicalProcedure

Bases: CancerRelatedSurgicalProcedure

An action that is being or was performed on a patient

asserter class-attribute instance-attribute

basedOn class-attribute instance-attribute

complication class-attribute instance-attribute

complicationDetail class-attribute instance-attribute

encounter class-attribute instance-attribute

extension class-attribute instance-attribute

focalDevice class-attribute instance-attribute

followUp class-attribute instance-attribute

location class-attribute instance-attribute

outcome class-attribute instance-attribute

partOf class-attribute instance-attribute

performed property

performer class-attribute instance-attribute

reasonCode class-attribute instance-attribute

reasonReference class-attribute instance-attribute

recorder class-attribute instance-attribute

report class-attribute instance-attribute

status class-attribute instance-attribute

statusReason class-attribute instance-attribute

usedCode class-attribute instance-attribute

usedReference class-attribute instance-attribute

FHIR_o_sur_req_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/SurgicalProcedure.py 
834
835
836
837
838
839
840
841
842
@model_validator(mode="after")
def FHIR_o_sur_req_1_constraint_validator(self):
    return validate_model_constraint( 
        self,
        expression='subject.exists()',
        human='The subject element is required and must be provided.',
        key='o-sur-req-1',
        severity='error',
    )

FHIR_o_sur_req_2_constraint_validator()

Source code in onconova/interoperability/fhir/models/SurgicalProcedure.py 
844
845
846
847
848
849
850
851
852
@model_validator(mode="after")
def FHIR_o_sur_req_2_constraint_validator(self):
    return validate_model_constraint( 
        self,
        expression='performedDateTime.exists() and performedDateTime.hasValue()',
        human='The performedDateTime element is required and must be provided.',
        key='o-sur-req-2',
        severity='error',
    )

FHIR_o_sur_req_3_constraint_validator()

Source code in onconova/interoperability/fhir/models/SurgicalProcedure.py 
854
855
856
857
858
859
860
861
862
@model_validator(mode="after")
def FHIR_o_sur_req_3_constraint_validator(self):
    return validate_model_constraint( 
        self,
        expression='code.exists() and code.coding.exists()',
        human='The code element is required and must be provided.',
        key='o-sur-req-3',
        severity='error',
    )

FHIR_o_sur_req_4_constraint_validator()

Source code in onconova/interoperability/fhir/models/SurgicalProcedure.py 
864
865
866
867
868
869
870
871
872
@model_validator(mode="after")
def FHIR_o_sur_req_4_constraint_validator(self):
    return validate_model_constraint( 
        self,
        expression="extension('http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-procedure-intent').exists()",
        human='The treatmentIntent extension is required and must be provided.',
        key='o-sur-req-4',
        severity='error',
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/SurgicalProcedure.py 
818
819
820
821
822
823
@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",
    )

performed_type_choice_validator()

Source code in onconova/interoperability/fhir/models/SurgicalProcedure.py 
825
826
827
828
829
830
831
832
@model_validator(mode="after")
def performed_type_choice_validator(self):
    return validate_type_choice_element( 
        self,
        field_types=['DateTime'],
        field_name_base="performed",
        required=False,
    )

OnconovaSurgicalProcedureTherapyLine

Bases: TherapyLineReference, 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/SurgicalProcedure.py 
703
704
705
706
707
708
709
710
711
@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/SurgicalProcedure.py 
713
714
715
716
717
718
719
720
721
@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',
    )

OnconovaSurgicalProcedureTreatmentIntent

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

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_ele_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/SurgicalProcedure.py 
602
603
604
605
606
607
608
609
610
@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/SurgicalProcedure.py 
621
622
623
624
625
626
627
628
629
@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',
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/SurgicalProcedure.py 
612
613
614
615
616
617
618
619
@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,
    )

ProcedureIntent

Bases: Extension

The purpose of a treatment, medication, or procedure.

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/SurgicalProcedure.py 
136
137
138
139
140
141
142
143
144
@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/SurgicalProcedure.py 
120
121
122
123
124
125
@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/mcode/StructureDefinition/mcode-procedure-intent',
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/SurgicalProcedure.py 
113
114
115
116
117
118
@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/SurgicalProcedure.py 
127
128
129
130
131
132
133
134
@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,
    )

TherapyLineReference

Bases: Extension

A reference to the therapy line associated with this treatment.

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/SurgicalProcedure.py 
682
683
684
685
686
687
688
689
690
@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/SurgicalProcedure.py 
666
667
668
669
670
671
@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-therapy-line-reference',
    )

extension_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/SurgicalProcedure.py 
659
660
661
662
663
664
@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/SurgicalProcedure.py 
673
674
675
676
677
678
679
680
@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,
    )

USCoreProcedureProfile

Bases: Procedure

An action that is being or was performed on a patient

basedOn class-attribute instance-attribute

code class-attribute instance-attribute

performed property

performedAge class-attribute instance-attribute

performedDateTime class-attribute instance-attribute

performedPeriod class-attribute instance-attribute

performedRange class-attribute instance-attribute

performedString class-attribute instance-attribute

status class-attribute instance-attribute

subject class-attribute instance-attribute

FHIR_us_core_7_constraint_validator()

Source code in onconova/interoperability/fhir/models/SurgicalProcedure.py 
75
76
77
78
79
80
81
82
83
@model_validator(mode="after")
def FHIR_us_core_7_constraint_validator(self):
    return validate_model_constraint( 
        self,
        expression="(status='completed' or status='in-progress') implies performed.exists()",
        human="Performed SHALL be present if the status is 'completed' or 'in-progress'",
        key='us-core-7',
        severity='error',
    )

performed_type_choice_validator()

Source code in onconova/interoperability/fhir/models/SurgicalProcedure.py 
66
67
68
69
70
71
72
73
@model_validator(mode="after")
def performed_type_choice_validator(self):
    return validate_type_choice_element( 
        self,
        field_types=['DateTime', 'Period', 'String', 'Age', 'Range'],
        field_name_base="performed",
        required=False,
    )
runner