Package org.linuxforhealth.fhir.model.resource

Class Communication.Builder

    • Method Detail

      • id

        public Communication.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 Communication.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 Communication.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 Communication.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 Communication.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 Communication.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 Communication.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 Communication.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 Communication.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 Communication.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 Communication.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 Communication.Builder identifier​(Identifier... identifier)
        Business identifiers assigned to this communication 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 Communication.Builder identifier​(java.util.Collection<Identifier> identifier)
        Business identifiers assigned to this communication 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

      • instantiatesCanonical

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

        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 Communication.Builder instantiatesCanonical​(java.util.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 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:
        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 Communication.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 Communication.

        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 Communication.Builder instantiatesUri​(java.util.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 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:
        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 Communication.Builder basedOn​(Reference... basedOn)
        An order, proposal or plan fulfilled in whole or in part by this Communication.

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

        Parameters:
        basedOn - Request fulfilled by this communication
        Returns:
        A reference to this Builder instance

      • basedOn

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

      • partOf

        public Communication.Builder partOf​(Reference... partOf)
        Part of this action.

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

        Parameters:
        partOf - Part of this action
        Returns:
        A reference to this Builder instance

      • partOf

        public Communication.Builder partOf​(java.util.Collection<Reference> partOf)
        Part of this action.

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

      • inResponseTo

        public Communication.Builder inResponseTo​(Reference... inResponseTo)
        Prior communication that this communication is in response to.

        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:
        inResponseTo - Reply to
        Returns:
        A reference to this Builder instance

      • inResponseTo

        public Communication.Builder inResponseTo​(java.util.Collection<Reference> inResponseTo)
        Prior communication that this communication is in response to.

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

      • status

        public Communication.Builder status​(CommunicationStatus status)
        The status of the transmission.

        This element is required.

        Parameters:
        status - preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
        Returns:
        A reference to this Builder instance

      • statusReason

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

      • category

        public Communication.Builder category​(CodeableConcept... category)
        The type of message conveyed 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 Communication.Builder category​(java.util.Collection<CodeableConcept> category)
        The type of message conveyed 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 Communication.Builder priority​(CommunicationPriority priority)
        Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.
        Parameters:
        priority - routine | urgent | asap | stat
        Returns:
        A reference to this Builder instance

      • medium

        public Communication.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 Communication.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 Communication.Builder subject​(Reference subject)
        The patient or group that was the focus of this communication.

        Allowed resource types for this reference:

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

      • topic

        public Communication.Builder topic​(CodeableConcept topic)
        Description of the purpose/content, similar to a subject line in an email.
        Parameters:
        topic - Description of the purpose/content
        Returns:
        A reference to this Builder instance

      • about

        public Communication.Builder about​(Reference... about)
        Other resources that pertain to this communication and to which this communication 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
        Returns:
        A reference to this Builder instance

      • about

        public Communication.Builder about​(java.util.Collection<Reference> about)
        Other resources that pertain to this communication and to which this communication 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
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • encounter

        public Communication.Builder encounter​(Reference encounter)
        The Encounter during which this Communication 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

      • sent

        public Communication.Builder sent​(DateTime sent)
        The time when this communication was sent.
        Parameters:
        sent - When sent
        Returns:
        A reference to this Builder instance

      • received

        public Communication.Builder received​(DateTime received)
        The time when this communication arrived at the destination.
        Parameters:
        received - When received
        Returns:
        A reference to this Builder instance

      • recipient

        public Communication.Builder recipient​(Reference... recipient)
        The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).

        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:
        recipient - Message recipient
        Returns:
        A reference to this Builder instance

      • recipient

        public Communication.Builder recipient​(java.util.Collection<Reference> recipient)
        The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).

        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 Communication.Builder reasonCode​(CodeableConcept... reasonCode)
        The reason or justification for the communication.

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

        Parameters:
        reasonCode - Indication for message
        Returns:
        A reference to this Builder instance

      • reasonCode

        public Communication.Builder reasonCode​(java.util.Collection<CodeableConcept> reasonCode)
        The reason or justification 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:
        reasonCode - Indication for message
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • reasonReference

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

        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 communication done?
        Returns:
        A reference to this Builder instance

      • reasonReference

        public Communication.Builder reasonReference​(java.util.Collection<Reference> reasonReference)
        Indicates another resource whose existence justifies this 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:
        reasonReference - Why was communication done?
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • payload

        public Communication.Builder payload​(Communication.Payload... payload)
        Text, attachment(s), or resource(s) that was 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 Communication.Builder payload​(java.util.Collection<Communication.Payload> payload)
        Text, attachment(s), or resource(s) that was 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

      • note

        public Communication.Builder note​(Annotation... note)
        Additional notes or commentary about the communication by the sender, receiver or other interested parties.

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

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

      • note

        public Communication.Builder note​(java.util.Collection<Annotation> note)
        Additional notes or commentary about the communication by the sender, receiver or other interested parties.

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

      • validate

        protected void validate​(Communication communication)