Package org.linuxforhealth.fhir.model.resource

Class Device.Builder

    • Method Detail

      • id

        public Device.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 Device.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 Device.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 Device.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 Device.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 Device.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 Device.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 Device.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 Device.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 Device.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 Device.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 Device.Builder identifier​(Identifier... identifier)
        Unique instance identifiers assigned to a device by manufacturers other organizations or owners.

        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 Device.Builder identifier​(java.util.Collection<Identifier> identifier)
        Unique instance identifiers assigned to a device by manufacturers other organizations or owners.

        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

      • definition

        public Device.Builder definition​(Reference definition)
        The reference to the definition for the device.

        Allowed resource types for this reference:

        Parameters:
        definition - The reference to the definition for the device
        Returns:
        A reference to this Builder instance

      • udiCarrier

        public Device.Builder udiCarrier​(Device.UdiCarrier... udiCarrier)
        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:
        udiCarrier - Unique Device Identifier (UDI) Barcode string
        Returns:
        A reference to this Builder instance

      • udiCarrier

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

      • status

        public Device.Builder status​(FHIRDeviceStatus status)
        Status of the Device availability.
        Parameters:
        status - active | inactive | entered-in-error | unknown
        Returns:
        A reference to this Builder instance

      • statusReason

        public Device.Builder statusReason​(CodeableConcept... statusReason)
        Reason for the dtatus of the Device availability.

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

        Parameters:
        statusReason - online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
        Returns:
        A reference to this Builder instance

      • statusReason

        public Device.Builder statusReason​(java.util.Collection<CodeableConcept> statusReason)
        Reason for the dtatus of the Device availability.

        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:
        statusReason - online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • distinctIdentifier

        public Device.Builder distinctIdentifier​(String distinctIdentifier)
        The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
        Parameters:
        distinctIdentifier - The distinct identification string
        Returns:
        A reference to this Builder instance

      • manufacturer

        public Device.Builder manufacturer​(String manufacturer)
        A name of the manufacturer.
        Parameters:
        manufacturer - Name of device manufacturer
        Returns:
        A reference to this Builder instance

      • manufactureDate

        public Device.Builder manufactureDate​(DateTime manufactureDate)
        The date and time when the device was manufactured.
        Parameters:
        manufactureDate - Date when the device was made
        Returns:
        A reference to this Builder instance

      • expirationDate

        public Device.Builder expirationDate​(DateTime expirationDate)
        The date and time beyond which this device is no longer valid or should not be used (if applicable).
        Parameters:
        expirationDate - Date and time of expiry of this device (if applicable)
        Returns:
        A reference to this Builder instance

      • lotNumber

        public Device.Builder lotNumber​(String lotNumber)
        Lot number assigned by the manufacturer.
        Parameters:
        lotNumber - Lot number of manufacture
        Returns:
        A reference to this Builder instance

      • serialNumber

        public Device.Builder serialNumber​(String serialNumber)
        The serial number assigned by the organization when the device was manufactured.
        Parameters:
        serialNumber - Serial number assigned by the manufacturer
        Returns:
        A reference to this Builder instance

      • deviceName

        public Device.Builder deviceName​(Device.DeviceName... deviceName)
        This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.

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

        Parameters:
        deviceName - The name of the device as given by the manufacturer
        Returns:
        A reference to this Builder instance

      • deviceName

        public Device.Builder deviceName​(java.util.Collection<Device.DeviceName> deviceName)
        This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.

        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 - The name of the device as given by the manufacturer
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • modelNumber

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

      • partNumber

        public Device.Builder partNumber​(String partNumber)
        The part number or catalog number of the device.
        Parameters:
        partNumber - The part number or catalog number of the device
        Returns:
        A reference to this Builder instance

      • type

        public Device.Builder type​(CodeableConcept type)
        The kind or type of device.
        Parameters:
        type - The kind or type of device
        Returns:
        A reference to this Builder instance

      • specialization

        public Device.Builder specialization​(Device.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 Device.Builder specialization​(java.util.Collection<Device.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 Device.Builder version​(Device.Version... version)
        The actual design of the device or software version running on the device.

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

        Parameters:
        version - The actual design of the device or software version running on the device
        Returns:
        A reference to this Builder instance

      • version

        public Device.Builder version​(java.util.Collection<Device.Version> version)
        The actual design of the device or software version running on 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:
        version - The actual design of the device or software version running on the device
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • property

        public Device.Builder property​(Device.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 Device.Builder property​(java.util.Collection<Device.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

      • patient

        public Device.Builder patient​(Reference patient)
        Patient information, If the device is affixed to a person.

        Allowed resource types for this reference:

        Parameters:
        patient - Patient to whom Device is affixed
        Returns:
        A reference to this Builder instance

      • owner

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

      • location

        public Device.Builder location​(Reference location)
        The place where the device can be found.

        Allowed resource types for this reference:

        Parameters:
        location - Where the device is found
        Returns:
        A reference to this Builder instance

      • url

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

      • note

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

      • safety

        public Device.Builder safety​(CodeableConcept... safety)
        Provides additional safety characteristics about a medical device. For example devices containing latex.

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

        Parameters:
        safety - Safety Characteristics of Device
        Returns:
        A reference to this Builder instance

      • safety

        public Device.Builder safety​(java.util.Collection<CodeableConcept> safety)
        Provides additional safety characteristics about a medical device. For example devices containing latex.

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

      • parent

        public Device.Builder parent​(Reference parent)
        The device that this device is attached to or is part of.

        Allowed resource types for this reference:

        Parameters:
        parent - The device that this device is attached to or is part of
        Returns:
        A reference to this Builder instance

      • build

        public Device build()
        Build the Device
        Specified by:
        build in interface Builder<Resource>
        Specified by:
        build in class DomainResource.Builder
        Returns:
        An immutable object of type Device
        Throws:
        java.lang.IllegalStateException - if the current state cannot be built into a valid Device per the base specification

      • validate

        protected void validate​(Device device)