![](/hapi-fhir/images/logos/raccoon-forwards.png)
Class 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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static enum
static class
static enum
static class
static enum
static class
static enum
static class
static enum
static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionDescribes the calibrations that have been performed or that are required to be performed.protected Enumeration
<DeviceMetric.DeviceMetricCategory> Indicates the category of the observation generation process.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for categoryprotected Enumeration
<DeviceMetric.DeviceMetricColor> Describes the color representation for the metric.protected Identifier
Describes the unique identification of this metric that has been assigned by the device or gateway software.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected Timing
Describes the measurement repetition time.Indicates current operational state of the device.protected Reference
Describes the link to the DeviceComponent that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for parentprotected DeviceComponent
The actual object that is the target of the reference (Describes the link to the DeviceComponent that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device.protected Reference
Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for sourceprotected Device
The actual object that is the target of the reference (Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.)static final String
Search parameter: categorystatic final String
Search parameter: identifierstatic final String
Search parameter: parentstatic final String
Search parameter: sourcestatic final String
Search parameter: typeprotected CodeableConcept
Describes the type of the metric.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for typeprotected CodeableConcept
Describes the unit that an observed value determined for this metric will have.Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.dstu3.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
ConstructorsConstructorDescriptionConstructorDeviceMetric
(Identifier identifier, CodeableConcept type, Enumeration<DeviceMetric.DeviceMetricCategory> category) Constructor -
Method Summary
Modifier and TypeMethodDescriptioncopy()
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getColor()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) getType()
String[]
getTypesForProperty
(int hash, String name) getUnit()
boolean
boolean
boolean
boolean
hasColor()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasType()
boolean
hasUnit()
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setCalibration
(List<DeviceMetric.DeviceMetricCalibrationComponent> theCalibration) setIdentifier
(Identifier value) setMeasurementPeriod
(Timing value) setParentTarget
(DeviceComponent value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setSourceTarget
(Device value) setType
(CodeableConcept value) setUnit
(CodeableConcept value) protected DeviceMetric
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, 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
Describes the unique identification of this metric that has been assigned by the device or gateway software. For example: handle ID. It should be noted that in order to make the identifier unique, the system element of the identifier should be set to the unique identifier of the device. -
type
Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc. -
unit
Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc. -
source
Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc. -
sourceTarget
The actual object that is the target of the reference (Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.) -
parent
Describes the link to the DeviceComponent 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 DeviceComponent 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. -
parentTarget
The actual object that is the target of the reference (Describes the link to the DeviceComponent 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 DeviceComponent 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.) -
operationalStatus
Indicates current operational state of the device. For example: On, Off, Standby, etc. -
color
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. -
category
Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation. -
measurementPeriod
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. -
calibration
Describes the calibrations that have been performed or that are required to be performed. -
SP_PARENT
Search parameter: parentDescription: The parent DeviceMetric resource
Type: reference
Path: DeviceMetric.parent
- See Also:
-
PARENT
Fluent Client search parameter constant for parentDescription: The parent DeviceMetric resource
Type: reference
Path: DeviceMetric.parent
-
INCLUDE_PARENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceMetric:parent". -
SP_IDENTIFIER
Search parameter: identifierDescription: The identifier of the metric
Type: token
Path: DeviceMetric.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: The identifier of the metric
Type: token
Path: DeviceMetric.identifier
-
SP_SOURCE
Search parameter: sourceDescription: The device resource
Type: reference
Path: DeviceMetric.source
- See Also:
-
SOURCE
Fluent Client search parameter constant for sourceDescription: The device resource
Type: reference
Path: DeviceMetric.source
-
INCLUDE_SOURCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceMetric:source". -
SP_TYPE
Search parameter: typeDescription: The component type
Type: token
Path: DeviceMetric.type
- See Also:
-
TYPE
Fluent Client search parameter constant for typeDescription: The component type
Type: token
Path: DeviceMetric.type
-
SP_CATEGORY
Search parameter: categoryDescription: The category of the metric
Type: token
Path: DeviceMetric.category
- See Also:
-
CATEGORY
Fluent Client search parameter constant for categoryDescription: The category of the metric
Type: token
Path: DeviceMetric.category
-
-
Constructor Details
-
DeviceMetric
public DeviceMetric()Constructor -
DeviceMetric
public DeviceMetric(Identifier identifier, CodeableConcept type, Enumeration<DeviceMetric.DeviceMetricCategory> category) Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Describes the unique identification of this metric that has been assigned by the device or gateway software. For example: handle ID. It should be noted that in order to make the identifier unique, the system element of the identifier should be set to the unique identifier of the device.)
-
hasIdentifier
-
setIdentifier
- Parameters:
value
-identifier
(Describes the unique identification of this metric that has been assigned by the device or gateway software. For example: handle ID. It should be noted that in order to make the identifier unique, the system element of the identifier should be set to the unique identifier of the device.)
-
getType
- Returns:
type
(Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.)
-
hasType
-
setType
- Parameters:
value
-type
(Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.)
-
getUnit
- Returns:
unit
(Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.)
-
hasUnit
-
setUnit
- Parameters:
value
-unit
(Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.)
-
getSource
- Returns:
source
(Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.)
-
hasSource
-
setSource
- Parameters:
value
-source
(Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.)
-
getSourceTarget
- Returns:
source
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.)
-
setSourceTarget
- Parameters:
value
-source
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.)
-
getParent
- Returns:
parent
(Describes the link to the DeviceComponent 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 DeviceComponent 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.)
-
hasParent
-
setParent
- Parameters:
value
-parent
(Describes the link to the DeviceComponent 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 DeviceComponent 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.)
-
getParentTarget
- Returns:
parent
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Describes the link to the DeviceComponent 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 DeviceComponent 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.)
-
setParentTarget
- Parameters:
value
-parent
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Describes the link to the DeviceComponent 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 DeviceComponent 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.)
-
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
-
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
- Returns:
- Indicates current operational state of the device. For example: On, Off, Standby, etc.
-
setOperationalStatus
- Parameters:
value
- Indicates current operational state of the device. For example: On, Off, Standby, etc.
-
getColorElement
- Returns:
color
(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.). This is the underlying object with id, value and extensions. The accessor "getColor" gives direct access to the value
-
hasColorElement
-
hasColor
-
setColorElement
- Parameters:
value
-color
(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.). This is the underlying object with id, value and extensions. The accessor "getColor" gives direct access to the value
-
getColor
- Returns:
- 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.
-
setColor
- Parameters:
value
- 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.
-
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
-
hasCategory
-
setCategoryElement
- 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
- Returns:
- Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
-
setCategory
- Parameters:
value
- Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
-
getMeasurementPeriod
- Returns:
measurementPeriod
(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.)
-
hasMeasurementPeriod
-
setMeasurementPeriod
- Parameters:
value
-measurementPeriod
(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.)
-
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
-
addCalibration
-
addCalibration
-
getCalibrationFirstRep
- Returns:
- The first repetition of repeating field
calibration
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-