Package org.hl7.fhir.r5.model
Class ExplanationOfBenefit.DetailComponent
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.DetailComponent
- 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.DetailComponent
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
<ExplanationOfBenefit.AdjudicationComponent> The adjudication results.protected CodeableConcept
Code to identify the general type of benefits under which products and services are provided.protected DecimalType
A 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 Money
The total amount claimed for the group (if a grouper) or the line item.detail.protected List
<PositiveIntType> The numbers associated with notes below which apply to the adjudication of this item.protected Money
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.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.protected Quantity
The number of repetitions of a service or product.protected CodeableConcept
The type of revenue or cost center providing the product and/or service.The high-level results of the adjudication if adjudication has been performed.protected PositiveIntType
A claim detail line.protected List
<ExplanationOfBenefit.SubDetailComponent> Third-tier of goods and services.protected Money
The total of taxes applicable for this product or service.protected List
<Identifier> Trace number for tracking purposes.Unique Device Identifiers associated with this line item.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 TypeMethodDescriptionaddNoteNumber
(int value) addUdi()
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) int
getTax()
String[]
getTypesForProperty
(int hash, String name) getUdi()
boolean
boolean
boolean
boolean
boolean
boolean
hasNet()
boolean
boolean
hasNoteNumber
(int value) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasTax()
boolean
boolean
hasUdi()
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAdjudication
(List<ExplanationOfBenefit.AdjudicationComponent> theAdjudication) setCategory
(CodeableConcept value) setFactor
(double value) setFactor
(long value) setFactor
(BigDecimal value) setFactorElement
(DecimalType value) setModifier
(List<CodeableConcept> theModifier) setNoteNumber
(List<PositiveIntType> theNoteNumber) setPatientPaid
(Money value) setProgramCode
(List<CodeableConcept> theProgramCode) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setQuantity
(Quantity value) setRevenue
(CodeableConcept value) setSequence
(int value) setSubDetail
(List<ExplanationOfBenefit.SubDetailComponent> theSubDetail) 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
-
sequence
A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items. -
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. -
category
Code to identify the general type of benefits under which products and services are provided. -
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. -
programCode
Identifies the program under which this may be recovered. -
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 line item.detail. Net = unit price * quantity * factor. -
udi
Unique Device Identifiers associated with this line item. -
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
Third-tier of goods and services.
-
-
Constructor Details
-
DetailComponent
public DetailComponent()Constructor -
DetailComponent
Constructor
-
-
Method Details
-
getSequenceElement
- Returns:
sequence
(A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.). This is the underlying object with id, value and extensions. The accessor "getSequence" gives direct access to the value
-
hasSequenceElement
-
hasSequence
-
setSequenceElement
- Parameters:
value
-sequence
(A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.). This is the underlying object with id, value and extensions. The accessor "getSequence" gives direct access to the value
-
getSequence
- Returns:
- A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
-
setSequence
- Parameters:
value
- A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.
-
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}
-
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.)
-
getCategory
- Returns:
category
(Code to identify the general type of benefits under which products and services are provided.)
-
hasCategory
-
setCategory
- Parameters:
value
-category
(Code to identify the general type of benefits under which products and services are provided.)
-
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
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}
-
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 line item.detail. Net = unit price * quantity * factor.)
-
hasNet
-
setNet
- Parameters:
value
-net
(The total amount claimed for the group (if a grouper) or the line item.detail. Net = unit price * quantity * factor.)
-
getUdi
- Returns:
udi
(Unique Device Identifiers associated with this line item.)
-
setUdi
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUdi
-
addUdi
-
addUdi
-
getUdiFirstRep
- Returns:
- The first repetition of repeating field
udi
, 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 ExplanationOfBenefit.DetailComponent 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.DetailComponent setAdjudication(List<ExplanationOfBenefit.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}
-
getSubDetail
- Returns:
subDetail
(Third-tier of goods and services.)
-
setSubDetail
public ExplanationOfBenefit.DetailComponent setSubDetail(List<ExplanationOfBenefit.SubDetailComponent> theSubDetail) - Returns:
- Returns a reference to
this
for 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:
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)
-