Package com.ibm.fhir.model.resource

Class DeviceRequest.Builder

    • Method Detail

      • id

        public DeviceRequest.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 DeviceRequest.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 DeviceRequest.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 DeviceRequest.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 DeviceRequest.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 DeviceRequest.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 DeviceRequest.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 DeviceRequest.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 DeviceRequest.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 DeviceRequest.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 DeviceRequest.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 DeviceRequest.Builder identifier​(Identifier... identifier)
        Identifiers assigned to this order by the orderer or by the receiver.

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

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

      • identifier

        public DeviceRequest.Builder identifier​(Collection<Identifier> identifier)
        Identifiers assigned to this order by the orderer or by the receiver.

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

      • instantiatesCanonical

        public DeviceRequest.Builder instantiatesCanonical​(Canonical... instantiatesCanonical)
        The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.

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

        Parameters:
        instantiatesCanonical - Instantiates FHIR protocol or definition
        Returns:
        A reference to this Builder instance

      • instantiatesCanonical

        public DeviceRequest.Builder instantiatesCanonical​(Collection<Canonical> instantiatesCanonical)
        The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.

        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:
        instantiatesCanonical - Instantiates FHIR protocol or definition
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • instantiatesUri

        public DeviceRequest.Builder instantiatesUri​(Uri... instantiatesUri)
        The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.

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

        Parameters:
        instantiatesUri - Instantiates external protocol or definition
        Returns:
        A reference to this Builder instance

      • instantiatesUri

        public DeviceRequest.Builder instantiatesUri​(Collection<Uri> instantiatesUri)
        The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.

        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:
        instantiatesUri - Instantiates external protocol or definition
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • basedOn

        public DeviceRequest.Builder basedOn​(Reference... basedOn)
        Plan/proposal/order fulfilled by this request.

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

        Parameters:
        basedOn - What request fulfills
        Returns:
        A reference to this Builder instance

      • basedOn

        public DeviceRequest.Builder basedOn​(Collection<Reference> basedOn)
        Plan/proposal/order fulfilled by this request.

        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:
        basedOn - What request fulfills
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • priorRequest

        public DeviceRequest.Builder priorRequest​(Reference... priorRequest)
        The request takes the place of the referenced completed or terminated request(s).

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

        Parameters:
        priorRequest - What request replaces
        Returns:
        A reference to this Builder instance

      • priorRequest

        public DeviceRequest.Builder priorRequest​(Collection<Reference> priorRequest)
        The request takes the place of the referenced completed or terminated request(s).

        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:
        priorRequest - What request replaces
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • groupIdentifier

        public DeviceRequest.Builder groupIdentifier​(Identifier groupIdentifier)
        Composite request this is part of.
        Parameters:
        groupIdentifier - Identifier of composite request
        Returns:
        A reference to this Builder instance

      • status

        public DeviceRequest.Builder status​(DeviceRequestStatus status)
        The status of the request.
        Parameters:
        status - draft | active | on-hold | revoked | completed | entered-in-error | unknown
        Returns:
        A reference to this Builder instance

      • intent

        public DeviceRequest.Builder intent​(RequestIntent intent)
        Whether the request is a proposal, plan, an original order or a reflex order.

        This element is required.

        Parameters:
        intent - proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
        Returns:
        A reference to this Builder instance

      • priority

        public DeviceRequest.Builder priority​(RequestPriority priority)
        Indicates how quickly the {{title}} should be addressed with respect to other requests.
        Parameters:
        priority - routine | urgent | asap | stat
        Returns:
        A reference to this Builder instance

      • code

        public DeviceRequest.Builder code​(Element code)
        The details of the device to be used.

        This element is required.

        This is a choice element with the following allowed types:

        When of type Reference, the allowed resource types for this reference are:
        Parameters:
        code - Device requested
        Returns:
        A reference to this Builder instance

      • parameter

        public DeviceRequest.Builder parameter​(DeviceRequest.Parameter... parameter)
        Specific parameters for the ordered item. For example, the prism value for lenses.

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

        Parameters:
        parameter - Device details
        Returns:
        A reference to this Builder instance

      • parameter

        public DeviceRequest.Builder parameter​(Collection<DeviceRequest.Parameter> parameter)
        Specific parameters for the ordered item. For example, the prism value for lenses.

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

      • subject

        public DeviceRequest.Builder subject​(Reference subject)
        The patient who will use the device.

        This element is required.

        Allowed resource types for this reference:

        Parameters:
        subject - Focus of request
        Returns:
        A reference to this Builder instance

      • encounter

        public DeviceRequest.Builder encounter​(Reference encounter)
        An encounter that provides additional context in which this request is made.

        Allowed resource types for this reference:

        Parameters:
        encounter - Encounter motivating request
        Returns:
        A reference to this Builder instance

      • occurrence

        public DeviceRequest.Builder occurrence​(Element occurrence)
        The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".

        This is a choice element with the following allowed types:

        Parameters:
        occurrence - Desired time or schedule for use
        Returns:
        A reference to this Builder instance

      • authoredOn

        public DeviceRequest.Builder authoredOn​(DateTime authoredOn)
        When the request transitioned to being actionable.
        Parameters:
        authoredOn - When recorded
        Returns:
        A reference to this Builder instance

      • performerType

        public DeviceRequest.Builder performerType​(CodeableConcept performerType)
        Desired type of performer for doing the diagnostic testing.
        Parameters:
        performerType - Filler role
        Returns:
        A reference to this Builder instance

      • reasonCode

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

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

        Parameters:
        reasonCode - Coded Reason for request
        Returns:
        A reference to this Builder instance

      • reasonCode

        public DeviceRequest.Builder reasonCode​(Collection<CodeableConcept> reasonCode)
        Reason or justification for the use of this 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 - Coded Reason for request
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • reasonReference

        public DeviceRequest.Builder reasonReference​(Reference... reasonReference)
        Reason or justification for the use of this device.

        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 - Linked Reason for request
        Returns:
        A reference to this Builder instance

      • insurance

        public DeviceRequest.Builder insurance​(Reference... insurance)
        Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.

        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:
        insurance - Associated insurance coverage
        Returns:
        A reference to this Builder instance

      • insurance

        public DeviceRequest.Builder insurance​(Collection<Reference> insurance)
        Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.

        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:
        insurance - Associated insurance coverage
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • supportingInfo

        public DeviceRequest.Builder supportingInfo​(Reference... supportingInfo)
        Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site).

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

        Parameters:
        supportingInfo - Additional clinical information
        Returns:
        A reference to this Builder instance

      • supportingInfo

        public DeviceRequest.Builder supportingInfo​(Collection<Reference> supportingInfo)
        Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site).

        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:
        supportingInfo - Additional clinical information
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • note

        public DeviceRequest.Builder note​(Annotation... note)
        Details about this request 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 - Notes or comments
        Returns:
        A reference to this Builder instance

      • note

        public DeviceRequest.Builder note​(Collection<Annotation> note)
        Details about this request 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 - Notes or comments
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • relevantHistory

        public DeviceRequest.Builder relevantHistory​(Reference... relevantHistory)
        Key events in the history of the request.

        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:
        relevantHistory - Request provenance
        Returns:
        A reference to this Builder instance

      • relevantHistory

        public DeviceRequest.Builder relevantHistory​(Collection<Reference> relevantHistory)
        Key events in the history of the request.

        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:
        relevantHistory - Request provenance
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • validate

        protected void validate​(DeviceRequest deviceRequest)