Package org.linuxforhealth.fhir.model.resource

Class ClaimResponse.Builder

    • Method Detail

      • id

        public ClaimResponse.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 ClaimResponse.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 ClaimResponse.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 ClaimResponse.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 ClaimResponse.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 ClaimResponse.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 ClaimResponse.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 ClaimResponse.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 ClaimResponse.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 ClaimResponse.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 ClaimResponse.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 ClaimResponse.Builder identifier​(Identifier... identifier)
        A unique identifier assigned to this claim response.

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

      • identifier

        public ClaimResponse.Builder identifier​(java.util.Collection<Identifier> identifier)
        A unique identifier assigned to this claim 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:
        identifier - Business Identifier for a claim response
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • status

        public ClaimResponse.Builder status​(ClaimResponseStatus status)
        The status of the resource instance.

        This element is required.

        Parameters:
        status - active | cancelled | draft | entered-in-error
        Returns:
        A reference to this Builder instance

      • type

        public ClaimResponse.Builder type​(CodeableConcept type)
        A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.

        This element is required.

        Parameters:
        type - More granular claim type
        Returns:
        A reference to this Builder instance

      • subType

        public ClaimResponse.Builder subType​(CodeableConcept subType)
        A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
        Parameters:
        subType - More granular claim type
        Returns:
        A reference to this Builder instance

      • use

        public ClaimResponse.Builder use​(Use use)
        A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.

        This element is required.

        Parameters:
        use - claim | preauthorization | predetermination
        Returns:
        A reference to this Builder instance

      • patient

        public ClaimResponse.Builder patient​(Reference patient)
        The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.

        This element is required.

        Allowed resource types for this reference:

        Parameters:
        patient - The recipient of the products and services
        Returns:
        A reference to this Builder instance

      • created

        public ClaimResponse.Builder created​(DateTime created)
        The date this resource was created.

        This element is required.

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

      • insurer

        public ClaimResponse.Builder insurer​(Reference insurer)
        The party responsible for authorization, adjudication and reimbursement.

        This element is required.

        Allowed resource types for this reference:

        Parameters:
        insurer - Party responsible for reimbursement
        Returns:
        A reference to this Builder instance

      • requestor

        public ClaimResponse.Builder requestor​(Reference requestor)
        The provider which is responsible for the claim, predetermination or preauthorization.

        Allowed resource types for this reference:

        Parameters:
        requestor - Party responsible for the claim
        Returns:
        A reference to this Builder instance

      • request

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

        Allowed resource types for this reference:

        Parameters:
        request - Id of resource triggering adjudication
        Returns:
        A reference to this Builder instance

      • outcome

        public ClaimResponse.Builder outcome​(RemittanceOutcome outcome)
        The outcome of the claim, predetermination, or preauthorization processing.

        This element is required.

        Parameters:
        outcome - queued | complete | error | partial
        Returns:
        A reference to this Builder instance

      • disposition

        public ClaimResponse.Builder disposition​(String disposition)
        A human readable description of the status of the adjudication.
        Parameters:
        disposition - Disposition Message
        Returns:
        A reference to this Builder instance

      • preAuthRef

        public ClaimResponse.Builder preAuthRef​(String preAuthRef)
        Reference from the Insurer which is used in later communications which refers to this adjudication.
        Parameters:
        preAuthRef - Preauthorization reference
        Returns:
        A reference to this Builder instance

      • preAuthPeriod

        public ClaimResponse.Builder preAuthPeriod​(Period preAuthPeriod)
        The time frame during which this authorization is effective.
        Parameters:
        preAuthPeriod - Preauthorization reference effective period
        Returns:
        A reference to this Builder instance

      • payeeType

        public ClaimResponse.Builder payeeType​(CodeableConcept payeeType)
        Type of Party to be reimbursed: subscriber, provider, other.
        Parameters:
        payeeType - Party to be paid any benefits payable
        Returns:
        A reference to this Builder instance

      • item

        public ClaimResponse.Builder item​(ClaimResponse.Item... item)
        A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.

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

        Parameters:
        item - Adjudication for claim line items
        Returns:
        A reference to this Builder instance

      • item

        public ClaimResponse.Builder item​(java.util.Collection<ClaimResponse.Item> item)
        A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.

        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:
        item - Adjudication for claim line items
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • addItem

        public ClaimResponse.Builder addItem​(ClaimResponse.AddItem... addItem)
        The first-tier service adjudications for payor added product or service lines.

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

        Parameters:
        addItem - Insurer added line items
        Returns:
        A reference to this Builder instance

      • addItem

        public ClaimResponse.Builder addItem​(java.util.Collection<ClaimResponse.AddItem> addItem)
        The first-tier service adjudications for payor added product or service lines.

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

      • adjudication

        public ClaimResponse.Builder adjudication​(ClaimResponse.Item.Adjudication... adjudication)
        The adjudication results which are presented at the header level rather than at the line-item or add-item levels.

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

        Parameters:
        adjudication - Header-level adjudication
        Returns:
        A reference to this Builder instance

      • adjudication

        public ClaimResponse.Builder adjudication​(java.util.Collection<ClaimResponse.Item.Adjudication> adjudication)
        The adjudication results which are presented at the header level rather than at the line-item or add-item levels.

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

      • total

        public ClaimResponse.Builder total​(ClaimResponse.Total... total)
        Categorized monetary totals for the adjudication.

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

        Parameters:
        total - Adjudication totals
        Returns:
        A reference to this Builder instance

      • total

        public ClaimResponse.Builder total​(java.util.Collection<ClaimResponse.Total> total)
        Categorized monetary totals for the adjudication.

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

      • payment

        public ClaimResponse.Builder payment​(ClaimResponse.Payment payment)
        Payment details for the adjudication of the claim.
        Parameters:
        payment - Payment Details
        Returns:
        A reference to this Builder instance

      • fundsReserve

        public ClaimResponse.Builder fundsReserve​(CodeableConcept fundsReserve)
        A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.
        Parameters:
        fundsReserve - Funds reserved status
        Returns:
        A reference to this Builder instance

      • formCode

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

      • form

        public ClaimResponse.Builder form​(Attachment form)
        The actual form, by reference or inclusion, for printing the content or an EOB.
        Parameters:
        form - Printed reference or actual form
        Returns:
        A reference to this Builder instance

      • processNote

        public ClaimResponse.Builder processNote​(ClaimResponse.ProcessNote... processNote)
        A note that describes or explains adjudication results 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 adjudication
        Returns:
        A reference to this Builder instance

      • processNote

        public ClaimResponse.Builder processNote​(java.util.Collection<ClaimResponse.ProcessNote> processNote)
        A note that describes or explains adjudication results 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 adjudication
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • communicationRequest

        public ClaimResponse.Builder communicationRequest​(Reference... communicationRequest)
        Request for additional supporting or authorizing information.

        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:
        communicationRequest - Request for additional information
        Returns:
        A reference to this Builder instance

      • communicationRequest

        public ClaimResponse.Builder communicationRequest​(java.util.Collection<Reference> communicationRequest)
        Request for additional supporting or authorizing information.

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

      • insurance

        public ClaimResponse.Builder insurance​(ClaimResponse.Insurance... insurance)
        Financial instruments for reimbursement for the health care products and services specified on the claim.

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

        Parameters:
        insurance - Patient insurance information
        Returns:
        A reference to this Builder instance

      • insurance

        public ClaimResponse.Builder insurance​(java.util.Collection<ClaimResponse.Insurance> insurance)
        Financial instruments for reimbursement for the health care products and services specified on the claim.

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

      • error

        public ClaimResponse.Builder error​(ClaimResponse.Error... error)
        Errors encountered during the processing of the adjudication.

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

        Parameters:
        error - Processing errors
        Returns:
        A reference to this Builder instance

      • error

        public ClaimResponse.Builder error​(java.util.Collection<ClaimResponse.Error> error)
        Errors encountered during the processing of the adjudication.

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

      • validate

        protected void validate​(ClaimResponse claimResponse)