Package org.hl7.fhir.dstu2016may.model

Class Claim.ItemsComponent

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
    Enclosing class:
    Claim
    public static class Claim.ItemsComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
    See Also:
    Serialized Form

    • Field Detail

      • type

        protected Coding type
        The type of product or service.

      • provider

        protected Type provider
        The practitioner who is responsible for the services rendered to the patient.

      • supervisor

        protected Type supervisor
        The practitioner who is supervising the work of the servicing provider(s).

      • service

        protected Coding service
        If a grouping item then 'GROUP' otherwise it is a node therefore a code to indicate the Professional Service or Product supplied.

      • modifier

        protected List<Coding> modifier
        Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.

      • programCode

        protected List<Coding> programCode
        For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.

      • serviced

        protected Type serviced
        The date or dates when the enclosed suite of services were performed or completed.

      • place

        protected Coding place
        Where the service was provided.

      • unitPrice

        protected Money unitPrice
        If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.

      • factor

        protected DecimalType 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.

      • points

        protected DecimalType points
        An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.

      • net

        protected Money net
        The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.

      • udi

        protected List<Reference> udi
        List of Unique Device Identifiers associated with this line item.

      • udiTarget

        protected List<Device> udiTarget
        The actual objects that are the target of the reference (List of Unique Device Identifiers associated with this line item.)

      • bodySite

        protected Coding bodySite
        Physical service site on the patient (limb, tooth, etc).

      • subSite

        protected List<Coding> subSite
        A region or surface of the site, eg. limb region or tooth surface(s).

    • Method Detail

      • getSequenceElement

        public PositiveIntType getSequenceElement()
        Returns:
        sequence (A service line number.). This is the underlying object with id, value and extensions. The accessor "getSequence" gives direct access to the value

      • getSequence

        public int getSequence()
        Returns:
        A service line number.

      • hasType

        public boolean hasType()

      • getProvider

        public Type getProvider()
        Returns:
        provider (The practitioner who is responsible for the services rendered to the patient.)

      • getProviderIdentifier

        public Identifier getProviderIdentifier()
                                 throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        provider (The practitioner who is responsible for the services rendered to the patient.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getProviderReference

        public Reference getProviderReference()
                               throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        provider (The practitioner who is responsible for the services rendered to the patient.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getSupervisor

        public Type getSupervisor()
        Returns:
        supervisor (The practitioner who is supervising the work of the servicing provider(s).)

      • getSupervisorIdentifier

        public Identifier getSupervisorIdentifier()
                                   throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        supervisor (The practitioner who is supervising the work of the servicing provider(s).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getSupervisorReference

        public Reference getSupervisorReference()
                                 throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        supervisor (The practitioner who is supervising the work of the servicing provider(s).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getService

        public Coding getService()
        Returns:
        service (If a grouping item then 'GROUP' otherwise it is a node therefore a code to indicate the Professional Service or Product supplied.)

      • setService

        public Claim.ItemsComponent setService​(Coding value)
        Parameters:
        value - service (If a grouping item then 'GROUP' otherwise it is a node therefore a code to indicate the Professional Service or Product supplied.)

      • getModifier

        public List<Coding> getModifier()
        Returns:
        modifier (Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.)

      • addModifier

        public Coding addModifier()
        Returns:
        modifier (Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.)

      • getProgramCode

        public List<Coding> getProgramCode()
        Returns:
        programCode (For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.)

      • addProgramCode

        public Coding addProgramCode()
        Returns:
        programCode (For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.)

      • getServiced

        public Type getServiced()
        Returns:
        serviced (The date or dates when the enclosed suite of services were performed or completed.)

      • getServicedDateType

        public DateType getServicedDateType()
                             throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        serviced (The date or dates when the enclosed suite of services were performed or completed.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getServicedPeriod

        public Period getServicedPeriod()
                         throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        serviced (The date or dates when the enclosed suite of services were performed or completed.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getUnitPrice

        public Money getUnitPrice()
        Returns:
        unitPrice (If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.)

      • setUnitPrice

        public Claim.ItemsComponent setUnitPrice​(Money value)
        Parameters:
        value - unitPrice (If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.)

      • getFactorElement

        public DecimalType getFactorElement()
        Returns:
        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.). This is the underlying object with id, value and extensions. The accessor "getFactor" gives direct access to the value

      • setFactorElement

        public Claim.ItemsComponent setFactorElement​(DecimalType value)
        Parameters:
        value - 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.). This is the underlying object with id, value and extensions. The accessor "getFactor" gives direct access to the value

      • getFactor

        public BigDecimal getFactor()
        Returns:
        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.

      • setFactor

        public Claim.ItemsComponent setFactor​(BigDecimal value)
        Parameters:
        value - 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.

      • setFactor

        public Claim.ItemsComponent setFactor​(long value)
        Parameters:
        value - 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.

      • setFactor

        public Claim.ItemsComponent setFactor​(double value)
        Parameters:
        value - 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.

      • getPointsElement

        public DecimalType getPointsElement()
        Returns:
        points (An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.). This is the underlying object with id, value and extensions. The accessor "getPoints" gives direct access to the value

      • setPointsElement

        public Claim.ItemsComponent setPointsElement​(DecimalType value)
        Parameters:
        value - points (An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.). This is the underlying object with id, value and extensions. The accessor "getPoints" gives direct access to the value

      • getPoints

        public BigDecimal getPoints()
        Returns:
        An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.

      • setPoints

        public Claim.ItemsComponent setPoints​(BigDecimal value)
        Parameters:
        value - An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.

      • setPoints

        public Claim.ItemsComponent setPoints​(long value)
        Parameters:
        value - An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.

      • setPoints

        public Claim.ItemsComponent setPoints​(double value)
        Parameters:
        value - An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.

      • getNet

        public Money getNet()
        Returns:
        net (The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.)

      • hasNet

        public boolean hasNet()

      • setNet

        public Claim.ItemsComponent setNet​(Money value)
        Parameters:
        value - net (The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.)

      • getUdi

        public List<Reference> getUdi()
        Returns:
        udi (List of Unique Device Identifiers associated with this line item.)

      • hasUdi

        public boolean hasUdi()

      • addUdi

        public Reference addUdi()
        Returns:
        udi (List of Unique Device Identifiers associated with this line item.)

      • getUdiTarget

        public List<Device> getUdiTarget()
        Returns:
        udi (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. List of Unique Device Identifiers associated with this line item.)

      • addUdiTarget

        public Device addUdiTarget()
        Returns:
        udi (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. List of Unique Device Identifiers associated with this line item.)

      • getSubSite

        public List<Coding> getSubSite()
        Returns:
        subSite (A region or surface of the site, eg. limb region or tooth surface(s).)

      • addSubSite

        public Coding addSubSite()
        Returns:
        subSite (A region or surface of the site, eg. limb region or tooth surface(s).)

      • makeProperty

        public Base makeProperty​(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class BackboneElement
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class BackboneElement