Class DeviceMetric
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.DeviceMetric
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class DeviceMetric extends DomainResource
Describes a measurement, calculation or setting capability of a medical device.Maturity level: FMM1 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DeviceMetric.Builder
static class
DeviceMetric.Calibration
Describes the calibrations that have been performed or that are required to be performed.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static DeviceMetric.Builder
builder()
boolean
equals(java.lang.Object obj)
java.util.List<DeviceMetric.Calibration>
getCalibration()
Describes the calibrations that have been performed or that are required to be performed.DeviceMetricCategory
getCategory()
Indicates the category of the observation generation process.DeviceMetricColor
getColor()
Describes the color representation for the metric.java.util.List<Identifier>
getIdentifier()
Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners.Timing
getMeasurementPeriod()
Describes the measurement repetition time.DeviceMetricOperationalStatus
getOperationalStatus()
Indicates current operational state of the device.Reference
getParent()
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.Reference
getSource()
Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.CodeableConcept
getType()
Describes the type of the metric.CodeableConcept
getUnit()
Describes the unit that an observed value determined for this metric will have.boolean
hasChildren()
int
hashCode()
DeviceMetric.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getType
public CodeableConcept getType()
Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.- Returns:
- An immutable object of type
CodeableConcept
that is non-null.
-
getUnit
public CodeableConcept getUnit()
Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getSource
public Reference getSource()
Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.- Returns:
- An immutable object of type
Reference
that may be null.
-
getParent
public Reference getParent()
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.- Returns:
- An immutable object of type
Reference
that may be null.
-
getOperationalStatus
public DeviceMetricOperationalStatus getOperationalStatus()
Indicates current operational state of the device. For example: On, Off, Standby, etc.- Returns:
- An immutable object of type
DeviceMetricOperationalStatus
that may be null.
-
getColor
public DeviceMetricColor getColor()
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.- Returns:
- An immutable object of type
DeviceMetricColor
that may be null.
-
getCategory
public DeviceMetricCategory getCategory()
Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.- Returns:
- An immutable object of type
DeviceMetricCategory
that is non-null.
-
getMeasurementPeriod
public Timing getMeasurementPeriod()
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.- Returns:
- An immutable object of type
Timing
that may be null.
-
getCalibration
public java.util.List<DeviceMetric.Calibration> getCalibration()
Describes the calibrations that have been performed or that are required to be performed.- Returns:
- An unmodifiable list containing immutable objects of type
DeviceMetric.Calibration
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public DeviceMetric.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static DeviceMetric.Builder builder()
-
-