Data Model Libraries
    Preparing search index...

    Class EvidenceVariableCharacteristicDefinitionByCombinationComponent

    EvidenceVariableCharacteristicDefinitionByCombinationComponent Class

    FHIR Specification

    • Short: Used to specify how two or more characteristics are combined
    • Definition: Defines the characteristic as a combination of two or more characteristics.

    Hierarchy (View Summary)

    • BackboneElement
      • EvidenceVariableCharacteristicDefinitionByCombinationComponent

    Implements

    Index

    Constructors

    Properties

    characteristicCombinationEnum: CharacteristicCombinationEnum

    FHIR CodeSystem: CharacteristicCombination

    code: null | EnumCodeType

    EvidenceVariable.characteristic.definitionByCombination.code Element

    FHIR Specification

    • Short: all-of | any-of | at-least | at-most | statistical | net-effect | dataset
    • Definition: Used to specify if two or more characteristics are combined with OR or AND.
    • Requirements: If code is "at-least" or "at-most" then threshold SHALL be used. If code is neither "at-least" nor "at-most" then threshold SHALL NOT be used.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: CharacteristicCombinationEnum

    threshold?: PositiveIntType

    EvidenceVariable.characteristic.definitionByCombination.threshold Element

    FHIR Specification

    • Short: Provides the value of "n" when "at-least" or "at-most" codes are used
    • Definition: Provides the value of "n" when "at-least" or "at-most" codes are used.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    EvidenceVariable.characteristic.definitionByCombination.characteristic Element

    FHIR Specification

    • Short: A defining factor of the characteristic
    • Definition: A defining factor of the characteristic.
    • FHIR Type: BackboneElement
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EvidenceVariableCharacteristicDefinitionByCombinationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | EvidenceVariableCharacteristicDefinitionByCombinationComponent

      EvidenceVariableCharacteristicDefinitionByCombinationComponent data model or undefined for EvidenceVariableCharacteristicDefinitionByCombinationComponent

      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 the instance is a FHIR complex or primitive datatype; false otherwise