
Package org.hl7.fhir.r5.model
Class ExplanationOfBenefit.AddedItemDetailComponent
java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.Element
org.hl7.fhir.r5.model.BackboneElement
org.hl7.fhir.r5.model.ExplanationOfBenefit.AddedItemDetailComponent
- 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:
ExplanationOfBenefit
public static class ExplanationOfBenefit.AddedItemDetailComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected List<ExplanationOfBenefit.AdjudicationComponent> The adjudication results.protected DecimalTypeA real number that represents a multiplier used in determining the overall value of services delivered and/or goods received.protected List<CodeableConcept> Item typification or modifiers codes to convey additional context for the product or service.protected MoneyThe total amount claimed for the group (if a grouper) or the addItem.detail.protected List<PositiveIntType> The numbers associated with notes below which apply to the adjudication of this item.protected MoneyThe amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.protected CodeableConceptWhen the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item.protected CodeableConceptThis contains the end of a range of product, service, drug or other billing codes for the item.protected QuantityThe number of repetitions of a service or product.protected CodeableConceptThe type of revenue or cost center providing the product and/or service.The high-level results of the adjudication if adjudication has been performed.The third-tier service adjudications for payor added services.protected MoneyThe total of taxes applicable for this product or service.protected List<Identifier> Trace number for tracking purposes.protected MoneyIf 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.Fields inherited from class org.hl7.fhir.r5.model.BackboneElement
modifierExtension -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddNoteNumber(int value) copy()voidbooleanequalsDeep(Base other_) booleanequalsShallow(Base other_) fhirType()getNamedProperty(int _hash, String _name, boolean _checkValid) getNet()Base[]getProperty(int hash, String name, boolean checkValid) getTax()String[]getTypesForProperty(int hash, String name) booleanbooleanbooleanbooleanbooleanhasNet()booleanbooleanhasNoteNumber(int value) booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasTax()booleanbooleanbooleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) voidremoveChild(String name, Base value) setAdjudication(List<ExplanationOfBenefit.AdjudicationComponent> theAdjudication) setFactor(double value) setFactor(long value) setFactor(BigDecimal value) setFactorElement(DecimalType value) setModifier(List<CodeableConcept> theModifier) setNoteNumber(List<PositiveIntType> theNoteNumber) setPatientPaid(Money value) setProperty(int hash, String name, Base value) setProperty(String name, Base value) setQuantity(Quantity value) setRevenue(CodeableConcept value) setTraceNumber(List<Identifier> theTraceNumber) setUnitPrice(Money value) Methods inherited from class org.hl7.fhir.r5.model.BackboneElement
addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getExtensionValue, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtensionMethods inherited from class org.hl7.fhir.r5.model.Element
addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatusMethods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtmlMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtensionMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
addModifierExtension, getModifierExtension, hasModifierExtension
-
Field Details
-
traceNumber
Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners. -
revenue
The type of revenue or cost center providing the product and/or service. -
productOrService
When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used. -
productOrServiceEnd
This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims. -
modifier
Item typification or modifiers codes to convey additional context for the product or service. -
patientPaid
The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services. -
quantity
The number of repetitions of a service or product. -
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. -
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. -
tax
The total of taxes applicable for this product or service. -
net
The total amount claimed for the group (if a grouper) or the addItem.detail. Net = unit price * quantity * factor. -
noteNumber
The numbers associated with notes below which apply to the adjudication of this item. -
reviewOutcome
The high-level results of the adjudication if adjudication has been performed. -
adjudication
The adjudication results. -
subDetail
The third-tier service adjudications for payor added services.
-
-
Constructor Details
-
AddedItemDetailComponent
public AddedItemDetailComponent()Constructor
-
-
Method Details
-
getTraceNumber
- Returns:
traceNumber(Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.)
-
setTraceNumber
public ExplanationOfBenefit.AddedItemDetailComponent setTraceNumber(List<Identifier> theTraceNumber) - Returns:
- Returns a reference to
thisfor easy method chaining
-
hasTraceNumber
-
addTraceNumber
-
addTraceNumber
-
getTraceNumberFirstRep
- Returns:
- The first repetition of repeating field
traceNumber, creating it if it does not already exist {3}
-
getRevenue
- Returns:
revenue(The type of revenue or cost center providing the product and/or service.)
-
hasRevenue
-
setRevenue
- Parameters:
value-revenue(The type of revenue or cost center providing the product and/or service.)
-
getProductOrService
- Returns:
productOrService(When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.)
-
hasProductOrService
-
setProductOrService
- Parameters:
value-productOrService(When the value is a group code then this item collects a set of related item details, otherwise this contains the product, service, drug or other billing code for the item. This element may be the start of a range of .productOrService codes used in conjunction with .productOrServiceEnd or it may be a solo element where .productOrServiceEnd is not used.)
-
getProductOrServiceEnd
- Returns:
productOrServiceEnd(This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.)
-
hasProductOrServiceEnd
-
setProductOrServiceEnd
- Parameters:
value-productOrServiceEnd(This contains the end of a range of product, service, drug or other billing codes for the item. This element is not used when the .productOrService is a group code. This value may only be present when a .productOfService code has been provided to convey the start of the range. Typically this value may be used only with preauthorizations and not with claims.)
-
getModifier
- Returns:
modifier(Item typification or modifiers codes to convey additional context for the product or service.)
-
setModifier
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasModifier
-
addModifier
-
addModifier
-
getModifierFirstRep
- Returns:
- The first repetition of repeating field
modifier, creating it if it does not already exist {3}
-
getPatientPaid
- Returns:
patientPaid(The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.)
-
hasPatientPaid
-
setPatientPaid
- Parameters:
value-patientPaid(The amount paid by the patient, in total at the claim claim level or specifically for the item and detail level, to the provider for goods and services.)
-
getQuantity
- Returns:
quantity(The number of repetitions of a service or product.)
-
hasQuantity
-
setQuantity
- Parameters:
value-quantity(The number of repetitions of a service or product.)
-
getUnitPrice
- Returns:
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.)
-
hasUnitPrice
-
setUnitPrice
- Parameters:
value-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.)
-
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
-
hasFactorElement
-
hasFactor
-
setFactorElement
- 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
- 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
- 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
- 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
- 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.
-
getTax
- Returns:
tax(The total of taxes applicable for this product or service.)
-
hasTax
-
setTax
- Parameters:
value-tax(The total of taxes applicable for this product or service.)
-
getNet
- Returns:
net(The total amount claimed for the group (if a grouper) or the addItem.detail. Net = unit price * quantity * factor.)
-
hasNet
-
setNet
- Parameters:
value-net(The total amount claimed for the group (if a grouper) or the addItem.detail. Net = unit price * quantity * factor.)
-
getNoteNumber
- Returns:
noteNumber(The numbers associated with notes below which apply to the adjudication of this item.)
-
setNoteNumber
public ExplanationOfBenefit.AddedItemDetailComponent setNoteNumber(List<PositiveIntType> theNoteNumber) - Returns:
- Returns a reference to
thisfor easy method chaining
-
hasNoteNumber
-
addNoteNumberElement
- Returns:
noteNumber(The numbers associated with notes below which apply to the adjudication of this item.)
-
addNoteNumber
- Parameters:
value-noteNumber(The numbers associated with notes below which apply to the adjudication of this item.)
-
hasNoteNumber
- Parameters:
value-noteNumber(The numbers associated with notes below which apply to the adjudication of this item.)
-
getReviewOutcome
- Returns:
reviewOutcome(The high-level results of the adjudication if adjudication has been performed.)
-
hasReviewOutcome
-
setReviewOutcome
public ExplanationOfBenefit.AddedItemDetailComponent setReviewOutcome(ExplanationOfBenefit.ItemReviewOutcomeComponent value) - Parameters:
value-reviewOutcome(The high-level results of the adjudication if adjudication has been performed.)
-
getAdjudication
- Returns:
adjudication(The adjudication results.)
-
setAdjudication
public ExplanationOfBenefit.AddedItemDetailComponent setAdjudication(List<ExplanationOfBenefit.AdjudicationComponent> theAdjudication) - Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAdjudication
-
addAdjudication
-
addAdjudication
-
getAdjudicationFirstRep
- Returns:
- The first repetition of repeating field
adjudication, creating it if it does not already exist {3}
-
getSubDetail
- Returns:
subDetail(The third-tier service adjudications for payor added services.)
-
setSubDetail
public ExplanationOfBenefit.AddedItemDetailComponent setSubDetail(List<ExplanationOfBenefit.AddedItemDetailSubDetailComponent> theSubDetail) - Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSubDetail
-
addSubDetail
-
addSubDetail
-
getSubDetailFirstRep
- Returns:
- The first repetition of repeating field
subDetail, creating it if it does not already exist {3}
-
listChildren
- Overrides:
listChildrenin classBackboneElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChildin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makePropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChildin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
- Specified by:
copyin classBackboneElement
-
copyValues
-
equalsDeep
- Overrides:
equalsDeepin classBackboneElement
-
equalsShallow
- Overrides:
equalsShallowin classBackboneElement
-
isEmpty
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classBackboneElement
-
fhirType
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classBackboneElement- Returns:
- the FHIR type name of the instance (not the java class name)
-