Data Model Libraries
    Preparing search index...

    EvidenceStatisticComponent Class

    FHIR Specification

    • Short: Values and parameters for a single statistic
    • Definition: Values and parameters for a single statistic.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    description?: StringType

    Evidence.statistic.description Element

    FHIR Specification

    • Short: Description of content
    • Definition: A description of the content value of the statistic.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    Evidence.statistic.note Element

    FHIR Specification

    • Short: Footnotes and/or explanatory notes
    • Definition: Footnotes and/or explanatory notes.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    statisticType?: CodeableConcept

    Evidence.statistic.statisticType Element

    FHIR Specification

    • Short: Type of statistic, eg relative risk
    • Definition: Type of statistic, eg relative risk.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    category?: CodeableConcept

    Evidence.statistic.category Element

    FHIR Specification

    • Short: Associated category for categorical variable
    • Definition: When the measured variable is handled categorically, the category element is used to define which category the statistic is reporting.
    • Comment: Simple strings can be used for descriptive purposes. Exact matching to EvidenceVariable.category.name for the Evidence.variableDefinition[variableRole=measuredVariable].observed=Reference(EvidenceVariable) could facilitate validation within datasets.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    quantity?: Quantity

    Evidence.statistic.quantity Element

    FHIR Specification

    • Short: Statistic value
    • Definition: Statistic value.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    numberOfEvents?: UnsignedIntType

    Evidence.statistic.numberOfEvents Element

    FHIR Specification

    • Short: The number of events associated with the statistic
    • Definition: The number of events associated with the statistic, where the unit of analysis is different from numberAffected, sampleSize.knownDataCount and sampleSize.numberOfParticipants.
    • Comment: When the number of events is the statistic, use Evidence.statistic.quantity and set Evidence.statistic.type.coding.code=C25463 and Evidence.statistic.type.coding.display=Count. When the statistic is an Event Rate (where individual participants may have 2 or more events), use Evidence.statistic.numberOfEvents to record the total number of events rather than the number of participants with events.
    • FHIR Type: unsignedInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    numberAffected?: UnsignedIntType

    Evidence.statistic.numberAffected Element

    FHIR Specification

    • Short: The number of participants affected
    • Definition: The number of participants affected where the unit of analysis is the same as sampleSize.knownDataCount and sampleSize.numberOfParticipants.
    • Comment: When the number affected is the statistic, use Evidence.statistic.quantity and set Evidence.statistic.type.coding.code=C25463 and Evidence.statistic.type.coding.display=Count. When the statistic is a Proportion, use Evidence.statistic.numberAffected and enter an integer as the value. When the statistic is an Event Rate (where individual participants may have 2 or more events), use Evidence.statistic.numberAffected to record the number of participants with events rather than the total number of events.
    • FHIR Type: unsignedInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Evidence.statistic.sampleSize Element

    FHIR Specification

    • Short: Number of samples in the statistic
    • Definition: Number of samples in the statistic.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Evidence.statistic.attributeEstimate Element

    FHIR Specification

    • Short: An attribute of the Statistic
    • Definition: A statistical attribute of the statistic such as a measure of heterogeneity.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Evidence.statistic.modelCharacteristic Element

    FHIR Specification

    • Short: An aspect of the statistical model
    • Definition: A component of the method to generate the statistic.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EvidenceStatisticComponent

      • OptionaloptSourceField: string

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

      Returns undefined | EvidenceStatisticComponent

      EvidenceStatisticComponent data model or undefined for EvidenceStatisticComponent

      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