Package com.ibm.fhir.model.resource

Class RequestGroup.Builder

    • Method Detail

      • id

        public RequestGroup.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 RequestGroup.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 RequestGroup.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 RequestGroup.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 RequestGroup.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 RequestGroup.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 RequestGroup.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 RequestGroup.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 RequestGroup.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 RequestGroup.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 RequestGroup.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 RequestGroup.Builder identifier​(Identifier... identifier)
        Allows a service to provide a unique, business identifier for the request.

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

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

      • identifier

        public RequestGroup.Builder identifier​(java.util.Collection<Identifier> identifier)
        Allows a service to provide a unique, business identifier for 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.

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

      • instantiatesCanonical

        public RequestGroup.Builder instantiatesCanonical​(Canonical... instantiatesCanonical)
        A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

        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 RequestGroup.Builder instantiatesCanonical​(java.util.Collection<Canonical> instantiatesCanonical)
        A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part 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:
        instantiatesCanonical - Instantiates FHIR protocol or definition
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • instantiatesUri

        public RequestGroup.Builder instantiatesUri​(Uri... instantiatesUri)
        A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

        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 RequestGroup.Builder instantiatesUri​(java.util.Collection<Uri> instantiatesUri)
        A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part 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:
        instantiatesUri - Instantiates external protocol or definition
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • basedOn

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

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

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

      • basedOn

        public RequestGroup.Builder basedOn​(java.util.Collection<Reference> basedOn)
        A plan, proposal or order that is fulfilled in whole or in part 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 - Fulfills plan, proposal, or order
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • replaces

        public RequestGroup.Builder replaces​(Reference... replaces)
        Completed or terminated request(s) whose function is taken by this new request.

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

        Parameters:
        replaces - Request(s) replaced by this request
        Returns:
        A reference to this Builder instance

      • replaces

        public RequestGroup.Builder replaces​(java.util.Collection<Reference> replaces)
        Completed or terminated request(s) whose function is taken by this new 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:
        replaces - Request(s) replaced by this request
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • groupIdentifier

        public RequestGroup.Builder groupIdentifier​(Identifier groupIdentifier)
        A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
        Parameters:
        groupIdentifier - Composite request this is part of
        Returns:
        A reference to this Builder instance

      • status

        public RequestGroup.Builder status​(RequestStatus status)
        The current state of the request. For request groups, the status reflects the status of all the requests in the group.

        This element is required.

        Parameters:
        status - draft | active | on-hold | revoked | completed | entered-in-error | unknown
        Returns:
        A reference to this Builder instance

      • intent

        public RequestGroup.Builder intent​(RequestIntent intent)
        Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.

        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 RequestGroup.Builder priority​(RequestPriority priority)
        Indicates how quickly the request should be addressed with respect to other requests.
        Parameters:
        priority - routine | urgent | asap | stat
        Returns:
        A reference to this Builder instance

      • code

        public RequestGroup.Builder code​(CodeableConcept code)
        A code that identifies what the overall request group is.
        Parameters:
        code - What's being requested/ordered
        Returns:
        A reference to this Builder instance

      • subject

        public RequestGroup.Builder subject​(Reference subject)
        The subject for which the request group was created.

        Allowed resource types for this reference:

        Parameters:
        subject - Who the request group is about
        Returns:
        A reference to this Builder instance

      • encounter

        public RequestGroup.Builder encounter​(Reference encounter)
        Describes the context of the request group, if any.

        Allowed resource types for this reference:

        Parameters:
        encounter - Created as part of
        Returns:
        A reference to this Builder instance

      • authoredOn

        public RequestGroup.Builder authoredOn​(DateTime authoredOn)
        Indicates when the request group was created.
        Parameters:
        authoredOn - When the request group was authored
        Returns:
        A reference to this Builder instance

      • author

        public RequestGroup.Builder author​(Reference author)
        Provides a reference to the author of the request group.

        Allowed resource types for this reference:

        Parameters:
        author - Device or practitioner that authored the request group
        Returns:
        A reference to this Builder instance

      • reasonCode

        public RequestGroup.Builder reasonCode​(CodeableConcept... reasonCode)
        Describes the reason for the request group in coded or textual form.

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

        Parameters:
        reasonCode - Why the request group is needed
        Returns:
        A reference to this Builder instance

      • reasonCode

        public RequestGroup.Builder reasonCode​(java.util.Collection<CodeableConcept> reasonCode)
        Describes the reason for the request group in coded or textual form.

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

      • reasonReference

        public RequestGroup.Builder reasonReference​(Reference... reasonReference)
        Indicates another resource whose existence justifies this request group.

        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 the request group is needed
        Returns:
        A reference to this Builder instance

      • reasonReference

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

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

      • note

        public RequestGroup.Builder note​(Annotation... note)
        Provides a mechanism to communicate additional information about the response.

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

        Parameters:
        note - Additional notes about the response
        Returns:
        A reference to this Builder instance

      • note

        public RequestGroup.Builder note​(java.util.Collection<Annotation> note)
        Provides a mechanism to communicate additional information about the response.

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

      • action

        public RequestGroup.Builder action​(RequestGroup.Action... action)
        The actions, if any, produced by the evaluation of the artifact.

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

        Parameters:
        action - Proposed actions, if any
        Returns:
        A reference to this Builder instance

      • action

        public RequestGroup.Builder action​(java.util.Collection<RequestGroup.Action> action)
        The actions, if any, produced by the evaluation of the artifact.

        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:
        action - Proposed actions, if any
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • validate

        protected void validate​(RequestGroup requestGroup)