Package com.ibm.fhir.model.resource

Class DeviceMetric.Builder

    • Method Detail

      • id

        public DeviceMetric.Builder id​(String id)
        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
        Overrides:
        id in class DomainResource.Builder
        Parameters:
        id - Logical id of this artifact
        Returns:
        A reference to this Builder instance

      • meta

        public DeviceMetric.Builder meta​(Meta meta)
        The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
        Overrides:
        meta in class DomainResource.Builder
        Parameters:
        meta - Metadata about the resource
        Returns:
        A reference to this Builder instance

      • implicitRules

        public DeviceMetric.Builder implicitRules​(Uri implicitRules)
        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
        Overrides:
        implicitRules in class DomainResource.Builder
        Parameters:
        implicitRules - A set of rules under which this content was created
        Returns:
        A reference to this Builder instance

      • language

        public DeviceMetric.Builder language​(Code language)
        The base language in which the resource is written.
        Overrides:
        language in class DomainResource.Builder
        Parameters:
        language - Language of the resource content
        Returns:
        A reference to this Builder instance

      • text

        public DeviceMetric.Builder text​(Narrative text)
        A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
        Overrides:
        text in class DomainResource.Builder
        Parameters:
        text - Text summary of the resource, for human interpretation
        Returns:
        A reference to this Builder instance

      • contained

        public DeviceMetric.Builder contained​(Resource... contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance

      • contained

        public DeviceMetric.Builder contained​(Collection<Resource> contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • extension

        public DeviceMetric.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public DeviceMetric.Builder extension​(Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • modifierExtension

        public DeviceMetric.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public DeviceMetric.Builder modifierExtension​(Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • identifier

        public DeviceMetric.Builder identifier​(Identifier... identifier)
        Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        identifier - Instance identifier
        Returns:
        A reference to this Builder instance

      • identifier

        public DeviceMetric.Builder identifier​(Collection<Identifier> identifier)
        Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        identifier - Instance identifier
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • type

        public DeviceMetric.Builder type​(CodeableConcept type)
        Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.

        This element is required.

        Parameters:
        type - Identity of metric, for example Heart Rate or PEEP Setting
        Returns:
        A reference to this Builder instance

      • unit

        public DeviceMetric.Builder unit​(CodeableConcept unit)
        Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.
        Parameters:
        unit - Unit of Measure for the Metric
        Returns:
        A reference to this Builder instance

      • source

        public DeviceMetric.Builder source​(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.

        Allowed resource types for this reference:

        Parameters:
        source - Describes the link to the source Device
        Returns:
        A reference to this Builder instance

      • parent

        public DeviceMetric.Builder parent​(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.

        Allowed resource types for this reference:

        Parameters:
        parent - Describes the link to the parent Device
        Returns:
        A reference to this Builder instance

      • operationalStatus

        public DeviceMetric.Builder operationalStatus​(DeviceMetricOperationalStatus operationalStatus)
        Indicates current operational state of the device. For example: On, Off, Standby, etc.
        Parameters:
        operationalStatus - on | off | standby | entered-in-error
        Returns:
        A reference to this Builder instance

      • color

        public DeviceMetric.Builder color​(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.
        Parameters:
        color - black | red | green | yellow | blue | magenta | cyan | white
        Returns:
        A reference to this Builder instance

      • category

        public DeviceMetric.Builder category​(DeviceMetricCategory category)
        Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.

        This element is required.

        Parameters:
        category - measurement | setting | calculation | unspecified
        Returns:
        A reference to this Builder instance

      • measurementPeriod

        public DeviceMetric.Builder measurementPeriod​(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.
        Parameters:
        measurementPeriod - Describes the measurement repetition time
        Returns:
        A reference to this Builder instance

      • calibration

        public DeviceMetric.Builder calibration​(DeviceMetric.Calibration... calibration)
        Describes the calibrations that have been performed or that are required to be performed.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        calibration - Describes the calibrations that have been performed or that are required to be performed
        Returns:
        A reference to this Builder instance

      • calibration

        public DeviceMetric.Builder calibration​(Collection<DeviceMetric.Calibration> calibration)
        Describes the calibrations that have been performed or that are required to be performed.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        calibration - Describes the calibrations that have been performed or that are required to be performed
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • validate

        protected void validate​(DeviceMetric deviceMetric)