Data Model Libraries
    Preparing search index...

    Class SampledData

    SampledData Class

    Base StructureDefinition for SampledData Type: A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.

    There is a need for a concise way to handle the data produced by devices that sample a physical state at a high frequency.

    FHIR Specification

    • Short: A series of measurements taken by a device
    • Definition: A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
    • Comment: The data is not interpretable without at least origin, period, and dimensions, but these are optional to allow a separation between the template of measurement and the actual measurement, such as between DeviceCapabilities and DeviceLog. When providing a summary view (for example with Observation.value[x]) SampledData should be represented with a brief display text such as "Sampled Data".
    • FHIR Version: 4.3.0

    FHIR SampledData

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    origin period factor? lowerLimit? upperLimit? dimensions data?

    Methods

    parse getOrigin setOrigin hasOrigin getPeriodElement setPeriodElement hasPeriodElement getPeriod setPeriod hasPeriod getFactorElement setFactorElement hasFactorElement getFactor setFactor hasFactor getLowerLimitElement setLowerLimitElement hasLowerLimitElement getLowerLimit setLowerLimit hasLowerLimit getUpperLimitElement setUpperLimitElement hasUpperLimitElement getUpperLimit setUpperLimit hasUpperLimit getDimensionsElement setDimensionsElement hasDimensionsElement getDimensions setDimensions hasDimensions getDataElement setDataElement hasDataElement getData setData hasData fhirType isEmpty isRequiredFieldsEmpty copy isComplexDataType dataTypeName toJSON isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues

    Constructors

    Properties

    origin: null | Quantity

    SampledData.origin Element

    FHIR Specification

    • Short: Zero value and units
    • Definition: The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.
    • FHIR Type: Quantity
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    period: null | DecimalType

    SampledData.period Element

    FHIR Specification

    • Short: Number of milliseconds between samples
    • Definition: The length of time between sampling times, measured in milliseconds.
    • Comment: This is usually a whole number.
    • FHIR Type: decimal
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    factor?: DecimalType

    SampledData.factor Element

    FHIR Specification

    • Short: Multiply data by this before adding to origin
    • Definition: A correction factor that is applied to the sampled data points before they are added to the origin.
    • FHIR Type: decimal
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    lowerLimit?: DecimalType

    SampledData.lowerLimit Element

    FHIR Specification

    • Short: Lower limit of detection
    • Definition: The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).
    • FHIR Type: decimal
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    upperLimit?: DecimalType

    SampledData.upperLimit Element

    FHIR Specification

    • Short: Upper limit of detection
    • Definition: The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).
    • FHIR Type: decimal
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    dimensions: null | PositiveIntType

    SampledData.dimensions Element

    FHIR Specification

    • Short: Number of sample points at each time point
    • Definition: The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.
    • Comment: If there is more than one dimension, the code for the type of data will define the meaning of the dimensions (typically ECG data).
    • FHIR Type: positiveInt
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    data?: StringType

    SampledData.data Element

    FHIR Specification

    • Short: Decimal values with spaces, or "E" | "U" | "L"
    • Definition: A series of data points which are decimal values separated by a single space (character u20). The special values "E" (error), "L" (below detection limit) and "U" (above detection limit) can also be used in place of a decimal value.
    • Comment: Data may be missing if it is omitted for summarization purposes. In general, data is required for any actual use of a SampledData.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SampledData

      • OptionaloptSourceField: string

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

      Returns undefined | SampledData

      SampledData data model or undefined for SampledData

      JsonError if the provided JSON is not a valid JSON object

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    • 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

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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 resource; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive boolean datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive string-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive number-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive bigint-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datetime-based datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetOriginsetOriginhasOrigingetPeriodElementsetPeriodElementhasPeriodElementgetPeriodsetPeriodhasPeriodgetFactorElementsetFactorElementhasFactorElementgetFactorsetFactorhasFactorgetLowerLimitElementsetLowerLimitElementhasLowerLimitElementgetLowerLimitsetLowerLimithasLowerLimitgetUpperLimitElementsetUpperLimitElementhasUpperLimitElementgetUpperLimitsetUpperLimithasUpperLimitgetDimensionsElementsetDimensionsElementhasDimensionsElementgetDimensionssetDimensionshasDimensionsgetDataElementsetDataElementhasDataElementgetDatasetDatahasDatafhirTypeisEmptyisRequiredFieldsEmptycopyisComplexDataTypedataTypeNametoJSONisDataTypegetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisResourceisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValues