Package com.ibm.fhir.model.resource

Class DeviceUseStatement.Builder

    • Method Detail

      • id

        public DeviceUseStatement.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 DeviceUseStatement.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 DeviceUseStatement.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 DeviceUseStatement.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 DeviceUseStatement.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 DeviceUseStatement.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 DeviceUseStatement.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 DeviceUseStatement.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 DeviceUseStatement.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 DeviceUseStatement.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 DeviceUseStatement.Builder identifier​(Identifier... identifier)
        An external identifier for this statement such as an IRI.

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

        Parameters:
        identifier - External identifier for this record
        Returns:
        A reference to this Builder instance

      • identifier

        public DeviceUseStatement.Builder identifier​(java.util.Collection<Identifier> identifier)
        An external identifier for this statement such as an IRI.

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

      • basedOn

        public DeviceUseStatement.Builder basedOn​(Reference... basedOn)
        A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.

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

        Allowed resource types for the references:

        Parameters:
        basedOn - Fulfills plan, proposal or order
        Returns:
        A reference to this Builder instance

      • basedOn

        public DeviceUseStatement.Builder basedOn​(java.util.Collection<Reference> basedOn)
        A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.

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

        Allowed resource types for the references:

        Parameters:
        basedOn - Fulfills plan, proposal or order
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • status

        public DeviceUseStatement.Builder status​(DeviceUseStatementStatus status)
        A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.

        This element is required.

        Parameters:
        status - active | completed | entered-in-error +
        Returns:
        A reference to this Builder instance

      • subject

        public DeviceUseStatement.Builder subject​(Reference subject)
        The patient who used the device.

        This element is required.

        Allowed resource types for this reference:

        Parameters:
        subject - Patient using device
        Returns:
        A reference to this Builder instance

      • derivedFrom

        public DeviceUseStatement.Builder derivedFrom​(java.util.Collection<Reference> derivedFrom)
        Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.

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

        Allowed resource types for the references:

        Parameters:
        derivedFrom - Supporting information
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • timing

        public DeviceUseStatement.Builder timing​(Element timing)
        How often the device was used.

        This is a choice element with the following allowed types:

        Parameters:
        timing - How often the device was used
        Returns:
        A reference to this Builder instance

      • recordedOn

        public DeviceUseStatement.Builder recordedOn​(DateTime recordedOn)
        The time at which the statement was made/recorded.
        Parameters:
        recordedOn - When statement was recorded
        Returns:
        A reference to this Builder instance

      • device

        public DeviceUseStatement.Builder device​(Reference device)
        The details of the device used.

        This element is required.

        Allowed resource types for this reference:

        Parameters:
        device - Reference to device used
        Returns:
        A reference to this Builder instance

      • reasonCode

        public DeviceUseStatement.Builder reasonCode​(CodeableConcept... reasonCode)
        Reason or justification for the use of the device.

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

        Parameters:
        reasonCode - Why device was used
        Returns:
        A reference to this Builder instance

      • reasonCode

        public DeviceUseStatement.Builder reasonCode​(java.util.Collection<CodeableConcept> reasonCode)
        Reason or justification for the use 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:
        reasonCode - Why device was used
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • reasonReference

        public DeviceUseStatement.Builder reasonReference​(Reference... reasonReference)
        Indicates another resource whose existence justifies this DeviceUseStatement.

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

        Allowed resource types for the references:

        Parameters:
        reasonReference - Why was DeviceUseStatement performed?
        Returns:
        A reference to this Builder instance

      • reasonReference

        public DeviceUseStatement.Builder reasonReference​(java.util.Collection<Reference> reasonReference)
        Indicates another resource whose existence justifies this DeviceUseStatement.

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

        Allowed resource types for the references:

        Parameters:
        reasonReference - Why was DeviceUseStatement performed?
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • bodySite

        public DeviceUseStatement.Builder bodySite​(CodeableConcept bodySite)
        Indicates the anotomic location on the subject's body where the device was used ( i.e. the target).
        Parameters:
        bodySite - Target body site
        Returns:
        A reference to this Builder instance

      • note

        public DeviceUseStatement.Builder note​(Annotation... note)
        Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.

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

        Parameters:
        note - Addition details (comments, instructions)
        Returns:
        A reference to this Builder instance

      • note

        public DeviceUseStatement.Builder note​(java.util.Collection<Annotation> note)
        Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.

        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 - Addition details (comments, instructions)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null