Data Model Libraries
    Preparing search index...

    Class EvidenceVariableCharacteristicComponent

    EvidenceVariableCharacteristicComponent Class

    FHIR Specification

    • Short: A defining factor of the EvidenceVariable
    • Definition: A defining factor of the EvidenceVariable. Multiple characteristics are applied with "and" semantics.
    • Comment: Characteristics can be defined flexibly to accommodate different use cases for membership criteria, ranging from simple codes, all the way to using an expression language to express the criteria.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getLinkIdElement setLinkIdElement hasLinkIdElement getLinkId setLinkId hasLinkId getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getNote setNote addNote hasNote getExcludeElement setExcludeElement hasExcludeElement getExclude setExclude hasExclude getDefinitionReference setDefinitionReference hasDefinitionReference getDefinitionCanonicalElement setDefinitionCanonicalElement hasDefinitionCanonicalElement getDefinitionCanonical setDefinitionCanonical hasDefinitionCanonical getDefinitionCodeableConcept setDefinitionCodeableConcept hasDefinitionCodeableConcept getDefinitionExpression setDefinitionExpression hasDefinitionExpression getDefinitionIdElement setDefinitionIdElement hasDefinitionIdElement getDefinitionId setDefinitionId hasDefinitionId getDefinitionByTypeAndValue setDefinitionByTypeAndValue hasDefinitionByTypeAndValue getDefinitionByCombination setDefinitionByCombination hasDefinitionByCombination getInstances setInstances hasInstances getInstancesQuantity hasInstancesQuantity getInstancesRange hasInstancesRange getDuration setDuration hasDuration getDurationQuantity hasDurationQuantity getDurationRange hasDurationRange getTimeFromEvent setTimeFromEvent addTimeFromEvent hasTimeFromEvent 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 initNote initTimeFromEvent

    Constructors

    Properties

    linkId?: IdType

    EvidenceVariable.characteristic.linkId Element

    FHIR Specification

    • Short: Label for internal linking
    • Definition: Label used for when a characteristic refers to another characteristic.
    • FHIR Type: id
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    EvidenceVariable.characteristic.description Element

    FHIR Specification

    • Short: Natural language description of the characteristic
    • Definition: A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.
    • Requirements: Need to be able to describe characteristics in natural language so that end users can understand the criteria.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    EvidenceVariable.characteristic.note Element

    FHIR Specification

    • Short: Used for footnotes or explanatory notes
    • Definition: A human-readable string to clarify or explain concepts about the characteristic.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    exclude?: BooleanType

    EvidenceVariable.characteristic.exclude Element

    FHIR Specification

    • Short: Whether the characteristic is an inclusion criterion or exclusion criterion
    • Definition: When true, this characteristic is an exclusion criterion. In other words, not matching this characteristic definition is equivalent to meeting this criterion.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    definitionReference?: Reference

    EvidenceVariable.characteristic.definitionReference Element

    FHIR Specification

    definitionCanonical?: CanonicalType

    EvidenceVariable.characteristic.definitionCanonical Element

    FHIR Specification

    definitionCodeableConcept?: CodeableConcept

    EvidenceVariable.characteristic.definitionCodeableConcept Element

    FHIR Specification

    • Short: Defines the characteristic (without using type and value) by a CodeableConcept
    • Definition: Defines the characteristic using CodeableConcept.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    definitionExpression?: Expression

    EvidenceVariable.characteristic.definitionExpression Element

    FHIR Specification

    • Short: Defines the characteristic (without using type and value) by an expression
    • Definition: Defines the characteristic using Expression.
    • Comment: When another element provides a definition of the characteristic, the definitionExpression content SHALL match the definition (only adding technical concepts necessary for implementation) without changing the meaning.
    • FHIR Type: Expression
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    definitionId?: IdType

    EvidenceVariable.characteristic.definitionId Element

    FHIR Specification

    • Short: Defines the characteristic (without using type and value) by an id
    • Definition: Defines the characteristic using id.
    • FHIR Type: id
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    EvidenceVariable.characteristic.definitionByTypeAndValue Element

    FHIR Specification

    • Short: Defines the characteristic using type and value
    • Definition: Defines the characteristic using both a type and value[x] elements.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    EvidenceVariable.characteristic.definitionByCombination Element

    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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    instances?: IDataType

    EvidenceVariable.characteristic.instances[x] Element

    @ChoiceDataTypesMeta('EvidenceVariable.characteristic.instances[x]', ['Quantity','Range',]

    FHIR Specification

    • Short: Number of occurrences meeting the characteristic
    • Definition: Number of occurrences meeting the characteristic.
    • FHIR Types: 'Quantity', 'Range',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    duration?: IDataType

    EvidenceVariable.characteristic.duration[x] Element

    @ChoiceDataTypesMeta('EvidenceVariable.characteristic.duration[x]', ['Quantity','Range',]

    FHIR Specification

    • Short: Length of time in which the characteristic is met
    • Definition: Length of time in which the characteristic is met.
    • FHIR Types: 'Quantity', 'Range',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    EvidenceVariable.characteristic.timeFromEvent Element

    FHIR Specification

    • Short: Timing in which the characteristic is determined
    • Definition: Timing in which the characteristic is determined.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EvidenceVariableCharacteristicComponent

      • OptionaloptSourceField: string

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

      Returns undefined | EvidenceVariableCharacteristicComponent

      EvidenceVariableCharacteristicComponent data model or undefined for EvidenceVariableCharacteristicComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided DefinitionReference object value to the definitionReference property.

      Parameters

      • value: undefined | Reference

        the definitionReference object value

      Returns this

      this

      @ReferenceTargets('EvidenceVariable.characteristic.definitionReference', ['EvidenceVariable','Group','Evidence',])

      InvalidTypeError for invalid data type or reference value

    • 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