Class SampledData

SampledData Class

Remarks

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: 5.0.0

See

FHIR SampledData

Hierarchy (View Summary)

DataType
- SampledData

Implements

IDataType

Index

Constructors

constructor

new SampledData(
    origin?: null | Quantity,
    intervalUnit?: null | string | CodeType,
    dimensions?: null | number | PositiveIntType,
): SampledData
Parameters
- origin: null | Quantity = null
- intervalUnit: null | string | CodeType = null
- dimensions: null | number | PositiveIntType = null
Returns SampledData
Overrides DataType.constructor
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35775

Properties

`Private`origin

origin: null | Quantity

SampledData.origin Element

Remarks

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

`Private` `Optional`interval

interval?: DecimalType

SampledData.interval Element

Remarks

FHIR Specification

Short: Number of intervalUnits between samples
Definition: Amount of intervalUnits between samples, e.g. milliseconds for time-based sampling.
Comment: This is usually a whole number.
FHIR Type: decimal
Cardinality: 0..1
isModifier: false
isSummary: true

`Private`intervalUnit

intervalUnit: null | CodeType

SampledData.intervalUnit Element

Remarks

FHIR Specification

Short: The measurement unit of the interval between samples
Definition: The measurement unit in which the sample interval is expressed.
FHIR Type: code
Cardinality: 1..1
isModifier: false
isSummary: true

`Private` `Optional`factor

factor?: DecimalType

SampledData.factor Element

Remarks

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

`Private` `Optional`lowerLimit

lowerLimit?: DecimalType

SampledData.lowerLimit Element

Remarks

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

`Private` `Optional`upperLimit

upperLimit?: DecimalType

SampledData.upperLimit Element

Remarks

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

`Private`dimensions

dimensions: null | PositiveIntType

SampledData.dimensions Element

Remarks

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

`Private` `Optional`codeMap

codeMap?: CanonicalType

SampledData.codeMap Element

Remarks

FHIR Specification

Short: Defines the codes used in the data
Definition: Reference to ConceptMap that defines the codes used in the data.
Comment: The ConceptMap cannot define meanings for the codes 'E', 'U', or 'L' (nor 'e', 'u', or 'l').
FHIR Type: canonical
- TargetProfiles: [ 'http://hl7.org/fhir/StructureDefinition/ConceptMap', ]
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`offsets

offsets?: StringType

SampledData.offsets Element

Remarks

FHIR Specification

Short: Offsets, typically in time, at which data values were taken
Definition: A series of data points which are decimal values separated by a single space (character u20). The units in which the offsets are expressed are found in intervalUnit. The absolute point at which the measurements begin SHALL be conveyed outside the scope of this datatype, e.g. Observation.effectiveDateTime for a timing offset.
Comment: If offsets is present, the number of data points must be equal to the number of offsets mlutipled by the dimensions.
FHIR Type: string
Cardinality: 0..1
isModifier: false
isSummary: false

`Private` `Optional`data

data?: StringType

SampledData.data Element

Remarks

FHIR Specification

Short: Decimal values with spaces, or "E" | "U" | "L", or another code
Definition: A series of data points which are decimal values or codes separated by a single space (character u20). The special codes "E" (error), "L" (below detection limit) and "U" (above detection limit) are also defined for used in place of decimal values.
Comment: The 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

`Static`parse

parse(sourceJson: Value, optSourceField?: string): undefined | SampledData
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

Throws
JsonError if the provided JSON is not a valid JSON object
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:35810

getOrigin

getOrigin(): Quantity
Returns Quantity
the origin property value as a Quantity object if defined; else an empty Quantity object
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36089

setOrigin

setOrigin(value: undefined | null | Quantity): this
Assigns the provided Quantity object value to the origin property.
Parameters
- value: undefined | null | Quantity
  the origin object value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36100

hasOrigin

hasOrigin(): boolean
Returns boolean
true if the origin property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36114

getIntervalElement

getIntervalElement(): DecimalType
Returns DecimalType
the interval property value as a DecimalType object if defined; else an empty DecimalType object
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36121

setIntervalElement

setIntervalElement(element: undefined | DecimalType): this
Assigns the provided PrimitiveType value to the interval property.
Parameters
- element: undefined | DecimalType
  the interval value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36133

hasIntervalElement

hasIntervalElement(): boolean
Returns boolean
true if the interval property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36147

getInterval

getInterval(): undefined | number
Returns undefined | number
the interval property value as a fhirDecimal if defined; else undefined
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36154

setInterval

setInterval(value: undefined | number): this
Assigns the provided primitive value to the interval property.
Parameters
- value: undefined | number
  the interval value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36165

hasInterval

hasInterval(): boolean
Returns boolean
true if the interval property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36178

getIntervalUnitElement

getIntervalUnitElement(): CodeType
Returns CodeType
the intervalUnit property value as a CodeType object if defined; else an empty CodeType object
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36185

setIntervalUnitElement

setIntervalUnitElement(element: undefined | null | CodeType): this
Assigns the provided PrimitiveType value to the intervalUnit property.
Parameters
- element: undefined | null | CodeType
  the intervalUnit value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36197

hasIntervalUnitElement

hasIntervalUnitElement(): boolean
Returns boolean
true if the intervalUnit property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36211

getIntervalUnit

getIntervalUnit(): null | string
Returns null | string
the intervalUnit property value as a fhirCode if defined; else null
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36218

setIntervalUnit

setIntervalUnit(value: undefined | null | string): this
Assigns the provided primitive value to the intervalUnit property.
Parameters
- value: undefined | null | string
  the intervalUnit value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36233

hasIntervalUnit

hasIntervalUnit(): boolean
Returns boolean
true if the intervalUnit property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36246

getFactorElement

getFactorElement(): DecimalType
Returns DecimalType
the factor property value as a DecimalType object if defined; else an empty DecimalType object
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36253

setFactorElement

setFactorElement(element: undefined | DecimalType): this
Assigns the provided PrimitiveType value to the factor property.
Parameters
- element: undefined | DecimalType
  the factor value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36265

hasFactorElement

hasFactorElement(): boolean
Returns boolean
true if the factor property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36279

getFactor

getFactor(): undefined | number
Returns undefined | number
the factor property value as a fhirDecimal if defined; else undefined
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36286

setFactor

setFactor(value: undefined | number): this
Assigns the provided primitive value to the factor property.
Parameters
- value: undefined | number
  the factor value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36297

hasFactor

hasFactor(): boolean
Returns boolean
true if the factor property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36310

getLowerLimitElement

getLowerLimitElement(): DecimalType
Returns DecimalType
the lowerLimit property value as a DecimalType object if defined; else an empty DecimalType object
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36317

setLowerLimitElement

setLowerLimitElement(element: undefined | DecimalType): this
Assigns the provided PrimitiveType value to the lowerLimit property.
Parameters
- element: undefined | DecimalType
  the lowerLimit value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36329

hasLowerLimitElement

hasLowerLimitElement(): boolean
Returns boolean
true if the lowerLimit property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36343

getLowerLimit

getLowerLimit(): undefined | number
Returns undefined | number
the lowerLimit property value as a fhirDecimal if defined; else undefined
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36350

setLowerLimit

setLowerLimit(value: undefined | number): this
Assigns the provided primitive value to the lowerLimit property.
Parameters
- value: undefined | number
  the lowerLimit value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36361

hasLowerLimit

hasLowerLimit(): boolean
Returns boolean
true if the lowerLimit property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36374

getUpperLimitElement

getUpperLimitElement(): DecimalType
Returns DecimalType
the upperLimit property value as a DecimalType object if defined; else an empty DecimalType object
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36381

setUpperLimitElement

setUpperLimitElement(element: undefined | DecimalType): this
Assigns the provided PrimitiveType value to the upperLimit property.
Parameters
- element: undefined | DecimalType
  the upperLimit value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36393

hasUpperLimitElement

hasUpperLimitElement(): boolean
Returns boolean
true if the upperLimit property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36407

getUpperLimit

getUpperLimit(): undefined | number
Returns undefined | number
the upperLimit property value as a fhirDecimal if defined; else undefined
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36414

setUpperLimit

setUpperLimit(value: undefined | number): this
Assigns the provided primitive value to the upperLimit property.
Parameters
- value: undefined | number
  the upperLimit value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36425

hasUpperLimit

hasUpperLimit(): boolean
Returns boolean
true if the upperLimit property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36438

getDimensionsElement

getDimensionsElement(): PositiveIntType
Returns PositiveIntType
the dimensions property value as a PositiveIntType object if defined; else an empty PositiveIntType object
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36445

setDimensionsElement

setDimensionsElement(element: undefined | null | PositiveIntType): this
Assigns the provided PrimitiveType value to the dimensions property.
Parameters
- element: undefined | null | PositiveIntType
  the dimensions value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36457

hasDimensionsElement

hasDimensionsElement(): boolean
Returns boolean
true if the dimensions property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36471

getDimensions

getDimensions(): null | number
Returns null | number
the dimensions property value as a fhirPositiveInt if defined; else null
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36478

setDimensions

setDimensions(value: undefined | null | number): this
Assigns the provided primitive value to the dimensions property.
Parameters
- value: undefined | null | number
  the dimensions value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36493

hasDimensions

hasDimensions(): boolean
Returns boolean
true if the dimensions property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36506

getCodeMapElement

getCodeMapElement(): CanonicalType
Returns CanonicalType
the codeMap property value as a CanonicalType object if defined; else an empty CanonicalType object
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36513

setCodeMapElement

setCodeMapElement(element: undefined | CanonicalType): this
Assigns the provided PrimitiveType value to the codeMap property.
Parameters
- element: undefined | CanonicalType
  the codeMap value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36525

hasCodeMapElement

hasCodeMapElement(): boolean
Returns boolean
true if the codeMap property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36539

getCodeMap

getCodeMap(): undefined | string
Returns undefined | string
the codeMap property value as a fhirCanonical if defined; else undefined
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36546

setCodeMap

setCodeMap(value: undefined | string): this
Assigns the provided primitive value to the codeMap property.
Parameters
- value: undefined | string
  the codeMap value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36557

hasCodeMap

hasCodeMap(): boolean
Returns boolean
true if the codeMap property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36570

getOffsetsElement

getOffsetsElement(): StringType
Returns StringType
the offsets property value as a StringType object if defined; else an empty StringType object
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36577

setOffsetsElement

setOffsetsElement(element: undefined | StringType): this
Assigns the provided PrimitiveType value to the offsets property.
Parameters
- element: undefined | StringType
  the offsets value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36589

hasOffsetsElement

hasOffsetsElement(): boolean
Returns boolean
true if the offsets property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36603

getOffsets

getOffsets(): undefined | string
Returns undefined | string
the offsets property value as a fhirString if defined; else undefined
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36610

setOffsets

setOffsets(value: undefined | string): this
Assigns the provided primitive value to the offsets property.
Parameters
- value: undefined | string
  the offsets value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36621

hasOffsets

hasOffsets(): boolean
Returns boolean
true if the offsets property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36634

getDataElement

getDataElement(): StringType
Returns StringType
the data property value as a StringType object if defined; else an empty StringType object
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36641

setDataElement

setDataElement(element: undefined | StringType): this
Assigns the provided PrimitiveType value to the data property.
Parameters
- element: undefined | StringType
  the data value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36653

hasDataElement

hasDataElement(): boolean
Returns boolean
true if the data property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36667

getData

getData(): undefined | string
Returns undefined | string
the data property value as a fhirString if defined; else undefined
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36674

setData

setData(value: undefined | string): this
Assigns the provided primitive value to the data property.
Parameters
- value: undefined | string
  the data value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36685

hasData

hasData(): boolean
Returns boolean
true if the data property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36698

fhirType

fhirType(): string
Returns string
the FHIR type defined in the FHIR standard
Implementation of IDataType.fhirType
Overrides DataType.fhirType
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36707

isEmpty

isEmpty(): boolean
Returns boolean
true if the instance is empty; false otherwise
Implementation of IDataType.isEmpty
Overrides DataType.isEmpty
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36714

isRequiredFieldsEmpty

isRequiredFieldsEmpty(): boolean
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
Implementation of IDataType.isRequiredFieldsEmpty
Overrides DataType.isRequiredFieldsEmpty
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36733

copy

copy(): SampledData
Creates a copy of the current instance.

Returns SampledData
the a new instance copied from the current instance
Implementation of IDataType.copy
Overrides DataType.copy
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36744

isComplexDataType

isComplexDataType(): boolean
Returns boolean
true if the instance is a FHIR complex datatype; false otherwise
Implementation of IDataType.isComplexDataType
Overrides DataType.isComplexDataType
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36773

dataTypeName

dataTypeName(): string
Returns string
the complex or primitive data model type name (e.g., 'Period", 'StringType', `UriType', etc.)
Implementation of IDataType.dataTypeName
Overrides DataType.dataTypeName
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36780

toJSON

toJSON(): undefined | Value
Returns undefined | Value
the JSON value or undefined if the instance is empty
Implementation of IDataType.toJSON
Overrides DataType.toJSON
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36787

isDataType

isDataType(): boolean
Returns boolean
true if the instance is a FHIR complex or primitive datatype; false otherwise
Implementation of IDataType.isDataType
Inherited from DataType.isDataType
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:302

getId

getId(): undefined | string
Returns undefined | string
the id property value
Implementation of IDataType.getId
Inherited from DataType.getId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:59

setId

setId(value: undefined | string): this
Assigns the provided value to the id property.
Parameters
- value: undefined | string
  the id value
Returns this
this

Throws
PrimitiveTypeError for invalid value
Implementation of IDataType.setId
Inherited from DataType.setId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:67

hasId

hasId(): boolean
Returns boolean
true if id exists and has a value; false otherwise
Implementation of IDataType.hasId
Inherited from DataType.hasId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:71

getExtension

getExtension(): IExtension[]
Returns IExtension[]
the array of extension values
Implementation of IDataType.getExtension
Inherited from DataType.getExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:75

setExtension

setExtension(extension: undefined | IExtension[]): this
Assigns the provided array of Extension values to the extension property.
Parameters
- extension: undefined | IExtension[]
  array of Extensions
Returns this
this
Implementation of IDataType.setExtension
Inherited from DataType.setExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:82

hasExtension

hasExtension(url?: string): boolean
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

Remarks
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.

Throws
AssertionError for invalid url
Implementation of IDataType.hasExtension
Inherited from DataType.hasExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:94

getExtensionByUrl

getExtensionByUrl(url: string): undefined | IExtension
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

Remarks
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.

Throws
AssertionError for invalid url
Implementation of IDataType.getExtensionByUrl
Inherited from DataType.getExtensionByUrl
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:106

addExtension

addExtension(extension: undefined | IExtension): this
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
Implementation of IDataType.addExtension
Inherited from DataType.addExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:113

removeExtension

removeExtension(url: string): void
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
Throws
AssertionError for invalid url
Implementation of IDataType.removeExtension
Inherited from DataType.removeExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:120

isResource

isResource(): boolean
Returns boolean
true if the instance is a FHIR resource; false otherwise
Implementation of IDataType.isResource
Inherited from DataType.isResource
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:67

isPrimitive

isPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive datatype; false otherwise
Implementation of IDataType.isPrimitive
Inherited from DataType.isPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:79

isBooleanPrimitive

isBooleanPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive boolean datatype; false otherwise
Implementation of IDataType.isBooleanPrimitive
Inherited from DataType.isBooleanPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:83

isStringPrimitive

isStringPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive string-based datatype; false otherwise
Implementation of IDataType.isStringPrimitive
Inherited from DataType.isStringPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:87

isNumberPrimitive

isNumberPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive number-based datatype; false otherwise
Implementation of IDataType.isNumberPrimitive
Inherited from DataType.isNumberPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:91

isBigIntPrimitive

isBigIntPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
Implementation of IDataType.isBigIntPrimitive
Inherited from DataType.isBigIntPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:95

isDateTimePrimitive

isDateTimePrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
Implementation of IDataType.isDateTimePrimitive
Inherited from DataType.isDateTimePrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:99

`Protected`copyValues

copyValues(dest: SampledData): void
Protected
Copies the current instance's elements into the provided object.
Parameters
- dest: SampledData
  the copied instance
Returns void
Overrides DataType.copyValues
- Defined in packages/r5-datamodels/src/complex-types/complex-datatypes.ts:36756

Class SampledData

Remarks

See

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SampledData

Properties

Privateorigin

Remarks

Private Optionalinterval

Remarks

PrivateintervalUnit

Remarks

Private Optionalfactor

Remarks

Private OptionallowerLimit

Remarks

Private OptionalupperLimit

Remarks

Privatedimensions

Remarks

Private OptionalcodeMap

Remarks

Private Optionaloffsets

Remarks

Private Optionaldata

Remarks

Methods

Staticparse

Parameters

Returns undefined | SampledData

Throws

getOrigin

Returns Quantity

setOrigin

Parameters

Returns this

Throws

hasOrigin

Returns boolean

getIntervalElement

Returns DecimalType

setIntervalElement

Parameters

Returns this

Throws

Throws

hasIntervalElement

Returns boolean

getInterval

Returns undefined | number

setInterval

Parameters

Returns this

Throws

hasInterval

Returns boolean

getIntervalUnitElement

Returns CodeType

setIntervalUnitElement

Parameters

Returns this

Throws

Throws

hasIntervalUnitElement

Returns boolean

getIntervalUnit

Returns null | string

setIntervalUnit

Parameters

Returns this

Throws

hasIntervalUnit

`Private`origin

`Private` `Optional`interval

`Private`intervalUnit

`Private` `Optional`factor

`Private` `Optional`lowerLimit

`Private` `Optional`upperLimit

`Private`dimensions

`Private` `Optional`codeMap

`Private` `Optional`offsets

`Private` `Optional`data

`Static`parse