Package org.hl7.fhir.r4.model
Class ExplanationOfBenefit.ItemComponent
java.lang.Object
org.hl7.fhir.r4.model.Base
org.hl7.fhir.r4.model.Element
org.hl7.fhir.r4.model.BackboneElement
org.hl7.fhir.r4.model.ExplanationOfBenefit.ItemComponent
- 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.ItemComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected List
<ExplanationOfBenefit.AdjudicationComponent> If this item is a group then the values here are a summary of the adjudication of the detail items.protected CodeableConcept
Physical service site on the patient (limb, tooth, etc.).protected List
<PositiveIntType> Care team members related to this service or product.protected CodeableConcept
Code to identify the general type of benefits under which products and services are provided.protected List
<ExplanationOfBenefit.DetailComponent> Second-tier of goods and services.protected List
<PositiveIntType> Diagnoses applicable for this service or product.A billed item may include goods or services provided in multiple encounters.The actual objects that are the target of the reference (A billed item may include goods or services provided in multiple encounters.)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> Exceptions, special conditions and supporting information applicable for this service or product.protected Type
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 quantity times the unit price for an additional service or product or charge.protected List
<PositiveIntType> The numbers associated with notes below which apply to the adjudication of this item.protected List
<PositiveIntType> Procedures applicable for this service or product.protected CodeableConcept
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.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.protected PositiveIntType
A number to uniquely identify item entries.protected Type
The date or dates when the service or product was supplied, performed or completed.protected List
<CodeableConcept> A region or surface of the bodySite, e.g.Unique Device Identifiers associated with this line item.The actual objects that are the target of the reference (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.r4.model.BackboneElement
modifierExtension
-
Constructor Summary
ConstructorDescriptionConstructorItemComponent
(PositiveIntType sequence, CodeableConcept productOrService) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddCareTeamSequence
(int value) addDiagnosisSequence
(int value) Deprecated.Use Reference#setResource(IBaseResource) insteadaddInformationSequence
(int value) addNoteNumber
(int value) addProcedureSequence
(int value) addUdi()
Deprecated.Use Reference#setResource(IBaseResource) insteadcopy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
Deprecated.Use Reference#setResource(IBaseResource) insteadgetNamedProperty
(int _hash, String _name, boolean _checkValid) getNet()
Base[]
getProperty
(int hash, String name, boolean checkValid) int
String[]
getTypesForProperty
(int hash, String name) getUdi()
Deprecated.Use Reference#setResource(IBaseResource) insteadboolean
boolean
boolean
boolean
hasCareTeamSequence
(int value) boolean
boolean
boolean
boolean
hasDiagnosisSequence
(int value) boolean
boolean
boolean
boolean
boolean
hasInformationSequence
(int value) boolean
boolean
boolean
boolean
boolean
boolean
hasNet()
boolean
boolean
hasNoteNumber
(int value) boolean
boolean
hasProcedureSequence
(int value) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
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) setBodySite
(CodeableConcept value) setCareTeamSequence
(List<PositiveIntType> theCareTeamSequence) setCategory
(CodeableConcept value) setDetail
(List<ExplanationOfBenefit.DetailComponent> theDetail) setDiagnosisSequence
(List<PositiveIntType> theDiagnosisSequence) setEncounter
(List<Reference> theEncounter) setFactor
(double value) setFactor
(long value) setFactor
(BigDecimal value) setFactorElement
(DecimalType value) setInformationSequence
(List<PositiveIntType> theInformationSequence) setLocation
(Type value) setModifier
(List<CodeableConcept> theModifier) setNoteNumber
(List<PositiveIntType> theNoteNumber) setProcedureSequence
(List<PositiveIntType> theProcedureSequence) 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) setServiced
(Type value) setSubSite
(List<CodeableConcept> theSubSite) setUnitPrice
(Money value) Methods inherited from class org.hl7.fhir.r4.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.r4.model.Element
addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, 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 number to uniquely identify item entries. -
careTeamSequence
Care team members related to this service or product. -
diagnosisSequence
Diagnoses applicable for this service or product. -
procedureSequence
Procedures applicable for this service or product. -
informationSequence
Exceptions, special conditions and supporting information applicable for this service or product. -
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 claim details, otherwise this contains the product, service, drug or other billing code for the item. -
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. -
net
The quantity times the unit price for an additional service or product or charge. -
udi
Unique Device Identifiers associated with this line item. -
udiTarget
The actual objects that are the target of the reference (Unique Device Identifiers associated with this line item.) -
bodySite
Physical service site on the patient (limb, tooth, etc.). -
subSite
A region or surface of the bodySite, e.g. limb region or tooth surface(s). -
encounter
A billed item may include goods or services provided in multiple encounters. -
encounterTarget
The actual objects that are the target of the reference (A billed item may include goods or services provided in multiple encounters.) -
noteNumber
The numbers associated with notes below which apply to the adjudication of this item. -
adjudication
If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item. -
detail
Second-tier of goods and services.
-
-
Constructor Details
-
ItemComponent
public ItemComponent()Constructor -
ItemComponent
Constructor
-
-
Method Details
-
getSequenceElement
- Returns:
sequence
(A number to uniquely identify item entries.). 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 number to uniquely identify item entries.). This is the underlying object with id, value and extensions. The accessor "getSequence" gives direct access to the value
-
getSequence
- Returns:
- A number to uniquely identify item entries.
-
setSequence
- Parameters:
value
- A number to uniquely identify item entries.
-
getCareTeamSequence
- Returns:
careTeamSequence
(Care team members related to this service or product.)
-
setCareTeamSequence
public ExplanationOfBenefit.ItemComponent setCareTeamSequence(List<PositiveIntType> theCareTeamSequence) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasCareTeamSequence
-
addCareTeamSequenceElement
- Returns:
careTeamSequence
(Care team members related to this service or product.)
-
addCareTeamSequence
- Parameters:
value
-careTeamSequence
(Care team members related to this service or product.)
-
hasCareTeamSequence
- Parameters:
value
-careTeamSequence
(Care team members related to this service or product.)
-
getDiagnosisSequence
- Returns:
diagnosisSequence
(Diagnoses applicable for this service or product.)
-
setDiagnosisSequence
public ExplanationOfBenefit.ItemComponent setDiagnosisSequence(List<PositiveIntType> theDiagnosisSequence) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasDiagnosisSequence
-
addDiagnosisSequenceElement
- Returns:
diagnosisSequence
(Diagnoses applicable for this service or product.)
-
addDiagnosisSequence
- Parameters:
value
-diagnosisSequence
(Diagnoses applicable for this service or product.)
-
hasDiagnosisSequence
- Parameters:
value
-diagnosisSequence
(Diagnoses applicable for this service or product.)
-
getProcedureSequence
- Returns:
procedureSequence
(Procedures applicable for this service or product.)
-
setProcedureSequence
public ExplanationOfBenefit.ItemComponent setProcedureSequence(List<PositiveIntType> theProcedureSequence) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasProcedureSequence
-
addProcedureSequenceElement
- Returns:
procedureSequence
(Procedures applicable for this service or product.)
-
addProcedureSequence
- Parameters:
value
-procedureSequence
(Procedures applicable for this service or product.)
-
hasProcedureSequence
- Parameters:
value
-procedureSequence
(Procedures applicable for this service or product.)
-
getInformationSequence
- Returns:
informationSequence
(Exceptions, special conditions and supporting information applicable for this service or product.)
-
setInformationSequence
public ExplanationOfBenefit.ItemComponent setInformationSequence(List<PositiveIntType> theInformationSequence) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasInformationSequence
-
addInformationSequenceElement
- Returns:
informationSequence
(Exceptions, special conditions and supporting information applicable for this service or product.)
-
addInformationSequence
- Parameters:
value
-informationSequence
(Exceptions, special conditions and supporting information applicable for this service or product.)
-
hasInformationSequence
- Parameters:
value
-informationSequence
(Exceptions, special conditions and supporting information applicable for this service or product.)
-
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 claim details, otherwise this contains the product, service, drug or other billing code for the item.)
-
hasProductOrService
-
setProductOrService
- Parameters:
value
-productOrService
(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.)
-
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
-
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
-
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.
-
getNet
- Returns:
net
(The quantity times the unit price for an additional service or product or charge.)
-
hasNet
-
setNet
- Parameters:
value
-net
(The quantity times the unit price for an additional service or product or charge.)
-
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
-
getUdiTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addUdiTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getBodySite
- Returns:
bodySite
(Physical service site on the patient (limb, tooth, etc.).)
-
hasBodySite
-
setBodySite
- Parameters:
value
-bodySite
(Physical service site on the patient (limb, tooth, etc.).)
-
getSubSite
- Returns:
subSite
(A region or surface of the bodySite, e.g. limb region or tooth surface(s).)
-
setSubSite
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSubSite
-
addSubSite
-
addSubSite
-
getSubSiteFirstRep
- Returns:
- The first repetition of repeating field
subSite
, creating it if it does not already exist
-
getEncounter
- Returns:
encounter
(A billed item may include goods or services provided in multiple encounters.)
-
setEncounter
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEncounter
-
addEncounter
-
addEncounter
-
getEncounterFirstRep
- Returns:
- The first repetition of repeating field
encounter
, creating it if it does not already exist
-
getEncounterTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addEncounterTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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.)
-
getAdjudication
- Returns:
adjudication
(If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.)
-
setAdjudication
public ExplanationOfBenefit.ItemComponent 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
-
getDetail
- Returns:
detail
(Second-tier of goods and services.)
-
setDetail
public ExplanationOfBenefit.ItemComponent setDetail(List<ExplanationOfBenefit.DetailComponent> 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
-
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
-