Package com.ibm.fhir.model.resource

Class DeviceDefinition.Builder

    • Method Detail

      • id

        public DeviceDefinition.Builder id​(java.lang.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 DeviceDefinition.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 DeviceDefinition.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

      • text

        public DeviceDefinition.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 DeviceDefinition.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 DeviceDefinition.Builder contained​(java.util.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:
        java.lang.NullPointerException - If the passed collection is null

      • extension

        public DeviceDefinition.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 DeviceDefinition.Builder extension​(java.util.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:
        java.lang.NullPointerException - If the passed collection is null

      • modifierExtension

        public DeviceDefinition.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 DeviceDefinition.Builder modifierExtension​(java.util.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:
        java.lang.NullPointerException - If the passed collection is null

      • identifier

        public DeviceDefinition.Builder identifier​(Identifier... identifier)
        Unique instance identifiers assigned to a device by the 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 DeviceDefinition.Builder identifier​(java.util.Collection<Identifier> identifier)
        Unique instance identifiers assigned to a device by the 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:
        java.lang.NullPointerException - If the passed collection is null

      • udiDeviceIdentifier

        public DeviceDefinition.Builder udiDeviceIdentifier​(DeviceDefinition.UdiDeviceIdentifier... udiDeviceIdentifier)
        Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.

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

        Parameters:
        udiDeviceIdentifier - Unique Device Identifier (UDI) Barcode string
        Returns:
        A reference to this Builder instance

      • udiDeviceIdentifier

        public DeviceDefinition.Builder udiDeviceIdentifier​(java.util.Collection<DeviceDefinition.UdiDeviceIdentifier> udiDeviceIdentifier)
        Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.

        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:
        udiDeviceIdentifier - Unique Device Identifier (UDI) Barcode string
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • manufacturer

        public DeviceDefinition.Builder manufacturer​(java.lang.String manufacturer)
        Convenience method for setting manufacturer with choice type String.
        Parameters:
        manufacturer - Name of device manufacturer
        Returns:
        A reference to this Builder instance
        See Also:
        manufacturer(Element)

      • manufacturer

        public DeviceDefinition.Builder manufacturer​(Element manufacturer)
        A name of the manufacturer.

        This is a choice element with the following allowed types:

        When of type Reference, the allowed resource types for this reference are:
        Parameters:
        manufacturer - Name of device manufacturer
        Returns:
        A reference to this Builder instance

      • deviceName

        public DeviceDefinition.Builder deviceName​(DeviceDefinition.DeviceName... deviceName)
        A name given to the device to identify it.

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

        Parameters:
        deviceName - A name given to the device to identify it
        Returns:
        A reference to this Builder instance

      • deviceName

        public DeviceDefinition.Builder deviceName​(java.util.Collection<DeviceDefinition.DeviceName> deviceName)
        A name given to the device to identify it.

        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:
        deviceName - A name given to the device to identify it
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • modelNumber

        public DeviceDefinition.Builder modelNumber​(String modelNumber)
        The model number for the device.
        Parameters:
        modelNumber - The model number for the device
        Returns:
        A reference to this Builder instance

      • type

        public DeviceDefinition.Builder type​(CodeableConcept type)
        What kind of device or device system this is.
        Parameters:
        type - What kind of device or device system this is
        Returns:
        A reference to this Builder instance

      • specialization

        public DeviceDefinition.Builder specialization​(DeviceDefinition.Specialization... specialization)
        The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.

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

        Parameters:
        specialization - The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
        Returns:
        A reference to this Builder instance

      • specialization

        public DeviceDefinition.Builder specialization​(java.util.Collection<DeviceDefinition.Specialization> specialization)
        The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.

        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:
        specialization - The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • version

        public DeviceDefinition.Builder version​(java.lang.String... version)
        Convenience method for setting version.

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

        Parameters:
        version - Available versions
        Returns:
        A reference to this Builder instance
        See Also:
        #version(com.ibm.fhir.model.type.String)

      • version

        public DeviceDefinition.Builder version​(String... version)
        The available versions of the device, e.g., software versions.

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

        Parameters:
        version - Available versions
        Returns:
        A reference to this Builder instance

      • version

        public DeviceDefinition.Builder version​(java.util.Collection<String> version)
        The available versions of the device, e.g., software versions.

        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:
        version - Available versions
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • safety

        public DeviceDefinition.Builder safety​(CodeableConcept... safety)
        Safety characteristics of the device.

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

        Parameters:
        safety - Safety characteristics of the device
        Returns:
        A reference to this Builder instance

      • safety

        public DeviceDefinition.Builder safety​(java.util.Collection<CodeableConcept> safety)
        Safety characteristics of the device.

        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:
        safety - Safety characteristics of the device
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • shelfLifeStorage

        public DeviceDefinition.Builder shelfLifeStorage​(ProductShelfLife... shelfLifeStorage)
        Shelf Life and storage information.

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

        Parameters:
        shelfLifeStorage - Shelf Life and storage information
        Returns:
        A reference to this Builder instance

      • shelfLifeStorage

        public DeviceDefinition.Builder shelfLifeStorage​(java.util.Collection<ProductShelfLife> shelfLifeStorage)
        Shelf Life and storage information.

        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:
        shelfLifeStorage - Shelf Life and storage information
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • physicalCharacteristics

        public DeviceDefinition.Builder physicalCharacteristics​(ProdCharacteristic physicalCharacteristics)
        Dimensions, color etc.
        Parameters:
        physicalCharacteristics - Dimensions, color etc.
        Returns:
        A reference to this Builder instance

      • languageCode

        public DeviceDefinition.Builder languageCode​(CodeableConcept... languageCode)
        Language code for the human-readable text strings produced by the device (all supported).

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

        Parameters:
        languageCode - Language code for the human-readable text strings produced by the device (all supported)
        Returns:
        A reference to this Builder instance

      • languageCode

        public DeviceDefinition.Builder languageCode​(java.util.Collection<CodeableConcept> languageCode)
        Language code for the human-readable text strings produced by the device (all supported).

        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:
        languageCode - Language code for the human-readable text strings produced by the device (all supported)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • capability

        public DeviceDefinition.Builder capability​(DeviceDefinition.Capability... capability)
        Device capabilities.

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

        Parameters:
        capability - Device capabilities
        Returns:
        A reference to this Builder instance

      • capability

        public DeviceDefinition.Builder capability​(java.util.Collection<DeviceDefinition.Capability> capability)
        Device capabilities.

        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:
        capability - Device capabilities
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • property

        public DeviceDefinition.Builder property​(DeviceDefinition.Property... property)
        The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

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

        Parameters:
        property - The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
        Returns:
        A reference to this Builder instance

      • property

        public DeviceDefinition.Builder property​(java.util.Collection<DeviceDefinition.Property> property)
        The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

        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:
        property - The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • owner

        public DeviceDefinition.Builder owner​(Reference owner)
        An organization that is responsible for the provision and ongoing maintenance of the device.

        Allowed resource types for this reference:

        Parameters:
        owner - Organization responsible for device
        Returns:
        A reference to this Builder instance

      • contact

        public DeviceDefinition.Builder contact​(ContactPoint... contact)
        Contact details for an organization or a particular human that is responsible for the device.

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

        Parameters:
        contact - Details for human/organization for support
        Returns:
        A reference to this Builder instance

      • contact

        public DeviceDefinition.Builder contact​(java.util.Collection<ContactPoint> contact)
        Contact details for an organization or a particular human that is responsible for the device.

        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:
        contact - Details for human/organization for support
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • url

        public DeviceDefinition.Builder url​(Uri url)
        A network address on which the device may be contacted directly.
        Parameters:
        url - Network address to contact device
        Returns:
        A reference to this Builder instance

      • onlineInformation

        public DeviceDefinition.Builder onlineInformation​(Uri onlineInformation)
        Access to on-line information about the device.
        Parameters:
        onlineInformation - Access to on-line information
        Returns:
        A reference to this Builder instance

      • note

        public DeviceDefinition.Builder note​(Annotation... note)
        Descriptive information, usage information or implantation information that is not captured in an existing element.

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

        Parameters:
        note - Device notes and comments
        Returns:
        A reference to this Builder instance

      • note

        public DeviceDefinition.Builder note​(java.util.Collection<Annotation> note)
        Descriptive information, usage information or implantation information that is not captured in an existing element.

        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:
        note - Device notes and comments
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • quantity

        public DeviceDefinition.Builder quantity​(Quantity quantity)
        The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product).
        Parameters:
        quantity - The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product)
        Returns:
        A reference to this Builder instance

      • parentDevice

        public DeviceDefinition.Builder parentDevice​(Reference parentDevice)
        The parent device it can be part of.

        Allowed resource types for this reference:

        Parameters:
        parentDevice - The parent device it can be part of
        Returns:
        A reference to this Builder instance

      • material

        public DeviceDefinition.Builder material​(DeviceDefinition.Material... material)
        A substance used to create the material(s) of which the device is made.

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

        Parameters:
        material - A substance used to create the material(s) of which the device is made
        Returns:
        A reference to this Builder instance

      • material

        public DeviceDefinition.Builder material​(java.util.Collection<DeviceDefinition.Material> material)
        A substance used to create the material(s) of which the device is made.

        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:
        material - A substance used to create the material(s) of which the device is made
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null