Package com.ibm.fhir.model.resource
Class DeviceMetric
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.resource.Resource
-
- com.ibm.fhir.model.resource.DomainResource
-
- com.ibm.fhir.model.resource.DeviceMetric
-
- All Implemented Interfaces:
Visitable
@Generated("com.ibm.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 classDeviceMetric.Builderstatic classDeviceMetric.CalibrationDescribes the calibrations that have been performed or that are required to be performed.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class com.ibm.fhir.model.resource.Resource
id, implicitRules, language, meta
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static DeviceMetric.Builderbuilder()booleanequals(Object obj)List<DeviceMetric.Calibration>getCalibration()Describes the calibrations that have been performed or that are required to be performed.DeviceMetricCategorygetCategory()Indicates the category of the observation generation process.DeviceMetricColorgetColor()Describes the color representation for the metric.List<Identifier>getIdentifier()Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners.TiminggetMeasurementPeriod()Describes the measurement repetition time.DeviceMetricOperationalStatusgetOperationalStatus()Indicates current operational state of the device.ReferencegetParent()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.ReferencegetSource()Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.CodeableConceptgetType()Describes the type of the metric.CodeableConceptgetUnit()Describes the unit that an observed value determined for this metric will have.booleanhasChildren()inthashCode()DeviceMetric.BuildertoBuilder()Create a new Builder from the contents of this Resource-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class com.ibm.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public 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
Identifierthat 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
CodeableConceptthat 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
CodeableConceptthat 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
Referencethat 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
Referencethat 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
DeviceMetricOperationalStatusthat 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
DeviceMetricColorthat 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
DeviceMetricCategorythat 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
Timingthat may be null.
-
getCalibration
public 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.Calibrationthat may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classDomainResource
-
accept
public void accept(String elementName, int elementIndex, Visitor visitor)
Description copied from interface:VisitableAccept 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:
acceptin interfaceVisitable- Specified by:
acceptin 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
-
toBuilder
public DeviceMetric.Builder toBuilder()
Description copied from class:ResourceCreate a new Builder from the contents of this Resource- Specified by:
toBuilderin classDomainResource
-
builder
public static DeviceMetric.Builder builder()
-
-