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

    public class DeviceMetric
    extends DomainResource
    Describes a measurement, calculation or setting capability of a medical device.
    See Also:
    Serialized Form
    • Field Detail

      • identifier

        protected Identifier 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

        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.
      • source

        protected Reference 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

        protected Device 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

        protected Reference 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

        protected DeviceComponent 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.)
      • color

        protected Enumeration<DeviceMetric.DeviceMetricColor> 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.
      • measurementPeriod

        protected Timing 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.
      • SP_PARENT

        public static final String SP_PARENT
        Search parameter: parent

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

        See Also:
        Constant Field Values
      • PARENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARENT
        Fluent Client search parameter constant for parent

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

      • INCLUDE_PARENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PARENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceMetric:parent".
      • 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_SOURCE

        public static final String SP_SOURCE
        Search parameter: source

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

        See Also:
        Constant Field Values
      • SOURCE

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SOURCE
        Fluent Client search parameter constant for source

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

      • INCLUDE_SOURCE

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SOURCE
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceMetric:source".
      • TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
        Fluent Client search parameter constant for type

        Description: The component type
        Type: token
        Path: DeviceMetric.type

      • 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

    • Method Detail

      • getIdentifier

        public Identifier 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.)
      • setIdentifier

        public DeviceMetric setIdentifier​(Identifier value)
        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

        public CodeableConcept getType()
        Returns:
        type (Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.)
      • hasType

        public boolean hasType()
      • 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.)
      • getSource

        public Reference 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.)
      • setSource

        public DeviceMetric setSource​(Reference value)
        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

        public Device 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

        public DeviceMetric setSourceTarget​(Device value)
        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

        public Reference 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.)
      • setParent

        public DeviceMetric setParent​(Reference value)
        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

        public DeviceComponent 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

        public DeviceMetric setParentTarget​(DeviceComponent value)
        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.)
      • getColorElement

        public Enumeration<DeviceMetric.DeviceMetricColorgetColorElement()
        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
      • setColorElement

        public DeviceMetric setColorElement​(Enumeration<DeviceMetric.DeviceMetricColor> value)
        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

        public DeviceMetric.DeviceMetricColor 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

        public DeviceMetric setColor​(DeviceMetric.DeviceMetricColor value)
        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

        public Enumeration<DeviceMetric.DeviceMetricCategorygetCategoryElement()
        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
      • getMeasurementPeriod

        public Timing 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.)
      • setMeasurementPeriod

        public DeviceMetric setMeasurementPeriod​(Timing value)
        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.)
      • 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
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource