Package org.hl7.fhir.r5.model
Class ClaimResponse.AddedItemComponent
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.ClaimResponse.AddedItemComponent
- 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:
ClaimResponse
public static class ClaimResponse.AddedItemComponent
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
Modifier and TypeFieldDescriptionprotected List
<ClaimResponse.AdjudicationComponent> The adjudication results.protected List
<ClaimResponse.BodySiteComponent> Physical location where the service is performed or applies.protected List
<ClaimResponse.AddedItemDetailComponent> The second-tier service adjudications for payor added services.protected List
<PositiveIntType> The sequence number of the details within the claim item which this line is intended to replace.protected DecimalType
A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received.protected List
<PositiveIntType> Claim items which this service line is intended to replace.protected DataType
Where the product or service was provided.protected List
<CodeableConcept> Item typification or modifiers codes to convey additional context for the product or service.protected Money
The total amount claimed for the group (if a grouper) or the addItem.protected List
<PositiveIntType> The numbers associated with notes below which apply to the adjudication of this item.protected CodeableConcept
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.protected CodeableConcept
This contains the end of a range of product, service, drug or other billing codes for the item.protected List
<CodeableConcept> Identifies the program under which this may be recovered.The providers who are authorized for the services rendered to the patient.protected Quantity
The number of repetitions of a service or product.Request or Referral for Goods or Service to be rendered.protected CodeableConcept
The type of revenue or cost center providing the product and/or service.protected ClaimResponse.ReviewOutcomeComponent
The high-level results of the adjudication if adjudication has been performed.protected DataType
The date or dates when the service or product was supplied, performed or completed.protected List
<PositiveIntType> The sequence number of the sub-details within the details within the claim item which this line is intended to replace.protected Money
The total of taxes applicable for this product or service.protected List
<Identifier> Trace number for tracking purposes.protected Money
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.Fields inherited from class org.hl7.fhir.r5.model.BackboneElement
modifierExtension
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddDetailSequence
(int value) addItemSequence
(int value) addNoteNumber
(int value) addSubdetailSequence
(int value) copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(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) boolean
boolean
boolean
boolean
boolean
hasDetailSequence
(int value) boolean
boolean
boolean
boolean
hasItemSequence
(int value) boolean
boolean
boolean
boolean
boolean
boolean
hasNet()
boolean
boolean
hasNoteNumber
(int value) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasSubdetailSequence
(int value) boolean
hasTax()
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAdjudication
(List<ClaimResponse.AdjudicationComponent> theAdjudication) setBodySite
(List<ClaimResponse.BodySiteComponent> theBodySite) setDetail
(List<ClaimResponse.AddedItemDetailComponent> theDetail) setDetailSequence
(List<PositiveIntType> theDetailSequence) setFactor
(double value) setFactor
(long value) setFactor
(BigDecimal value) setFactorElement
(DecimalType value) setItemSequence
(List<PositiveIntType> theItemSequence) setLocation
(DataType value) setModifier
(List<CodeableConcept> theModifier) setNoteNumber
(List<PositiveIntType> theNoteNumber) setProgramCode
(List<CodeableConcept> theProgramCode) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setProvider
(List<Reference> theProvider) setQuantity
(Quantity value) setRequest
(List<Reference> theRequest) setRevenue
(CodeableConcept value) setServiced
(DataType value) setSubdetailSequence
(List<PositiveIntType> theSubdetailSequence) 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, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension
Methods inherited from class org.hl7.fhir.r5.model.Element
addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus
Methods 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, 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
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtension
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
addModifierExtension, getModifierExtension, hasModifierExtension
-
Field Details
-
itemSequence
Claim items which this service line is intended to replace. -
detailSequence
The sequence number of the details within the claim item which this line is intended to replace. -
subdetailSequence
The sequence number of the sub-details within the details within the claim item which this line is intended to replace. -
traceNumber
Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners. -
provider
The providers who are authorized for the services rendered to the patient. -
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. -
request
Request or Referral for Goods or Service to be rendered. -
modifier
Item typification or modifiers codes to convey additional context for the product or service. -
programCode
Identifies the program under which this may be recovered. -
serviced
The date or dates when the service or product was supplied, performed or completed. -
location
Where the product or service was provided. -
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. Net = unit price * quantity * factor. -
bodySite
Physical location where the service is performed or applies. -
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. -
detail
The second-tier service adjudications for payor added services.
-
-
Constructor Details
-
AddedItemComponent
public AddedItemComponent()Constructor
-
-
Method Details
-
getItemSequence
- Returns:
itemSequence
(Claim items which this service line is intended to replace.)
-
setItemSequence
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasItemSequence
-
addItemSequenceElement
- Returns:
itemSequence
(Claim items which this service line is intended to replace.)
-
addItemSequence
- Parameters:
value
-itemSequence
(Claim items which this service line is intended to replace.)
-
hasItemSequence
- Parameters:
value
-itemSequence
(Claim items which this service line is intended to replace.)
-
getDetailSequence
- Returns:
detailSequence
(The sequence number of the details within the claim item which this line is intended to replace.)
-
setDetailSequence
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDetailSequence
-
addDetailSequenceElement
- Returns:
detailSequence
(The sequence number of the details within the claim item which this line is intended to replace.)
-
addDetailSequence
- Parameters:
value
-detailSequence
(The sequence number of the details within the claim item which this line is intended to replace.)
-
hasDetailSequence
- Parameters:
value
-detailSequence
(The sequence number of the details within the claim item which this line is intended to replace.)
-
getSubdetailSequence
- Returns:
subdetailSequence
(The sequence number of the sub-details within the details within the claim item which this line is intended to replace.)
-
setSubdetailSequence
public ClaimResponse.AddedItemComponent setSubdetailSequence(List<PositiveIntType> theSubdetailSequence) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasSubdetailSequence
-
addSubdetailSequenceElement
- Returns:
subdetailSequence
(The sequence number of the sub-details within the details within the claim item which this line is intended to replace.)
-
addSubdetailSequence
- Parameters:
value
-subdetailSequence
(The sequence number of the sub-details within the details within the claim item which this line is intended to replace.)
-
hasSubdetailSequence
- Parameters:
value
-subdetailSequence
(The sequence number of the sub-details within the details within the claim item which this line is intended to replace.)
-
getTraceNumber
- Returns:
traceNumber
(Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.)
-
setTraceNumber
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTraceNumber
-
addTraceNumber
-
addTraceNumber
-
getTraceNumberFirstRep
- Returns:
- The first repetition of repeating field
traceNumber
, creating it if it does not already exist {3}
-
getProvider
- Returns:
provider
(The providers who are authorized for the services rendered to the patient.)
-
setProvider
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasProvider
-
addProvider
-
addProvider
-
getProviderFirstRep
- Returns:
- The first repetition of repeating field
provider
, 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.)
-
getRequest
- Returns:
request
(Request or Referral for Goods or Service to be rendered.)
-
setRequest
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRequest
-
addRequest
-
addRequest
-
getRequestFirstRep
- Returns:
- The first repetition of repeating field
request
, creating it if it does not already exist {3}
-
getModifier
- Returns:
modifier
(Item typification or modifiers codes to convey additional context for the product or service.)
-
setModifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasModifier
-
addModifier
-
addModifier
-
getModifierFirstRep
- Returns:
- The first repetition of repeating field
modifier
, creating it if it does not already exist {3}
-
getProgramCode
- Returns:
programCode
(Identifies the program under which this may be recovered.)
-
setProgramCode
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasProgramCode
-
addProgramCode
-
addProgramCode
-
getProgramCodeFirstRep
- Returns:
- The first repetition of repeating field
programCode
, creating it if it does not already exist {3}
-
getServiced
- Returns:
serviced
(The date or dates when the service or product was supplied, performed or completed.)
-
getServicedDateType
- Returns:
serviced
(The date or dates when the service or product was supplied, performed or completed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasServicedDateType
-
getServicedPeriod
- Returns:
serviced
(The date or dates when the service or product was supplied, performed or completed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasServicedPeriod
-
hasServiced
-
setServiced
- Parameters:
value
-serviced
(The date or dates when the service or product was supplied, performed or completed.)
-
getLocation
- Returns:
location
(Where the product or service was provided.)
-
getLocationCodeableConcept
- Returns:
location
(Where the product or service was provided.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasLocationCodeableConcept
-
getLocationAddress
- Returns:
location
(Where the product or service was provided.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasLocationAddress
-
getLocationReference
- Returns:
location
(Where the product or service was provided.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasLocationReference
-
hasLocation
-
setLocation
- Parameters:
value
-location
(Where the product or service was provided.)
-
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. Net = unit price * quantity * factor.)
-
hasNet
-
setNet
- Parameters:
value
-net
(The total amount claimed for the group (if a grouper) or the addItem. Net = unit price * quantity * factor.)
-
getBodySite
- Returns:
bodySite
(Physical location where the service is performed or applies.)
-
setBodySite
public ClaimResponse.AddedItemComponent setBodySite(List<ClaimResponse.BodySiteComponent> theBodySite) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasBodySite
-
addBodySite
-
addBodySite
-
getBodySiteFirstRep
- Returns:
- The first repetition of repeating field
bodySite
, creating it if it does not already exist {3}
-
getNoteNumber
- Returns:
noteNumber
(The numbers associated with notes below which apply to the adjudication of this item.)
-
setNoteNumber
- Returns:
- Returns a reference to
this
for 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 ClaimResponse.AddedItemComponent setReviewOutcome(ClaimResponse.ReviewOutcomeComponent value) - Parameters:
value
-reviewOutcome
(The high-level results of the adjudication if adjudication has been performed.)
-
getAdjudication
- Returns:
adjudication
(The adjudication results.)
-
setAdjudication
public ClaimResponse.AddedItemComponent setAdjudication(List<ClaimResponse.AdjudicationComponent> theAdjudication) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasAdjudication
-
addAdjudication
-
addAdjudication
-
getAdjudicationFirstRep
- Returns:
- The first repetition of repeating field
adjudication
, creating it if it does not already exist {3}
-
getDetail
- Returns:
detail
(The second-tier service adjudications for payor added services.)
-
setDetail
public ClaimResponse.AddedItemComponent setDetail(List<ClaimResponse.AddedItemDetailComponent> theDetail) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasDetail
-
addDetail
-
addDetail
-
getDetailFirstRep
- Returns:
- The first repetition of repeating field
detail
, creating it if it does not already exist {3}
-
listChildren
- Overrides:
listChildren
in classBackboneElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
- Specified by:
copy
in classBackboneElement
-
copyValues
-
equalsDeep
- Overrides:
equalsDeep
in classBackboneElement
-
equalsShallow
- Overrides:
equalsShallow
in classBackboneElement
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classBackboneElement
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classBackboneElement
- Returns:
- the FHIR type name of the instance (not the java class name)
-