Data Model Libraries
    Preparing search index...

    Class DeviceMetric

    DeviceMetric Class

    Describes a measurement, calculation or setting capability of a medical device.

    FHIR Specification

    • Short: Measurement, calculation or setting capability of a medical device
    • Definition: Describes a measurement, calculation or setting capability of a medical device.
    • Comment: For the initial scope, this DeviceMetric resource is only applicable to describe a single metric node in the containment tree that is produced by the context scanner in any medical device that implements or derives from the ISO/IEEE 11073 standard.
    • FHIR Version: 4.3.0

    FHIR DeviceMetric

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? type_ unit? source? parent? metricOperationalStatusEnum operationalStatus? metricColorEnum color? metricCategoryEnum category measurementPeriod? calibration?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getType setType hasType getUnit setUnit hasUnit getSource setSource hasSource getParent setParent hasParent getOperationalStatusEnumType setOperationalStatusEnumType hasOperationalStatusEnumType getOperationalStatusElement setOperationalStatusElement hasOperationalStatusElement getOperationalStatus setOperationalStatus hasOperationalStatus getColorEnumType setColorEnumType hasColorEnumType getColorElement setColorElement hasColorElement getColor setColor hasColor getCategoryEnumType setCategoryEnumType hasCategoryEnumType getCategoryElement setCategoryElement hasCategoryElement getCategory setCategory hasCategory getMeasurementPeriod setMeasurementPeriod hasMeasurementPeriod getCalibration setCalibration addCalibration hasCalibration fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initCalibration

    Constructors

    Properties

    identifier?: Identifier[]

    DeviceMetric.identifier Element

    FHIR Specification

    • Short: Instance identifier
    • Definition: Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID.
    • Comment: For identifiers assigned to a device by the device or gateway software, the system element of the identifier should be set to the unique identifier of the device.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Privatetype_

    type_: null | CodeableConcept

    DeviceMetric.type Element

    FHIR Specification

    • Short: Identity of metric, for example Heart Rate or PEEP Setting
    • Definition: Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.
    • Comment: DeviceMetric.type can be referred to either IEEE 11073-10101 or LOINC.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    unit?: CodeableConcept

    DeviceMetric.unit Element

    FHIR Specification

    • Short: Unit of Measure for the Metric
    • Definition: Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.
    • Comment: DeviceMetric.unit can refer to either UCUM or preferable a RTMMS coding system.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    source?: Reference

    DeviceMetric.source Element

    FHIR Specification

    • Short: Describes the link to the source Device
    • Definition: Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    parent?: Reference

    DeviceMetric.parent Element

    FHIR Specification

    • Short: Describes the link to the parent Device
    • Definition: Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    metricOperationalStatusEnum: MetricOperationalStatusEnum

    FHIR CodeSystem: MetricOperationalStatus

    MetricOperationalStatusEnum

    operationalStatus?: EnumCodeType

    DeviceMetric.operationalStatus Element

    FHIR Specification

    • Short: on | off | standby | entered-in-error
    • Definition: Indicates current operational state of the device. For example: On, Off, Standby, etc.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: MetricOperationalStatusEnum

    metricColorEnum: MetricColorEnum

    FHIR CodeSystem: MetricColor

    MetricColorEnum

    color?: EnumCodeType

    DeviceMetric.color Element

    FHIR Specification

    • Short: black | red | green | yellow | blue | magenta | cyan | white
    • Definition: Describes the color representation for the metric. This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth for example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: MetricColorEnum

    metricCategoryEnum: MetricCategoryEnum

    FHIR CodeSystem: MetricCategory

    MetricCategoryEnum

    category: null | EnumCodeType

    DeviceMetric.category Element

    FHIR Specification

    • Short: measurement | setting | calculation | unspecified
    • Definition: Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: MetricCategoryEnum

    measurementPeriod?: Timing

    DeviceMetric.measurementPeriod Element

    FHIR Specification

    • Short: Describes the measurement repetition time
    • Definition: Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured.
    • FHIR Type: Timing
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    calibration?: DeviceMetricCalibrationComponent[]

    DeviceMetric.calibration Element

    FHIR Specification

    • Short: Describes the calibrations that have been performed or that are required to be performed
    • Definition: Describes the calibrations that have been performed or that are required to be performed.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR DeviceMetric

      • OptionaloptSourceField: string

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

      Returns undefined | DeviceMetric

      DeviceMetric data model or undefined for DeviceMetric

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetTypesetTypehasTypegetUnitsetUnithasUnitgetSourcesetSourcehasSourcegetParentsetParenthasParentgetOperationalStatusEnumTypesetOperationalStatusEnumTypehasOperationalStatusEnumTypegetOperationalStatusElementsetOperationalStatusElementhasOperationalStatusElementgetOperationalStatussetOperationalStatushasOperationalStatusgetColorEnumTypesetColorEnumTypehasColorEnumTypegetColorElementsetColorElementhasColorElementgetColorsetColorhasColorgetCategoryEnumTypesetCategoryEnumTypehasCategoryEnumTypegetCategoryElementsetCategoryElementhasCategoryElementgetCategorysetCategoryhasCategorygetMeasurementPeriodsetMeasurementPeriodhasMeasurementPeriodgetCalibrationsetCalibrationaddCalibrationhasCalibrationfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitCalibration