Data Model Libraries
    Preparing search index...

    Class EvidenceVariableCharacteristicComponent

    EvidenceVariableCharacteristicComponent Class

    FHIR Specification

    • Short: What defines the members of the evidence element
    • Definition: A characteristic that defines the members of the evidence element. 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 getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getDefinition setDefinition hasDefinition getDefinitionReference hasDefinitionReference getDefinitionCanonicalType hasDefinitionCanonicalType getDefinitionCodeableConcept hasDefinitionCodeableConcept getDefinitionExpression hasDefinitionExpression getDefinitionDataRequirement hasDefinitionDataRequirement getDefinitionTriggerDefinition hasDefinitionTriggerDefinition getUsageContext setUsageContext addUsageContext hasUsageContext getExcludeElement setExcludeElement hasExcludeElement getExclude setExclude hasExclude getParticipantEffective setParticipantEffective hasParticipantEffective getParticipantEffectiveDateTimeType hasParticipantEffectiveDateTimeType getParticipantEffectivePeriod hasParticipantEffectivePeriod getParticipantEffectiveDuration hasParticipantEffectiveDuration getParticipantEffectiveTiming hasParticipantEffectiveTiming getTimeFromStart setTimeFromStart hasTimeFromStart getGroupMeasureEnumType setGroupMeasureEnumType hasGroupMeasureEnumType getGroupMeasureElement setGroupMeasureElement hasGroupMeasureElement getGroupMeasure setGroupMeasure hasGroupMeasure fhirType isEmpty isRequiredFieldsEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initUsageContext

    Constructors

    Properties

    description?: StringType

    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: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    definition: null | IDataType

    EvidenceVariable.characteristic.definition[x] Element

    @ChoiceDataTypesMeta('EvidenceVariable.characteristic.definition[x]', ['Reference','canonical','CodeableConcept','Expression','DataRequirement','TriggerDefinition',]

    FHIR Specification

    • Short: What code or expression defines members?
    • Definition: Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).
    • Requirements: Need to be able to define members in simple codes when the membership aligns well with terminology, with common criteria such as observations in a value set or lab tests within a year, or with expression language to support criteria that do not fit in the above.
    • FHIR Types: 'Reference', 'canonical', 'CodeableConcept', 'Expression', 'DataRequirement', 'TriggerDefinition',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    usageContext?: UsageContext[]

    EvidenceVariable.characteristic.usageContext Element

    FHIR Specification

    • Short: What code/value pairs define members?
    • Definition: Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.
    • Requirements: Need to be able to define members more structurally when more information can be communicated such as age range.
    • FHIR Type: UsageContext
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    exclude?: BooleanType

    EvidenceVariable.characteristic.exclude Element

    FHIR Specification

    • Short: Whether the characteristic includes or excludes members
    • Definition: When true, members with this characteristic are excluded from the element.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    participantEffective?: IDataType

    EvidenceVariable.characteristic.participantEffective[x] Element

    @ChoiceDataTypesMeta('EvidenceVariable.characteristic.participantEffective[x]', ['dateTime','Period','Duration','Timing',]

    FHIR Specification

    • Short: What time period do participants cover
    • Definition: Indicates what effective period the study covers.
    • FHIR Types: 'dateTime', 'Period', 'Duration', 'Timing',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    timeFromStart?: Duration

    EvidenceVariable.characteristic.timeFromStart Element

    FHIR Specification

    • Short: Observation time from study start
    • Definition: Indicates duration from the participant's study entry.
    • FHIR Type: Duration
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    groupMeasureEnum: GroupMeasureEnum

    FHIR CodeSystem: GroupMeasure

    groupMeasure?: EnumCodeType

    EvidenceVariable.characteristic.groupMeasure Element

    FHIR Specification

    • Short: mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
    • Definition: Indicates how elements are aggregated within the study effective period.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: GroupMeasureEnum

    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

    • 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