Data Model Libraries
    Preparing search index...

    Class ObservationDefinitionQualifiedValueComponent

    ObservationDefinitionQualifiedValueComponent Class

    FHIR Specification

    • Short: Set of qualified values for observation results
    • Definition: A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getContext setContext hasContext getAppliesTo setAppliesTo addAppliesTo hasAppliesTo getGenderEnumType setGenderEnumType hasGenderEnumType getGenderElement setGenderElement hasGenderElement getGender setGender hasGender getAge setAge hasAge getGestationalAge setGestationalAge hasGestationalAge getConditionElement setConditionElement hasConditionElement getCondition setCondition hasCondition getRangeCategoryEnumType setRangeCategoryEnumType hasRangeCategoryEnumType getRangeCategoryElement setRangeCategoryElement hasRangeCategoryElement getRangeCategory setRangeCategory hasRangeCategory getRange setRange hasRange getValidCodedValueSetElement setValidCodedValueSetElement hasValidCodedValueSetElement getValidCodedValueSet setValidCodedValueSet hasValidCodedValueSet getNormalCodedValueSetElement setNormalCodedValueSetElement hasNormalCodedValueSetElement getNormalCodedValueSet setNormalCodedValueSet hasNormalCodedValueSet getAbnormalCodedValueSetElement setAbnormalCodedValueSetElement hasAbnormalCodedValueSetElement getAbnormalCodedValueSet setAbnormalCodedValueSet hasAbnormalCodedValueSet getCriticalCodedValueSetElement setCriticalCodedValueSetElement hasCriticalCodedValueSetElement getCriticalCodedValueSet setCriticalCodedValueSet hasCriticalCodedValueSet fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initAppliesTo

    Constructors

    Properties

    context?: CodeableConcept

    ObservationDefinition.qualifiedValue.context Element

    FHIR Specification

    • Short: Context qualifier for the set of qualified values
    • Definition: A concept defining the context for this set of qualified values.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    appliesTo?: CodeableConcept[]

    ObservationDefinition.qualifiedValue.appliesTo Element

    FHIR Specification

    • Short: Targetted population for the set of qualified values
    • Definition: The target population this set of qualified values applies to.
    • Comment: If this element is not present then the global population is assumed.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    administrativeGenderEnum: AdministrativeGenderEnum

    FHIR CodeSystem: AdministrativeGender

    gender?: EnumCodeType

    ObservationDefinition.qualifiedValue.gender Element

    FHIR Specification

    • Short: male | female | other | unknown
    • Definition: The gender this set of qualified values applies to.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: AdministrativeGenderEnum

    age?: Range

    ObservationDefinition.qualifiedValue.age Element

    FHIR Specification

    • Short: Applicable age range for the set of qualified values
    • Definition: The age range this set of qualified values applies to.
    • Comment: Some analytes vary greatly over age.
    • FHIR Type: Range
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    gestationalAge?: Range

    ObservationDefinition.qualifiedValue.gestationalAge Element

    FHIR Specification

    • Short: Applicable gestational age range for the set of qualified values
    • Definition: The gestational age this set of qualified values applies to.
    • FHIR Type: Range
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    condition?: StringType

    ObservationDefinition.qualifiedValue.condition Element

    FHIR Specification

    • Short: Condition associated with the set of qualified values
    • Definition: Text based condition for which the the set of qualified values is valid.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    observationRangeCategoryEnum: ObservationRangeCategoryEnum

    FHIR CodeSystem: ObservationRangeCategory

    rangeCategory?: EnumCodeType

    ObservationDefinition.qualifiedValue.rangeCategory Element

    FHIR Specification

    • Short: reference | critical | absolute
    • Definition: The category of range of values for continuous or ordinal observations that match the criteria of this set of qualified values.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ObservationRangeCategoryEnum

    range?: Range

    ObservationDefinition.qualifiedValue.range Element

    FHIR Specification

    • Short: The range for continuous or ordinal observations
    • Definition: The range of values defined for continuous or ordinal observations that match the criteria of this set of qualified values.
    • Requirements: The unit may be not relevant for ordinal values. In case it is there, it is the same as ObservationDefinition.unit.
    • FHIR Type: Range
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    validCodedValueSet?: CanonicalType

    ObservationDefinition.qualifiedValue.validCodedValueSet Element

    FHIR Specification

    • Short: Value set of valid coded values as part of this set of qualified values
    • Definition: The set of valid coded results for qualitative observations that match the criteria of this set of qualified values.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    normalCodedValueSet?: CanonicalType

    ObservationDefinition.qualifiedValue.normalCodedValueSet Element

    FHIR Specification

    • Short: Value set of normal coded values as part of this set of qualified values
    • Definition: The set of normal coded results for qualitative observations that match the criteria of this set of qualified values.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    abnormalCodedValueSet?: CanonicalType

    ObservationDefinition.qualifiedValue.abnormalCodedValueSet Element

    FHIR Specification

    • Short: Value set of abnormal coded values as part of this set of qualified values
    • Definition: The set of abnormal coded results for qualitative observations that match the criteria of this set of qualified values.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    criticalCodedValueSet?: CanonicalType

    ObservationDefinition.qualifiedValue.criticalCodedValueSet Element

    FHIR Specification

    • Short: Value set of critical coded values as part of this set of qualified values
    • Definition: The set of critical coded results for qualitative observations that match the criteria of this set of qualified values.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided ObservationDefinitionQualifiedValueComponent JSON to instantiate the ObservationDefinitionQualifiedValueComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR ObservationDefinitionQualifiedValueComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ObservationDefinitionQualifiedValueComponent

      Returns undefined | ObservationDefinitionQualifiedValueComponent

      ObservationDefinitionQualifiedValueComponent data model or undefined for ObservationDefinitionQualifiedValueComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise