Package com.ibm.fhir.model.resource
Class Claim.Item
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.type.Element
-
- com.ibm.fhir.model.type.BackboneElement
-
- com.ibm.fhir.model.resource.Claim.Item
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- Claim
public static class Claim.Item extends BackboneElement
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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Claim.Item.Builder
static class
Claim.Item.Detail
A claim detail line.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static Claim.Item.Builder
builder()
boolean
equals(java.lang.Object obj)
CodeableConcept
getBodySite()
Physical service site on the patient (limb, tooth, etc.).java.util.List<PositiveInt>
getCareTeamSequence()
CareTeam members related to this service or product.CodeableConcept
getCategory()
Code to identify the general type of benefits under which products and services are provided.java.util.List<Claim.Item.Detail>
getDetail()
A claim detail line.java.util.List<PositiveInt>
getDiagnosisSequence()
Diagnosis applicable for this service or product.java.util.List<Reference>
getEncounter()
The Encounters during which this Claim was created or to which the creation of this record is tightly associated.Decimal
getFactor()
A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received.java.util.List<PositiveInt>
getInformationSequence()
Exceptions, special conditions and supporting information applicable for this service or product.Element
getLocation()
Where the product or service was provided.java.util.List<CodeableConcept>
getModifier()
Item typification or modifiers codes to convey additional context for the product or service.Money
getNet()
The quantity times the unit price for an additional service or product or charge.java.util.List<PositiveInt>
getProcedureSequence()
Procedures applicable for this service or product.CodeableConcept
getProductOrService()
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.java.util.List<CodeableConcept>
getProgramCode()
Identifies the program under which this may be recovered.SimpleQuantity
getQuantity()
The number of repetitions of a service or product.CodeableConcept
getRevenue()
The type of revenue or cost center providing the product and/or service.PositiveInt
getSequence()
A number to uniquely identify item entries.Element
getServiced()
The date or dates when the service or product was supplied, performed or completed.java.util.List<CodeableConcept>
getSubSite()
A region or surface of the bodySite, e.g.java.util.List<Reference>
getUdi()
Unique Device Identifiers associated with this line item.Money
getUnitPrice()
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.boolean
hasChildren()
int
hashCode()
Claim.Item.Builder
toBuilder()
Create a new Builder from the contents of this Element-
Methods inherited from class com.ibm.fhir.model.type.BackboneElement
getModifierExtension
-
-
-
-
Method Detail
-
getSequence
public PositiveInt getSequence()
A number to uniquely identify item entries.- Returns:
- An immutable object of type
PositiveInt
that is non-null.
-
getCareTeamSequence
public java.util.List<PositiveInt> getCareTeamSequence()
CareTeam members related to this service or product.- Returns:
- An unmodifiable list containing immutable objects of type
PositiveInt
that may be empty.
-
getDiagnosisSequence
public java.util.List<PositiveInt> getDiagnosisSequence()
Diagnosis applicable for this service or product.- Returns:
- An unmodifiable list containing immutable objects of type
PositiveInt
that may be empty.
-
getProcedureSequence
public java.util.List<PositiveInt> getProcedureSequence()
Procedures applicable for this service or product.- Returns:
- An unmodifiable list containing immutable objects of type
PositiveInt
that may be empty.
-
getInformationSequence
public java.util.List<PositiveInt> getInformationSequence()
Exceptions, special conditions and supporting information applicable for this service or product.- Returns:
- An unmodifiable list containing immutable objects of type
PositiveInt
that may be empty.
-
getRevenue
public CodeableConcept getRevenue()
The type of revenue or cost center providing the product and/or service.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getCategory
public CodeableConcept getCategory()
Code to identify the general type of benefits under which products and services are provided.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getProductOrService
public CodeableConcept getProductOrService()
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.- Returns:
- An immutable object of type
CodeableConcept
that is non-null.
-
getModifier
public java.util.List<CodeableConcept> getModifier()
Item typification or modifiers codes to convey additional context for the product or service.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getProgramCode
public java.util.List<CodeableConcept> getProgramCode()
Identifies the program under which this may be recovered.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getServiced
public Element getServiced()
The date or dates when the service or product was supplied, performed or completed.
-
getLocation
public Element getLocation()
Where the product or service was provided.- Returns:
- An immutable object of type
CodeableConcept
,Address
orReference
that may be null.
-
getQuantity
public SimpleQuantity getQuantity()
The number of repetitions of a service or product.- Returns:
- An immutable object of type
SimpleQuantity
that may be null.
-
getUnitPrice
public Money getUnitPrice()
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.- Returns:
- An immutable object of type
Money
that may be null.
-
getFactor
public Decimal getFactor()
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.- Returns:
- An immutable object of type
Decimal
that may be null.
-
getNet
public Money getNet()
The quantity times the unit price for an additional service or product or charge.- Returns:
- An immutable object of type
Money
that may be null.
-
getUdi
public java.util.List<Reference> getUdi()
Unique Device Identifiers associated with this line item.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getBodySite
public CodeableConcept getBodySite()
Physical service site on the patient (limb, tooth, etc.).- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getSubSite
public java.util.List<CodeableConcept> getSubSite()
A region or surface of the bodySite, e.g. limb region or tooth surface(s).- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getEncounter
public java.util.List<Reference> getEncounter()
The Encounters during which this Claim was created or to which the creation of this record is tightly associated.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getDetail
public java.util.List<Claim.Item.Detail> getDetail()
A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.- Returns:
- An unmodifiable list containing immutable objects of type
Claim.Item.Detail
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classBackboneElement
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public Claim.Item.Builder toBuilder()
Description copied from class:Element
Create a new Builder from the contents of this Element- Specified by:
toBuilder
in classBackboneElement
-
builder
public static Claim.Item.Builder builder()
-
-