Data Model Libraries
    Preparing search index...

    Class EvidenceVariableCharacteristicTimeFromStartComponent

    EvidenceVariableCharacteristicTimeFromStartComponent Class

    FHIR Specification

    • Short: Observation time from study start
    • Definition: Indicates duration, period, or point of observation from the participant's study entry.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    description?: StringType

    EvidenceVariable.characteristic.timeFromStart.description Element

    FHIR Specification

    • Short: Human readable description
    • Definition: A short, natural language description.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    quantity?: Quantity

    EvidenceVariable.characteristic.timeFromStart.quantity Element

    FHIR Specification

    • Short: Used to express the observation at a defined amount of time after the study start
    • Definition: Used to express the observation at a defined amount of time after the study start.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    range?: Range

    EvidenceVariable.characteristic.timeFromStart.range Element

    FHIR Specification

    • Short: Used to express the observation within a period after the study start
    • Definition: Used to express the observation within a period after the study start.
    • FHIR Type: Range
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    EvidenceVariable.characteristic.timeFromStart.note Element

    FHIR Specification

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

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EvidenceVariableCharacteristicTimeFromStartComponent

      • OptionaloptSourceField: string

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

      Returns undefined | EvidenceVariableCharacteristicTimeFromStartComponent

      EvidenceVariableCharacteristicTimeFromStartComponent data model or undefined for EvidenceVariableCharacteristicTimeFromStartComponent

      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