Package com.ibm.fhir.model.resource

Class CommunicationRequest.Builder

    • Method Detail

      • id

        public CommunicationRequest.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 CommunicationRequest.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 CommunicationRequest.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 CommunicationRequest.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 CommunicationRequest.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 CommunicationRequest.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 CommunicationRequest.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 CommunicationRequest.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 CommunicationRequest.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 CommunicationRequest.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 CommunicationRequest.Builder identifier​(Identifier... identifier)
        Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

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

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

      • identifier

        public CommunicationRequest.Builder identifier​(java.util.Collection<Identifier> identifier)
        Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

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

      • basedOn

        public CommunicationRequest.Builder basedOn​(Reference... basedOn)
        A plan or proposal 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 or proposal
        Returns:
        A reference to this Builder instance

      • basedOn

        public CommunicationRequest.Builder basedOn​(java.util.Collection<Reference> basedOn)
        A plan or proposal 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 or proposal
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • replaces

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

        Allowed resource types for the references:

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

      • replaces

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

        Allowed resource types for the references:

        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 CommunicationRequest.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 CommunicationRequest.Builder status​(CommunicationRequestStatus status)
        The status of the proposal or order.

        This element is required.

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

      • statusReason

        public CommunicationRequest.Builder statusReason​(CodeableConcept statusReason)
        Captures the reason for the current state of the CommunicationRequest.
        Parameters:
        statusReason - Reason for current status
        Returns:
        A reference to this Builder instance

      • category

        public CommunicationRequest.Builder category​(CodeableConcept... category)
        The type of message to be sent such as alert, notification, reminder, instruction, etc.

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

        Parameters:
        category - Message category
        Returns:
        A reference to this Builder instance

      • category

        public CommunicationRequest.Builder category​(java.util.Collection<CodeableConcept> category)
        The type of message to be sent such as alert, notification, reminder, instruction, etc.

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

      • priority

        public CommunicationRequest.Builder priority​(CommunicationPriority priority)
        Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
        Parameters:
        priority - routine | urgent | asap | stat
        Returns:
        A reference to this Builder instance

      • doNotPerform

        public CommunicationRequest.Builder doNotPerform​(Boolean doNotPerform)
        If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.
        Parameters:
        doNotPerform - True if request is prohibiting action
        Returns:
        A reference to this Builder instance

      • medium

        public CommunicationRequest.Builder medium​(CodeableConcept... medium)
        A channel that was used for this communication (e.g. email, fax).

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

        Parameters:
        medium - A channel of communication
        Returns:
        A reference to this Builder instance

      • medium

        public CommunicationRequest.Builder medium​(java.util.Collection<CodeableConcept> medium)
        A channel that was used for this communication (e.g. email, fax).

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

      • subject

        public CommunicationRequest.Builder subject​(Reference subject)
        The patient or group that is the focus of this communication request.

        Allowed resource types for this reference:

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

      • about

        public CommunicationRequest.Builder about​(Reference... about)
        Other resources that pertain to this communication request and to which this communication request should be associated.

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

        Parameters:
        about - Resources that pertain to this communication request
        Returns:
        A reference to this Builder instance

      • about

        public CommunicationRequest.Builder about​(java.util.Collection<Reference> about)
        Other resources that pertain to this communication request and to which this communication request should be associated.

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

      • encounter

        public CommunicationRequest.Builder encounter​(Reference encounter)
        The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.

        Allowed resource types for this reference:

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

      • payload

        public CommunicationRequest.Builder payload​(CommunicationRequest.Payload... payload)
        Text, attachment(s), or resource(s) to be communicated to the recipient.

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

        Parameters:
        payload - Message payload
        Returns:
        A reference to this Builder instance

      • payload

        public CommunicationRequest.Builder payload​(java.util.Collection<CommunicationRequest.Payload> payload)
        Text, attachment(s), or resource(s) to be communicated to the recipient.

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

      • occurrence

        public CommunicationRequest.Builder occurrence​(Element occurrence)
        The time when this communication is to occur.

        This is a choice element with the following allowed types:

        Parameters:
        occurrence - When scheduled
        Returns:
        A reference to this Builder instance

      • authoredOn

        public CommunicationRequest.Builder authoredOn​(DateTime authoredOn)
        For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
        Parameters:
        authoredOn - When request transitioned to being actionable
        Returns:
        A reference to this Builder instance

      • recipient

        public CommunicationRequest.Builder recipient​(java.util.Collection<Reference> recipient)
        The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of 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.

        Allowed resource types for the references:

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

      • reasonCode

        public CommunicationRequest.Builder reasonCode​(CodeableConcept... reasonCode)
        Describes why the request is being made 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 is communication needed?
        Returns:
        A reference to this Builder instance

      • reasonCode

        public CommunicationRequest.Builder reasonCode​(java.util.Collection<CodeableConcept> reasonCode)
        Describes why the request is being made 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 is communication needed?
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • reasonReference

        public CommunicationRequest.Builder reasonReference​(java.util.Collection<Reference> reasonReference)
        Indicates another resource whose existence justifies 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.

        Allowed resource types for the references:

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

      • note

        public CommunicationRequest.Builder note​(Annotation... note)
        Comments made about the request by the requester, sender, recipient, subject or other participants.

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

        Parameters:
        note - Comments made about communication request
        Returns:
        A reference to this Builder instance

      • note

        public CommunicationRequest.Builder note​(java.util.Collection<Annotation> note)
        Comments made about the request by the requester, sender, recipient, subject or other participants.

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