Package org.hl7.fhir.r5.model

Class DeviceMetric

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.DeviceMetric

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class DeviceMetric
extends DomainResource

Describes a measurement, calculation or setting capability of a device. The DeviceMetric resource is derived from the ISO/IEEE 11073-10201 Domain Information Model standard, but is more widely applicable.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeviceMetric.DeviceMetricCalibrationComponent
static enum	DeviceMetric.DeviceMetricCalibrationState
static class	DeviceMetric.DeviceMetricCalibrationStateEnumFactory
static enum	DeviceMetric.DeviceMetricCalibrationType
static class	DeviceMetric.DeviceMetricCalibrationTypeEnumFactory
static enum	DeviceMetric.DeviceMetricCategory
static class	DeviceMetric.DeviceMetricCategoryEnumFactory
static enum	DeviceMetric.DeviceMetricOperationalStatus
static class	DeviceMetric.DeviceMetricOperationalStatusEnumFactory

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<DeviceMetric.DeviceMetricCalibrationComponent>	calibration	Describes the calibrations that have been performed or that are required to be performed.
protected Enumeration<DeviceMetric.DeviceMetricCategory>	category	Indicates the category of the observation generation process.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CATEGORY	Fluent Client search parameter constant for category
protected CodeType	color	The preferred color associated with the metric (e.g., display color).
protected Reference	device	Describes the link to the Device.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DEVICE	Fluent Client search parameter constant for device
protected List<Identifier>	identifier	Instance identifiers assigned to a device, by the device or gateway software, manufacturers, other organizations or owners.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_DEVICE	Constant for fluent queries to be used to add include statements.
protected Quantity	measurementFrequency	The frequency at which the metric is taken or recorded.
protected Enumeration<DeviceMetric.DeviceMetricOperationalStatus>	operationalStatus	Indicates current operational state of the device.
static final String	SP_CATEGORY	Search parameter: category
static final String	SP_DEVICE	Search parameter: device
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_TYPE	Search parameter: type
protected CodeableConcept	type	Describes the type of the metric.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TYPE	Fluent Client search parameter constant for type
protected CodeableConcept	unit	Describes the unit that an observed value determined for this metric will have.

Fields inherited from class org.hl7.fhir.r5.model.DomainResource

contained, extension, modifierExtension, SP_TEXT, text, TEXT

Fields inherited from class org.hl7.fhir.r5.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
DeviceMetric()	Constructor
DeviceMetric(CodeableConcept type, Reference device, DeviceMetric.DeviceMetricCategory category)	Constructor

Method Summary

Modifier and Type	Method	Description
DeviceMetric.DeviceMetricCalibrationComponent	addCalibration()
DeviceMetric	addCalibration(DeviceMetric.DeviceMetricCalibrationComponent t)
Base	addChild(String name)
Identifier	addIdentifier()
DeviceMetric	addIdentifier(Identifier t)
DeviceMetric	copy()
void	copyValues(DeviceMetric dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<DeviceMetric.DeviceMetricCalibrationComponent>	getCalibration()
DeviceMetric.DeviceMetricCalibrationComponent	getCalibrationFirstRep()
DeviceMetric.DeviceMetricCategory	getCategory()
Enumeration<DeviceMetric.DeviceMetricCategory>	getCategoryElement()
String	getColor()
CodeType	getColorElement()
Reference	getDevice()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
Quantity	getMeasurementFrequency()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
DeviceMetric.DeviceMetricOperationalStatus	getOperationalStatus()
Enumeration<DeviceMetric.DeviceMetricOperationalStatus>	getOperationalStatusElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
CodeableConcept	getType()
String[]	getTypesForProperty(int hash, String name)
CodeableConcept	getUnit()
boolean	hasCalibration()
boolean	hasCategory()
boolean	hasCategoryElement()
boolean	hasColor()
boolean	hasColorElement()
boolean	hasDevice()
boolean	hasIdentifier()
boolean	hasMeasurementFrequency()
boolean	hasOperationalStatus()
boolean	hasOperationalStatusElement()
boolean	hasType()
boolean	hasUnit()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
DeviceMetric	setCalibration(List<DeviceMetric.DeviceMetricCalibrationComponent> theCalibration)
DeviceMetric	setCategory(DeviceMetric.DeviceMetricCategory value)
DeviceMetric	setCategoryElement(Enumeration<DeviceMetric.DeviceMetricCategory> value)
DeviceMetric	setColor(String value)
DeviceMetric	setColorElement(CodeType value)
DeviceMetric	setDevice(Reference value)
DeviceMetric	setIdentifier(List<Identifier> theIdentifier)
DeviceMetric	setMeasurementFrequency(Quantity value)
DeviceMetric	setOperationalStatus(DeviceMetric.DeviceMetricOperationalStatus value)
DeviceMetric	setOperationalStatusElement(Enumeration<DeviceMetric.DeviceMetricOperationalStatus> value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
DeviceMetric	setType(CodeableConcept value)
DeviceMetric	setUnit(CodeableConcept value)
protected DeviceMetric	typedCopy()

Methods inherited from class org.hl7.fhir.r5.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText

Methods inherited from class org.hl7.fhir.r5.model.Resource

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

Methods inherited from class org.hl7.fhir.r5.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r5.model.Base

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

Instance identifiers assigned to a device, by the device or gateway software, manufacturers, other organizations or owners. For example, handle ID.

type

protected CodeableConcept type

Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.

unit

protected CodeableConcept unit

Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.

device

protected Reference device

Describes the link to the Device. This is also known as a channel device.

operationalStatus

protected Enumeration<DeviceMetric.DeviceMetricOperationalStatus> operationalStatus

Indicates current operational state of the device. For example: On, Off, Standby, etc.

color

protected CodeType color

The preferred color associated with the metric (e.g., display color). 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; the metrics are displayed in different characteristic colors, such as HR in blue, BP in green, and PR and SpO2 in magenta.

category

protected Enumeration<DeviceMetric.DeviceMetricCategory> category

Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.

measurementFrequency

protected Quantity measurementFrequency

The frequency at which the metric is taken or recorded. Devices measure metrics at a wide range of frequencies; for example, an ECG might sample measurements in the millisecond range, while an NIBP might trigger only once an hour. Less often, the measurementFrequency may be based on a unit other than time, such as distance (e.g. for a measuring wheel). The update period may be different than the measurement frequency, if the device does not update the published observed value with the same frequency as it was measured.

calibration

protected List<DeviceMetric.DeviceMetricCalibrationComponent> calibration

Describes the calibrations that have been performed or that are required to be performed.

SP_CATEGORY

public static final String SP_CATEGORY

Search parameter: category

Description: The category of the metric
Type: token
Path: DeviceMetric.category

See Also:

• Constant Field Values

CATEGORY

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY

Fluent Client search parameter constant for category

Description: The category of the metric
Type: token
Path: DeviceMetric.category

SP_DEVICE

public static final String SP_DEVICE

Search parameter: device

Description: The device resource
Type: reference
Path: DeviceMetric.device

See Also:

• Constant Field Values

DEVICE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEVICE

Fluent Client search parameter constant for device

Description: The device resource
Type: reference
Path: DeviceMetric.device

INCLUDE_DEVICE

public static final ca.uhn.fhir.model.api.Include INCLUDE_DEVICE

Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceMetric:device".

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: The identifier of the metric
Type: token
Path: DeviceMetric.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: The identifier of the metric
Type: token
Path: DeviceMetric.identifier

SP_TYPE

public static final String SP_TYPE

Search parameter: type

Description: The type of metric
Type: token
Path: DeviceMetric.type

See Also:

• Constant Field Values

TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE

Fluent Client search parameter constant for type

Description: The type of metric
Type: token
Path: DeviceMetric.type

Constructor Details

DeviceMetric

public DeviceMetric()

Constructor

DeviceMetric

public DeviceMetric(CodeableConcept type,
 Reference device,
 DeviceMetric.DeviceMetricCategory category)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Instance identifiers assigned to a device, by the device or gateway software, manufacturers, other organizations or owners. For example, handle ID.)

setIdentifier

public DeviceMetric setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public DeviceMetric addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist {3}

getType

public CodeableConcept getType()

Returns:

type (Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.)

hasType

public boolean hasType()

setType

public DeviceMetric setType(CodeableConcept value)

Parameters:

value - type (Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.)

getUnit

public CodeableConcept getUnit()

Returns:

unit (Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.)

hasUnit

public boolean hasUnit()

setUnit

public DeviceMetric setUnit(CodeableConcept value)

Parameters:

value - unit (Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.)

getDevice

public Reference getDevice()

Returns:

device (Describes the link to the Device. This is also known as a channel device.)

hasDevice

public boolean hasDevice()

setDevice

public DeviceMetric setDevice(Reference value)

Parameters:

value - device (Describes the link to the Device. This is also known as a channel device.)

getOperationalStatusElement

public Enumeration<DeviceMetric.DeviceMetricOperationalStatus> getOperationalStatusElement()

Returns:

operationalStatus (Indicates current operational state of the device. For example: On, Off, Standby, etc.). This is the underlying object with id, value and extensions. The accessor "getOperationalStatus" gives direct access to the value

hasOperationalStatusElement

public boolean hasOperationalStatusElement()

hasOperationalStatus

public boolean hasOperationalStatus()

setOperationalStatusElement

public DeviceMetric setOperationalStatusElement(Enumeration<DeviceMetric.DeviceMetricOperationalStatus> value)

Parameters:

value - operationalStatus (Indicates current operational state of the device. For example: On, Off, Standby, etc.). This is the underlying object with id, value and extensions. The accessor "getOperationalStatus" gives direct access to the value

getOperationalStatus

public DeviceMetric.DeviceMetricOperationalStatus getOperationalStatus()

Returns:

Indicates current operational state of the device. For example: On, Off, Standby, etc.

setOperationalStatus

public DeviceMetric setOperationalStatus(DeviceMetric.DeviceMetricOperationalStatus value)

Parameters:

value - Indicates current operational state of the device. For example: On, Off, Standby, etc.

getColorElement

public CodeType getColorElement()

Returns:

color (The preferred color associated with the metric (e.g., display color). 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; the metrics are displayed in different characteristic colors, such as HR in blue, BP in green, and PR and SpO2 in magenta.). This is the underlying object with id, value and extensions. The accessor "getColor" gives direct access to the value

hasColorElement

public boolean hasColorElement()

hasColor

public boolean hasColor()

setColorElement

public DeviceMetric setColorElement(CodeType value)

Parameters:

value - color (The preferred color associated with the metric (e.g., display color). 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; the metrics are displayed in different characteristic colors, such as HR in blue, BP in green, and PR and SpO2 in magenta.). This is the underlying object with id, value and extensions. The accessor "getColor" gives direct access to the value

getColor

public String getColor()

Returns:

The preferred color associated with the metric (e.g., display color). 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; the metrics are displayed in different characteristic colors, such as HR in blue, BP in green, and PR and SpO2 in magenta.

setColor

public DeviceMetric setColor(String value)

Parameters:

value - The preferred color associated with the metric (e.g., display color). 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; the metrics are displayed in different characteristic colors, such as HR in blue, BP in green, and PR and SpO2 in magenta.

getCategoryElement

public Enumeration<DeviceMetric.DeviceMetricCategory> getCategoryElement()

Returns:

category (Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.). This is the underlying object with id, value and extensions. The accessor "getCategory" gives direct access to the value

hasCategoryElement

public boolean hasCategoryElement()

hasCategory

public boolean hasCategory()

setCategoryElement

public DeviceMetric setCategoryElement(Enumeration<DeviceMetric.DeviceMetricCategory> value)

Parameters:

value - category (Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.). This is the underlying object with id, value and extensions. The accessor "getCategory" gives direct access to the value

getCategory

public DeviceMetric.DeviceMetricCategory getCategory()

Returns:

Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.

setCategory

public DeviceMetric setCategory(DeviceMetric.DeviceMetricCategory value)

Parameters:

value - Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.

getMeasurementFrequency

public Quantity getMeasurementFrequency()

Returns:

measurementFrequency (The frequency at which the metric is taken or recorded. Devices measure metrics at a wide range of frequencies; for example, an ECG might sample measurements in the millisecond range, while an NIBP might trigger only once an hour. Less often, the measurementFrequency may be based on a unit other than time, such as distance (e.g. for a measuring wheel). The update period may be different than the measurement frequency, if the device does not update the published observed value with the same frequency as it was measured.)

hasMeasurementFrequency

public boolean hasMeasurementFrequency()

setMeasurementFrequency

public DeviceMetric setMeasurementFrequency(Quantity value)

Parameters:

value - measurementFrequency (The frequency at which the metric is taken or recorded. Devices measure metrics at a wide range of frequencies; for example, an ECG might sample measurements in the millisecond range, while an NIBP might trigger only once an hour. Less often, the measurementFrequency may be based on a unit other than time, such as distance (e.g. for a measuring wheel). The update period may be different than the measurement frequency, if the device does not update the published observed value with the same frequency as it was measured.)

getCalibration

public List<DeviceMetric.DeviceMetricCalibrationComponent> getCalibration()

Returns:

calibration (Describes the calibrations that have been performed or that are required to be performed.)

setCalibration

public DeviceMetric setCalibration(List<DeviceMetric.DeviceMetricCalibrationComponent> theCalibration)

Returns:

Returns a reference to this for easy method chaining

hasCalibration

public boolean hasCalibration()

addCalibration

public DeviceMetric.DeviceMetricCalibrationComponent addCalibration()

addCalibration

public DeviceMetric addCalibration(DeviceMetric.DeviceMetricCalibrationComponent t)

getCalibrationFirstRep

public DeviceMetric.DeviceMetricCalibrationComponent getCalibrationFirstRep()

Returns:

The first repetition of repeating field calibration, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

Returns:

the FHIR type name of the instance (not the java class name)

copy

public DeviceMetric copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(DeviceMetric dst)

typedCopy

protected DeviceMetric typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource