Package org.linuxforhealth.fhir.model.resource

Class Claim.Item.Builder

    • Method Detail

      • id

        public Claim.Item.Builder id​(java.lang.String id)
        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
        Overrides:
        id in class BackboneElement.Builder
        Parameters:
        id - Unique id for inter-element referencing
        Returns:
        A reference to this Builder instance

      • extension

        public Claim.Item.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the element. 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 BackboneElement.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public Claim.Item.Builder extension​(java.util.Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the element. 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 BackboneElement.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.Item.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public Claim.Item.Builder modifierExtension​(java.util.Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • sequence

        public Claim.Item.Builder sequence​(PositiveInt sequence)
        A number to uniquely identify item entries.

        This element is required.

        Parameters:
        sequence - Item instance identifier
        Returns:
        A reference to this Builder instance

      • careTeamSequence

        public Claim.Item.Builder careTeamSequence​(PositiveInt... careTeamSequence)
        CareTeam members related to this service or product.

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

        Parameters:
        careTeamSequence - Applicable careTeam members
        Returns:
        A reference to this Builder instance

      • careTeamSequence

        public Claim.Item.Builder careTeamSequence​(java.util.Collection<PositiveInt> careTeamSequence)
        CareTeam members related to this service or product.

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

      • diagnosisSequence

        public Claim.Item.Builder diagnosisSequence​(PositiveInt... diagnosisSequence)
        Diagnosis applicable for this service or product.

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

        Parameters:
        diagnosisSequence - Applicable diagnoses
        Returns:
        A reference to this Builder instance

      • diagnosisSequence

        public Claim.Item.Builder diagnosisSequence​(java.util.Collection<PositiveInt> diagnosisSequence)
        Diagnosis applicable for this service or product.

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

      • procedureSequence

        public Claim.Item.Builder procedureSequence​(PositiveInt... procedureSequence)
        Procedures applicable for this service or product.

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

        Parameters:
        procedureSequence - Applicable procedures
        Returns:
        A reference to this Builder instance

      • procedureSequence

        public Claim.Item.Builder procedureSequence​(java.util.Collection<PositiveInt> procedureSequence)
        Procedures applicable for this service or product.

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

      • informationSequence

        public Claim.Item.Builder informationSequence​(PositiveInt... informationSequence)
        Exceptions, special conditions and supporting information applicable for this service or product.

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

        Parameters:
        informationSequence - Applicable exception and supporting information
        Returns:
        A reference to this Builder instance

      • informationSequence

        public Claim.Item.Builder informationSequence​(java.util.Collection<PositiveInt> informationSequence)
        Exceptions, special conditions and supporting information applicable for this service or product.

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

      • revenue

        public Claim.Item.Builder revenue​(CodeableConcept revenue)
        The type of revenue or cost center providing the product and/or service.
        Parameters:
        revenue - Revenue or cost center code
        Returns:
        A reference to this Builder instance

      • category

        public Claim.Item.Builder category​(CodeableConcept category)
        Code to identify the general type of benefits under which products and services are provided.
        Parameters:
        category - Benefit classification
        Returns:
        A reference to this Builder instance

      • productOrService

        public Claim.Item.Builder productOrService​(CodeableConcept productOrService)
        When the value is a group code then this item collects a set of related claim details, otherwise this contains the product, service, drug or other billing code for the item.

        This element is required.

        Parameters:
        productOrService - Billing, service, product, or drug code
        Returns:
        A reference to this Builder instance

      • modifier

        public Claim.Item.Builder modifier​(CodeableConcept... modifier)
        Item typification or modifiers codes to convey additional context for the product or service.

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

        Parameters:
        modifier - Product or service billing modifiers
        Returns:
        A reference to this Builder instance

      • modifier

        public Claim.Item.Builder modifier​(java.util.Collection<CodeableConcept> modifier)
        Item typification or modifiers codes to convey additional context for the product or service.

        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:
        modifier - Product or service billing modifiers
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • programCode

        public Claim.Item.Builder programCode​(CodeableConcept... programCode)
        Identifies the program under which this may be recovered.

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

        Parameters:
        programCode - Program the product or service is provided under
        Returns:
        A reference to this Builder instance

      • programCode

        public Claim.Item.Builder programCode​(java.util.Collection<CodeableConcept> programCode)
        Identifies the program under which this may be recovered.

        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:
        programCode - Program the product or service is provided under
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • serviced

        public Claim.Item.Builder serviced​(java.time.LocalDate serviced)
        Convenience method for setting serviced with choice type Date.
        Parameters:
        serviced - Date or dates of service or product delivery
        Returns:
        A reference to this Builder instance
        See Also:
        serviced(Element)

      • serviced

        public Claim.Item.Builder serviced​(Element serviced)
        The date or dates when the service or product was supplied, performed or completed.

        This is a choice element with the following allowed types:

        Parameters:
        serviced - Date or dates of service or product delivery
        Returns:
        A reference to this Builder instance

      • location

        public Claim.Item.Builder location​(Element location)
        Where the product or service was provided.

        This is a choice element with the following allowed types:

        When of type Reference, the allowed resource types for this reference are:
        Parameters:
        location - Place of service or where product was supplied
        Returns:
        A reference to this Builder instance

      • quantity

        public Claim.Item.Builder quantity​(SimpleQuantity quantity)
        The number of repetitions of a service or product.
        Parameters:
        quantity - Count of products or services
        Returns:
        A reference to this Builder instance

      • unitPrice

        public Claim.Item.Builder unitPrice​(Money unitPrice)
        If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.
        Parameters:
        unitPrice - Fee, charge or cost per item
        Returns:
        A reference to this Builder instance

      • factor

        public Claim.Item.Builder factor​(Decimal factor)
        A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
        Parameters:
        factor - Price scaling factor
        Returns:
        A reference to this Builder instance

      • net

        public Claim.Item.Builder net​(Money net)
        The quantity times the unit price for an additional service or product or charge.
        Parameters:
        net - Total item cost
        Returns:
        A reference to this Builder instance

      • udi

        public Claim.Item.Builder udi​(Reference... udi)
        Unique Device Identifiers associated with this line item.

        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:
        udi - Unique device identifier
        Returns:
        A reference to this Builder instance

      • udi

        public Claim.Item.Builder udi​(java.util.Collection<Reference> udi)
        Unique Device Identifiers associated with this line item.

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

      • bodySite

        public Claim.Item.Builder bodySite​(CodeableConcept bodySite)
        Physical service site on the patient (limb, tooth, etc.).
        Parameters:
        bodySite - Anatomical location
        Returns:
        A reference to this Builder instance

      • subSite

        public Claim.Item.Builder subSite​(CodeableConcept... subSite)
        A region or surface of the bodySite, e.g. limb region or tooth surface(s).

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

        Parameters:
        subSite - Anatomical sub-location
        Returns:
        A reference to this Builder instance

      • subSite

        public Claim.Item.Builder subSite​(java.util.Collection<CodeableConcept> subSite)
        A region or surface of the bodySite, e.g. limb region or tooth surface(s).

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

      • encounter

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

        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:
        encounter - Encounters related to this billed item
        Returns:
        A reference to this Builder instance

      • encounter

        public Claim.Item.Builder encounter​(java.util.Collection<Reference> encounter)
        The Encounters during which this Claim was created or to which the creation of this record is tightly 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.

        Allowed resource types for the references:

        Parameters:
        encounter - Encounters related to this billed item
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • detail

        public Claim.Item.Builder detail​(Claim.Item.Detail... detail)
        A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

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

        Parameters:
        detail - Product or service provided
        Returns:
        A reference to this Builder instance

      • detail

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

      • validate

        protected void validate​(Claim.Item item)