Package org.linuxforhealth.fhir.model.resource

Class Claim.Builder

    • Method Detail

      • id

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

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

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

      • identifier

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

      • status

        public Claim.Builder status​(ClaimStatus 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 Claim.Builder type​(CodeableConcept type)
        The category of claim, e.g. oral, pharmacy, vision, institutional, professional.

        This element is required.

        Parameters:
        type - Category or discipline
        Returns:
        A reference to this Builder instance

      • subType

        public Claim.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 Claim.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 Claim.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 or forecast 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

      • billablePeriod

        public Claim.Builder billablePeriod​(Period billablePeriod)
        The period for which charges are being submitted.
        Parameters:
        billablePeriod - Relevant time frame for the claim
        Returns:
        A reference to this Builder instance

      • created

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

        This element is required.

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

      • enterer

        public Claim.Builder enterer​(Reference enterer)
        Individual who created the claim, predetermination or preauthorization.

        Allowed resource types for this reference:

        Parameters:
        enterer - Author of the claim
        Returns:
        A reference to this Builder instance

      • insurer

        public Claim.Builder insurer​(Reference insurer)
        The Insurer who is target of the request.

        Allowed resource types for this reference:

        Parameters:
        insurer - Target
        Returns:
        A reference to this Builder instance

      • provider

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

        This element is required.

        Allowed resource types for this reference:

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

      • priority

        public Claim.Builder priority​(CodeableConcept priority)
        The provider-required urgency of processing the request. Typical values include: stat, routine deferred.

        This element is required.

        Parameters:
        priority - Desired processing ugency
        Returns:
        A reference to this Builder instance

      • fundsReserve

        public Claim.Builder fundsReserve​(CodeableConcept fundsReserve)
        A code to indicate whether and for whom funds are to be reserved for future claims.
        Parameters:
        fundsReserve - For whom to reserve funds
        Returns:
        A reference to this Builder instance

      • related

        public Claim.Builder related​(Claim.Related... related)
        Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.

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

        Parameters:
        related - Prior or corollary claims
        Returns:
        A reference to this Builder instance

      • related

        public Claim.Builder related​(java.util.Collection<Claim.Related> related)
        Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.

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

      • prescription

        public Claim.Builder prescription​(Reference prescription)
        Prescription to support the dispensing of pharmacy, device or vision products.

        Allowed resource types for this reference:

        Parameters:
        prescription - Prescription authorizing services and products
        Returns:
        A reference to this Builder instance

      • originalPrescription

        public Claim.Builder originalPrescription​(Reference originalPrescription)
        Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.

        Allowed resource types for this reference:

        Parameters:
        originalPrescription - Original prescription if superseded by fulfiller
        Returns:
        A reference to this Builder instance

      • payee

        public Claim.Builder payee​(Claim.Payee payee)
        The party to be reimbursed for cost of the products and services according to the terms of the policy.
        Parameters:
        payee - Recipient of benefits payable
        Returns:
        A reference to this Builder instance

      • referral

        public Claim.Builder referral​(Reference referral)
        A reference to a referral resource.

        Allowed resource types for this reference:

        Parameters:
        referral - Treatment referral
        Returns:
        A reference to this Builder instance

      • facility

        public Claim.Builder facility​(Reference facility)
        Facility where the services were provided.

        Allowed resource types for this reference:

        Parameters:
        facility - Servicing facility
        Returns:
        A reference to this Builder instance

      • careTeam

        public Claim.Builder careTeam​(Claim.CareTeam... careTeam)
        The members of the team who provided the products and services.

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

        Parameters:
        careTeam - Members of the care team
        Returns:
        A reference to this Builder instance

      • careTeam

        public Claim.Builder careTeam​(java.util.Collection<Claim.CareTeam> careTeam)
        The members of the team who provided the products and services.

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

      • supportingInfo

        public Claim.Builder supportingInfo​(Claim.SupportingInfo... supportingInfo)
        Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

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

        Parameters:
        supportingInfo - Supporting information
        Returns:
        A reference to this Builder instance

      • supportingInfo

        public Claim.Builder supportingInfo​(java.util.Collection<Claim.SupportingInfo> supportingInfo)
        Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

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

      • diagnosis

        public Claim.Builder diagnosis​(Claim.Diagnosis... diagnosis)
        Information about diagnoses relevant to the claim items.

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

        Parameters:
        diagnosis - Pertinent diagnosis information
        Returns:
        A reference to this Builder instance

      • diagnosis

        public Claim.Builder diagnosis​(java.util.Collection<Claim.Diagnosis> diagnosis)
        Information about diagnoses relevant to the claim items.

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

      • procedure

        public Claim.Builder procedure​(Claim.Procedure... procedure)
        Procedures performed on the patient relevant to the billing items with the claim.

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

        Parameters:
        procedure - Clinical procedures performed
        Returns:
        A reference to this Builder instance

      • procedure

        public Claim.Builder procedure​(java.util.Collection<Claim.Procedure> procedure)
        Procedures performed on the patient relevant to the billing items with 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:
        procedure - Clinical procedures performed
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • insurance

        public Claim.Builder insurance​(Claim.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.

        This element is required.

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

      • insurance

        public Claim.Builder insurance​(java.util.Collection<Claim.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.

        This element is required.

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

      • accident

        public Claim.Builder accident​(Claim.Accident accident)
        Details of an accident which resulted in injuries which required the products and services listed in the claim.
        Parameters:
        accident - Details of the event
        Returns:
        A reference to this Builder instance

      • item

        public Claim.Builder item​(Claim.Item... item)
        A claim line. Either a simple product or service or a 'group' of details which can each 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 - Product or service provided
        Returns:
        A reference to this Builder instance

      • item

        public Claim.Builder item​(java.util.Collection<Claim.Item> item)
        A claim line. Either a simple product or service or a 'group' of details which can each 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 - Product or service provided
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • total

        public Claim.Builder total​(Money total)
        The total value of the all the items in the claim.
        Parameters:
        total - Total claim cost
        Returns:
        A reference to this Builder instance

      • build

        public Claim build()
        Build the Claim

        Required elements:

        • status
        • type
        • use
        • patient
        • created
        • provider
        • priority
        • insurance
        Specified by:
        build in interface Builder<Resource>
        Specified by:
        build in class DomainResource.Builder
        Returns:
        An immutable object of type Claim
        Throws:
        java.lang.IllegalStateException - if the current state cannot be built into a valid Claim per the base specification

      • validate

        protected void validate​(Claim claim)