Skip to content

onconova.interoperability.fhir.models.VitalSignsPanel

NoneType module-attribute

ObservationVitalsigns

Bases: Observation

The FHIR Vitals Signs profile sets minimum expectations for the Observation Resource to record, search and fetch the vital signs associated with a patient.

category class-attribute instance-attribute

code class-attribute instance-attribute

component class-attribute instance-attribute

dataAbsentReason class-attribute instance-attribute

derivedFrom class-attribute instance-attribute

effective property

effectiveDateTime class-attribute instance-attribute

effectivePeriod class-attribute instance-attribute

hasMember class-attribute instance-attribute

status class-attribute instance-attribute

subject class-attribute instance-attribute

value property

valueBoolean class-attribute instance-attribute

valueCodeableConcept class-attribute instance-attribute

valueDateTime class-attribute instance-attribute

valueInteger class-attribute instance-attribute

valuePeriod class-attribute instance-attribute

valueQuantity class-attribute instance-attribute

valueRange class-attribute instance-attribute

valueRatio class-attribute instance-attribute

valueSampledData class-attribute instance-attribute

valueString class-attribute instance-attribute

valueTime class-attribute instance-attribute

FHIR_vs_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
335
336
337
338
339
340
341
342
343
344
@model_validator(mode="after")
def FHIR_vs_1_constraint_validator(self):
    return validate_element_constraint(
        self,
        elements="effectivePeriod",
        expression="($this as dateTime).toString().length() >= 8",
        human="if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day",
        key="vs-1",
        severity="error",
    )

FHIR_vs_2_constraint_validator()

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
357
358
359
360
361
362
363
364
365
@model_validator(mode="after")
def FHIR_vs_2_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())",
        human="If there is no component or hasMember element then either a value[x] or a data absent reason must be present.",
        key="vs-2",
        severity="error",
    )

FHIR_vs_3_constraint_validator()

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
346
347
348
349
350
351
352
353
354
355
@model_validator(mode="after")
def FHIR_vs_3_constraint_validator(self):
    return validate_element_constraint(
        self,
        elements="component",
        expression="value.exists() or dataAbsentReason.exists()",
        human="If there is no a value a data absent reason must be present",
        key="vs-3",
        severity="error",
    )

category_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
296
297
298
299
300
301
302
303
@field_validator(*("category",), mode="after", check_fields=None)
@classmethod
def category_slicing_cardinality_validator(cls, value):
    return validate_slicing_cardinalities(
        cls,
        value,
        field_name="category",
    )

effective_type_choice_validator()

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
305
306
307
308
309
310
311
312
@model_validator(mode="after")
def effective_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["DateTime", "Period"],
        field_name_base="effective",
        required=True,
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=[
            "Quantity",
            "CodeableConcept",
            "String",
            "Boolean",
            "Integer",
            "Range",
            "Ratio",
            "SampledData",
            "Time",
            "DateTime",
            "Period",
        ],
        field_name_base="value",
        required=False,
    )

ObservationVitalsignsCoding

Bases: Coding

A reference to a code defined by a terminology system.

code class-attribute instance-attribute

system class-attribute instance-attribute

FHIR_code_fixed_value_constraint(value) classmethod

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
66
67
68
69
70
71
72
73
@field_validator(*("code",), mode="after", check_fields=None)
@classmethod
def FHIR_code_fixed_value_constraint(cls, value):
    return validate_FHIR_element_fixed_value(
        cls,
        value,
        constant="vital-signs",
    )

FHIR_system_fixed_value_constraint(value) classmethod

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
57
58
59
60
61
62
63
64
@field_validator(*("system",), mode="after", check_fields=None)
@classmethod
def FHIR_system_fixed_value_constraint(cls, value):
    return validate_FHIR_element_fixed_value(
        cls,
        value,
        constant="http://terminology.hl7.org/CodeSystem/observation-category",
    )

ObservationVitalsignsComponent

Bases: ObservationComponent

Used when reporting systolic and diastolic blood pressure.

code class-attribute instance-attribute

dataAbsentReason class-attribute instance-attribute

value property

valueBoolean class-attribute instance-attribute

valueCodeableConcept class-attribute instance-attribute

valueDateTime class-attribute instance-attribute

valueInteger class-attribute instance-attribute

valuePeriod class-attribute instance-attribute

valueQuantity class-attribute instance-attribute

valueRange class-attribute instance-attribute

valueRatio class-attribute instance-attribute

valueSampledData class-attribute instance-attribute

valueString class-attribute instance-attribute

valueTime class-attribute instance-attribute

FHIR_vs_3_constraint_validator()

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
176
177
178
179
180
181
182
183
184
@model_validator(mode="after")
def FHIR_vs_3_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="value.exists() or dataAbsentReason.exists()",
        human="If there is no a value a data absent reason must be present",
        key="vs-3",
        severity="error",
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=[
            "Quantity",
            "CodeableConcept",
            "String",
            "Boolean",
            "Integer",
            "Range",
            "Ratio",
            "SampledData",
            "Time",
            "DateTime",
            "Period",
        ],
        field_name_base="value",
        required=False,
    )

ObservationVitalsignsVSCat

Bases: CodeableConcept, FHIRSliceModel

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

coding class-attribute instance-attribute

max_cardinality class-attribute

min_cardinality class-attribute

ObservationVitalspanel

Bases: ObservationVitalsigns

This profile defines the top-level grouping structure for a set of vital signs. It has no value in Observation.valueQuantity ; instead, it just includes related links (with type=has-member) to the Observations in this set (e.g. respiratory rate, heart rate, BP).

code class-attribute instance-attribute

hasMember class-attribute instance-attribute

value property

valueBoolean class-attribute instance-attribute

valueCodeableConcept class-attribute instance-attribute

valueDateTime class-attribute instance-attribute

valueInteger class-attribute instance-attribute

valuePeriod class-attribute instance-attribute

valueQuantity class-attribute instance-attribute

valueRange class-attribute instance-attribute

valueRatio class-attribute instance-attribute

valueSampledData class-attribute instance-attribute

valueString class-attribute instance-attribute

valueTime class-attribute instance-attribute

FHIR_vs_2_constraint_validator()

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
514
515
516
517
518
519
520
521
522
@model_validator(mode="after")
def FHIR_vs_2_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())",
        human="If there is no component or hasMember element then either a value[x] or a data absent reason must be present.",
        key="vs-2",
        severity="error",
    )

value_type_choice_validator()

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
@model_validator(mode="after")
def value_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=[
            "Quantity",
            "CodeableConcept",
            "String",
            "Boolean",
            "Integer",
            "Range",
            "Ratio",
            "SampledData",
            "Time",
            "DateTime",
            "Period",
        ],
        field_name_base="value",
        required=False,
    )

ObservationVitalspanelCode

Bases: CodeableConcept

Vital Signs Panel.

coding class-attribute instance-attribute

coding_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
416
417
418
419
420
421
422
423
@field_validator(*("coding",), mode="after", check_fields=None)
@classmethod
def coding_slicing_cardinality_validator(cls, value):
    return validate_slicing_cardinalities(
        cls,
        value,
        field_name="coding",
    )

ObservationVitalspanelVitalsPanelCode

Bases: Coding, FHIRSliceModel

A reference to a code defined by a terminology system.

code class-attribute instance-attribute

max_cardinality class-attribute

min_cardinality class-attribute

system class-attribute instance-attribute

FHIR_code_fixed_value_constraint(value) classmethod

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
394
395
396
397
398
399
400
401
@field_validator(*("code",), mode="after", check_fields=None)
@classmethod
def FHIR_code_fixed_value_constraint(cls, value):
    return validate_FHIR_element_fixed_value(
        cls,
        value,
        constant="85353-1",
    )

FHIR_system_fixed_value_constraint(value) classmethod

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
385
386
387
388
389
390
391
392
@field_validator(*("system",), mode="after", check_fields=None)
@classmethod
def FHIR_system_fixed_value_constraint(cls, value):
    return validate_FHIR_element_fixed_value(
        cls,
        value,
        constant="http://loinc.org",
    )

OnconovaVitalSignsPanel

Bases: ObservationVitalspanel

This profile defines the top-level grouping structure for a set of vital signs. It has no value in Observation.valueQuantity ; instead, it just includes related links (with type=has-member) to the Observations in this set (e.g. respiratory rate, heart rate, BP).

bodySite class-attribute instance-attribute

code class-attribute instance-attribute

component class-attribute instance-attribute

device class-attribute instance-attribute

effective property

encounter class-attribute instance-attribute

focus class-attribute instance-attribute

hasMember class-attribute instance-attribute

interpretation class-attribute instance-attribute

issued class-attribute instance-attribute

performer class-attribute instance-attribute

referenceRange class-attribute instance-attribute

specimen class-attribute instance-attribute

status class-attribute instance-attribute

FHIR_code_pattern_constraint(value) classmethod

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
651
652
653
654
655
656
657
658
659
660
@field_validator(*("code",), mode="after", check_fields=None)
@classmethod
def FHIR_code_pattern_constraint(cls, value):
    return validate_FHIR_element_pattern(
        cls,
        value,
        pattern=CodeableConcept(
            coding=[Coding(code="85353-1", system="http://loinc.org")]
        ),
    )

FHIR_o_vit_req_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
713
714
715
716
717
718
719
720
721
@model_validator(mode="after")
def FHIR_o_vit_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-vit-req-1",
        severity="error",
    )

FHIR_o_vit_req_2_constraint_validator()

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
723
724
725
726
727
728
729
730
731
@model_validator(mode="after")
def FHIR_o_vit_req_2_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="effectiveDateTime.exists() and effectiveDateTime.hasValue()",
        human="The effectiveDateTime element is required and must be provided.",
        key="o-vit-req-2",
        severity="error",
    )

FHIR_o_vit_req_3_constraint_validator()

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
733
734
735
736
737
738
739
740
741
@model_validator(mode="after")
def FHIR_o_vit_req_3_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="hasMember.exists() and hasMember.count() > 0",
        human="At least one vital sign profile must be referenced.",
        key="o-vit-req-3",
        severity="error",
    )

FHIR_o_vit_req_4_constraint_validator()

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
743
744
745
746
747
748
749
750
751
@model_validator(mode="after")
def FHIR_o_vit_req_4_constraint_validator(self):
    return validate_model_constraint(
        self,
        expression="value.exists().not()",
        human="The value[x] element must not be set for the vitals panel.",
        key="o-vit-req-4",
        severity="error",
    )

FHIR_obs_3_constraint_validator()

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
680
681
682
683
684
685
686
687
688
689
@model_validator(mode="after")
def FHIR_obs_3_constraint_validator(self):
    return validate_element_constraint(
        self,
        elements="referenceRange",
        expression="low.exists() or high.exists() or text.exists()",
        human="Must have at least a low or a high or text",
        key="obs-3",
        severity="error",
    )

FHIR_vs_1_constraint_validator()

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
691
692
693
694
695
696
697
698
699
700
@model_validator(mode="after")
def FHIR_vs_1_constraint_validator(self):
    return validate_element_constraint(
        self,
        elements="effectiveDateTime",
        expression="($this as dateTime).toString().length() >= 8",
        human="if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day",
        key="vs-1",
        severity="error",
    )

FHIR_vs_3_constraint_validator()

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
702
703
704
705
706
707
708
709
710
711
@model_validator(mode="after")
def FHIR_vs_3_constraint_validator(self):
    return validate_element_constraint(
        self,
        elements="component",
        expression="value.exists() or dataAbsentReason.exists()",
        human="If there is no a value a data absent reason must be present",
        key="vs-3",
        severity="error",
    )

effective_type_choice_validator()

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
671
672
673
674
675
676
677
678
@model_validator(mode="after")
def effective_type_choice_validator(self):
    return validate_type_choice_element(
        self,
        field_types=["DateTime"],
        field_name_base="effective",
        required=True,
    )

hasMember_slicing_cardinality_validator(value) classmethod

Source code in onconova/interoperability/fhir/models/VitalSignsPanel.py 
662
663
664
665
666
667
668
669
@field_validator(*("hasMember",), mode="after", check_fields=None)
@classmethod
def hasMember_slicing_cardinality_validator(cls, value):
    return validate_slicing_cardinalities(
        cls,
        value,
        field_name="hasMember",
    )

OnconovaVitalSignsPanelBloodPressure

Bases: Reference, FHIRSliceModel

Used when reporting vital signs panel components.

max_cardinality class-attribute

min_cardinality class-attribute

OnconovaVitalSignsPanelBmi

Bases: Reference, FHIRSliceModel

Used when reporting vital signs panel components.

max_cardinality class-attribute

min_cardinality class-attribute

OnconovaVitalSignsPanelBodyHeight

Bases: Reference, FHIRSliceModel

Used when reporting vital signs panel components.

max_cardinality class-attribute

min_cardinality class-attribute

OnconovaVitalSignsPanelBodyTemperature

Bases: Reference, FHIRSliceModel

Used when reporting vital signs panel components.

max_cardinality class-attribute

min_cardinality class-attribute

OnconovaVitalSignsPanelBodyWeight

Bases: Reference, FHIRSliceModel

Used when reporting vital signs panel components.

max_cardinality class-attribute

min_cardinality class-attribute

runner