Package org.hl7.fhir.r4.model

Class DeviceMetric

java.lang.Object
org.hl7.fhir.r4.model.Base
org.hl7.fhir.r4.model.BaseResource
org.hl7.fhir.r4.model.Resource
org.hl7.fhir.r4.model.DomainResource
org.hl7.fhir.r4.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 medical device.
See Also:

  • Field Details

    • identifier

      protected List<Identifier> identifier
      Unique 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.

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

    • parentTarget

      protected Device parentTarget
      The actual object that is the target of the reference (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.)

    • operationalStatus

      protected Enumeration<DeviceMetric.DeviceMetricOperationalStatus> operationalStatus
      Indicates current operational state of the device. For example: On, Off, Standby, etc.

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

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

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

    • calibration

      protected List<DeviceMetric.DeviceMetricCalibrationComponent> calibration
      Describes the calibrations that have been performed or that are required to be performed.

    • SP_PARENT

      public static final String SP_PARENT
      Search parameter: parent

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

      See Also:

    • 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:

    • 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:

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

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter: type

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

      See Also:

    • 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:

    • 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

  • Constructor Details

  • Method Details

    • getIdentifier

      public List<Identifier> getIdentifier()
      Returns:
      identifier (Unique 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

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

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

    • hasSource

      public boolean hasSource()

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

    • hasParent

      public boolean hasParent()

    • setParent

      public DeviceMetric setParent(Reference value)
      Parameters:
      value - parent (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.)

    • getParentTarget

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

    • setParentTarget

      public DeviceMetric setParentTarget(Device 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 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.)

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

      public boolean hasColorElement()

    • hasColor

      public boolean hasColor()

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

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

    • hasMeasurementPeriod

      public boolean hasMeasurementPeriod()

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

    • 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

    • 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

    • 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

    • 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