Class DeviceMetric

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class DeviceMetric
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR DeviceMetric Resource (Measurement, calculation or setting capability of a medical device)

    Definition: Describes a measurement, calculation or setting capability of a medical device.

    Requirements:

    Profile Definition: http://hl7.org/fhir/profiles/DeviceMetric

    See Also:
    Serialized Form
    • Field Detail

      • SP_PARENT

        public static final String SP_PARENT
        Search parameter constant for 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

      • SP_TYPE

        public static final String SP_TYPE
        Search parameter constant for type

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

        See Also:
        Constant Field Values
      • 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_SOURCE

        public static final String SP_SOURCE
        Search parameter constant for 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

      • SP_CATEGORY

        public static final String SP_CATEGORY
        Search parameter constant for 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

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter constant for 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

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

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getType

        public CodeableConceptDt getType()
        Gets the value(s) for type (Type of metric). creating it if it does not exist. Will not return null.

        Definition: Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.

      • setType

        public DeviceMetric setType​(CodeableConceptDt theValue)
        Sets the value(s) for type (Type of metric)

        Definition: Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.

      • getIdentifier

        public IdentifierDt getIdentifier()
        Gets the value(s) for identifier (Unique identifier of this DeviceMetric). creating it if it does not exist. Will not return null.

        Definition: 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​(IdentifierDt theValue)
        Sets the value(s) for identifier (Unique identifier of this DeviceMetric)

        Definition: 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.

      • getUnit

        public CodeableConceptDt getUnit()
        Gets the value(s) for unit (Unit of metric). creating it if it does not exist. Will not return null.

        Definition: Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.

      • setUnit

        public DeviceMetric setUnit​(CodeableConceptDt theValue)
        Sets the value(s) for unit (Unit of metric)

        Definition: Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.

      • getSource

        public ResourceReferenceDt getSource()
        Gets the value(s) for source (Describes the link to the source Device). creating it if it does not exist. Will not return null.

        Definition: Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacture, serial number, etc.

      • setSource

        public DeviceMetric setSource​(ResourceReferenceDt theValue)
        Sets the value(s) for source (Describes the link to the source Device)

        Definition: Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacture, serial number, etc.

      • getParent

        public ResourceReferenceDt getParent()
        Gets the value(s) for parent (Describes the link to the parent DeviceComponent). creating it if it does not exist. Will not return null.

        Definition: 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​(ResourceReferenceDt theValue)
        Sets the value(s) for parent (Describes the link to the parent DeviceComponent)

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

        public ca.uhn.fhir.model.primitive.BoundCodeDt<DeviceMetricOperationalStatusEnumgetOperationalStatusElement()
        Gets the value(s) for operationalStatus (on | off | standby). creating it if it does not exist. Will not return null.

        Definition: Indicates current operational state of the device. For example: On, Off, Standby, etc.

      • getOperationalStatus

        public String getOperationalStatus()
        Gets the value(s) for operationalStatus (on | off | standby). creating it if it does not exist. This method may return null.

        Definition: Indicates current operational state of the device. For example: On, Off, Standby, etc.

      • getColorElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<DeviceMetricColorEnumgetColorElement()
        Gets the value(s) for color (black | red | green | yellow | blue | magenta | cyan | white). creating it if it does not exist. Will not return null.

        Definition: 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.

      • getColor

        public String getColor()
        Gets the value(s) for color (black | red | green | yellow | blue | magenta | cyan | white). creating it if it does not exist. This method may return null.

        Definition: 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​(ca.uhn.fhir.model.primitive.BoundCodeDt<DeviceMetricColorEnum> theValue)
        Sets the value(s) for color (black | red | green | yellow | blue | magenta | cyan | white)

        Definition: 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​(DeviceMetricColorEnum theValue)
        Sets the value(s) for color (black | red | green | yellow | blue | magenta | cyan | white)

        Definition: 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 ca.uhn.fhir.model.primitive.BoundCodeDt<DeviceMetricCategoryEnumgetCategoryElement()
        Gets the value(s) for category (measurement | setting | calculation | unspecified). creating it if it does not exist. Will not return null.

        Definition: Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.

      • getCategory

        public String getCategory()
        Gets the value(s) for category (measurement | setting | calculation | unspecified). creating it if it does not exist. This method may return null.

        Definition: Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.

      • setCategory

        public DeviceMetric setCategory​(ca.uhn.fhir.model.primitive.BoundCodeDt<DeviceMetricCategoryEnum> theValue)
        Sets the value(s) for category (measurement | setting | calculation | unspecified)

        Definition: Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.

      • setCategory

        public DeviceMetric setCategory​(DeviceMetricCategoryEnum theValue)
        Sets the value(s) for category (measurement | setting | calculation | unspecified)

        Definition: Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.

      • getMeasurementPeriod

        public TimingDt getMeasurementPeriod()
        Gets the value(s) for measurementPeriod (Describes the measurement repetition time). creating it if it does not exist. Will not return null.

        Definition: 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​(TimingDt theValue)
        Sets the value(s) for measurementPeriod (Describes the measurement repetition time)

        Definition: 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.CalibrationgetCalibration()
        Gets the value(s) for calibration (Describes the calibrations that have been performed or that are required to be performed). creating it if it does not exist. Will not return null.

        Definition: Describes the calibrations that have been performed or that are required to be performed

      • setCalibration

        public DeviceMetric setCalibration​(List<DeviceMetric.Calibration> theValue)
        Sets the value(s) for calibration (Describes the calibrations that have been performed or that are required to be performed)

        Definition: Describes the calibrations that have been performed or that are required to be performed

      • addCalibration

        public DeviceMetric.Calibration addCalibration()
        Adds and returns a new value for calibration (Describes the calibrations that have been performed or that are required to be performed)

        Definition: Describes the calibrations that have been performed or that are required to be performed

      • addCalibration

        public DeviceMetric addCalibration​(DeviceMetric.Calibration theValue)
        Adds a given new value for calibration (Describes the calibrations that have been performed or that are required to be performed)

        Definition: Describes the calibrations that have been performed or that are required to be performed

        Parameters:
        theValue - The calibration to add (must not be null)
      • getCalibrationFirstRep

        public DeviceMetric.Calibration getCalibrationFirstRep()
        Gets the first repetition for calibration (Describes the calibrations that have been performed or that are required to be performed), creating it if it does not already exist.

        Definition: Describes the calibrations that have been performed or that are required to be performed

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource