Package com.ibm.fhir.model.resource

Class PaymentReconciliation.Builder

    • Method Detail

      • id

        public PaymentReconciliation.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 PaymentReconciliation.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 PaymentReconciliation.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 PaymentReconciliation.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 PaymentReconciliation.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 PaymentReconciliation.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 PaymentReconciliation.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 PaymentReconciliation.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 PaymentReconciliation.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 PaymentReconciliation.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 PaymentReconciliation.Builder identifier​(Identifier... identifier)
        A unique identifier assigned to this payment reconciliation.

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

        Parameters:
        identifier - Business Identifier for a payment reconciliation
        Returns:
        A reference to this Builder instance

      • identifier

        public PaymentReconciliation.Builder identifier​(Collection<Identifier> identifier)
        A unique identifier assigned to this payment reconciliation.

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

      • period

        public PaymentReconciliation.Builder period​(Period period)
        The period of time for which payments have been gathered into this bulk payment for settlement.
        Parameters:
        period - Period covered
        Returns:
        A reference to this Builder instance

      • created

        public PaymentReconciliation.Builder created​(DateTime created)
        The date when the resource was created.

        This element is required.

        Parameters:
        created - Creation date
        Returns:
        A reference to this Builder instance

      • paymentIssuer

        public PaymentReconciliation.Builder paymentIssuer​(Reference paymentIssuer)
        The party who generated the payment.

        Allowed resource types for this reference:

        Parameters:
        paymentIssuer - Party generating payment
        Returns:
        A reference to this Builder instance

      • request

        public PaymentReconciliation.Builder request​(Reference request)
        Original request resource reference.

        Allowed resource types for this reference:

        Parameters:
        request - Reference to requesting resource
        Returns:
        A reference to this Builder instance

      • outcome

        public PaymentReconciliation.Builder outcome​(RemittanceOutcome outcome)
        The outcome of a request for a reconciliation.
        Parameters:
        outcome - queued | complete | error | partial
        Returns:
        A reference to this Builder instance

      • disposition

        public PaymentReconciliation.Builder disposition​(String disposition)
        A human readable description of the status of the request for the reconciliation.
        Parameters:
        disposition - Disposition message
        Returns:
        A reference to this Builder instance

      • paymentDate

        public PaymentReconciliation.Builder paymentDate​(Date paymentDate)
        The date of payment as indicated on the financial instrument.

        This element is required.

        Parameters:
        paymentDate - When payment issued
        Returns:
        A reference to this Builder instance

      • paymentAmount

        public PaymentReconciliation.Builder paymentAmount​(Money paymentAmount)
        Total payment amount as indicated on the financial instrument.

        This element is required.

        Parameters:
        paymentAmount - Total amount of Payment
        Returns:
        A reference to this Builder instance

      • paymentIdentifier

        public PaymentReconciliation.Builder paymentIdentifier​(Identifier paymentIdentifier)
        Issuer's unique identifier for the payment instrument.
        Parameters:
        paymentIdentifier - Business identifier for the payment
        Returns:
        A reference to this Builder instance

      • detail

        public PaymentReconciliation.Builder detail​(PaymentReconciliation.Detail... detail)
        Distribution of the payment amount for a previously acknowledged payable.

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

        Parameters:
        detail - Settlement particulars
        Returns:
        A reference to this Builder instance

      • detail

        public PaymentReconciliation.Builder detail​(Collection<PaymentReconciliation.Detail> detail)
        Distribution of the payment amount for a previously acknowledged payable.

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

      • formCode

        public PaymentReconciliation.Builder formCode​(CodeableConcept formCode)
        A code for the form to be used for printing the content.
        Parameters:
        formCode - Printed form identifier
        Returns:
        A reference to this Builder instance

      • processNote

        public PaymentReconciliation.Builder processNote​(PaymentReconciliation.ProcessNote... processNote)
        A note that describes or explains the processing in a human readable form.

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

        Parameters:
        processNote - Note concerning processing
        Returns:
        A reference to this Builder instance

      • processNote

        public PaymentReconciliation.Builder processNote​(Collection<PaymentReconciliation.ProcessNote> processNote)
        A note that describes or explains the processing in a human readable 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:
        processNote - Note concerning processing
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null