Package org.hl7.fhir.r5.model

Class Claim.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.Claim.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:

Claim

public static class Claim.DetailComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

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

Fields

Modifier and Type	Field	Description
protected CodeableConcept	category	Code to identify the general type of benefits under which products and services are provided.
protected DecimalType	factor	A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received.
protected List<CodeableConcept>	modifier	Item typification or modifiers codes to convey additional context for the product or service.
protected Money	net	The total amount claimed for the group (if a grouper) or the line item.detail.
protected Money	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.
protected CodeableConcept	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.
protected CodeableConcept	productOrServiceEnd	This contains the end of a range of product, service, drug or other billing codes for the item.
protected List<CodeableConcept>	programCode	Identifies the program under which this may be recovered.
protected Quantity	quantity	The number of repetitions of a service or product.
protected CodeableConcept	revenue	The type of revenue or cost center providing the product and/or service.
protected PositiveIntType	sequence	A number to uniquely identify item entries.
protected List<Claim.SubDetailComponent>	subDetail	A claim detail line.
protected Money	tax	The total of taxes applicable for this product or service.
protected List<Identifier>	traceNumber	Trace number for tracking purposes.
protected List<Reference>	udi	Unique Device Identifiers associated with this line item.
protected Money	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.

Fields inherited from class org.hl7.fhir.r5.model.BackboneElement

modifierExtension

Fields inherited from class org.hl7.fhir.r5.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
DetailComponent()	Constructor
DetailComponent(int sequence)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CodeableConcept	addModifier()
Claim.DetailComponent	addModifier(CodeableConcept t)
CodeableConcept	addProgramCode()
Claim.DetailComponent	addProgramCode(CodeableConcept t)
Claim.SubDetailComponent	addSubDetail()
Claim.DetailComponent	addSubDetail(Claim.SubDetailComponent t)
Identifier	addTraceNumber()
Claim.DetailComponent	addTraceNumber(Identifier t)
Reference	addUdi()
Claim.DetailComponent	addUdi(Reference t)
Claim.DetailComponent	copy()
void	copyValues(Claim.DetailComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
CodeableConcept	getCategory()
BigDecimal	getFactor()
DecimalType	getFactorElement()
List<CodeableConcept>	getModifier()
CodeableConcept	getModifierFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Money	getNet()
Money	getPatientPaid()
CodeableConcept	getProductOrService()
CodeableConcept	getProductOrServiceEnd()
List<CodeableConcept>	getProgramCode()
CodeableConcept	getProgramCodeFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
Quantity	getQuantity()
CodeableConcept	getRevenue()
int	getSequence()
PositiveIntType	getSequenceElement()
List<Claim.SubDetailComponent>	getSubDetail()
Claim.SubDetailComponent	getSubDetailFirstRep()
Money	getTax()
List<Identifier>	getTraceNumber()
Identifier	getTraceNumberFirstRep()
String[]	getTypesForProperty(int hash, String name)
List<Reference>	getUdi()
Reference	getUdiFirstRep()
Money	getUnitPrice()
boolean	hasCategory()
boolean	hasFactor()
boolean	hasFactorElement()
boolean	hasModifier()
boolean	hasNet()
boolean	hasPatientPaid()
boolean	hasProductOrService()
boolean	hasProductOrServiceEnd()
boolean	hasProgramCode()
boolean	hasQuantity()
boolean	hasRevenue()
boolean	hasSequence()
boolean	hasSequenceElement()
boolean	hasSubDetail()
boolean	hasTax()
boolean	hasTraceNumber()
boolean	hasUdi()
boolean	hasUnitPrice()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Claim.DetailComponent	setCategory(CodeableConcept value)
Claim.DetailComponent	setFactor(double value)
Claim.DetailComponent	setFactor(long value)
Claim.DetailComponent	setFactor(BigDecimal value)
Claim.DetailComponent	setFactorElement(DecimalType value)
Claim.DetailComponent	setModifier(List<CodeableConcept> theModifier)
Claim.DetailComponent	setNet(Money value)
Claim.DetailComponent	setPatientPaid(Money value)
Claim.DetailComponent	setProductOrService(CodeableConcept value)
Claim.DetailComponent	setProductOrServiceEnd(CodeableConcept value)
Claim.DetailComponent	setProgramCode(List<CodeableConcept> theProgramCode)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Claim.DetailComponent	setQuantity(Quantity value)
Claim.DetailComponent	setRevenue(CodeableConcept value)
Claim.DetailComponent	setSequence(int value)
Claim.DetailComponent	setSequenceElement(PositiveIntType value)
Claim.DetailComponent	setSubDetail(List<Claim.SubDetailComponent> theSubDetail)
Claim.DetailComponent	setTax(Money value)
Claim.DetailComponent	setTraceNumber(List<Identifier> theTraceNumber)
Claim.DetailComponent	setUdi(List<Reference> theUdi)
Claim.DetailComponent	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, setModifierExtension

Methods 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, 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, 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, setXhtml

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

protected PositiveIntType sequence

A number to uniquely identify item entries.

traceNumber

protected List<Identifier> traceNumber

Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.

revenue

protected CodeableConcept revenue

The type of revenue or cost center providing the product and/or service.

category

protected CodeableConcept category

Code to identify the general type of benefits under which products and services are provided.

productOrService

protected CodeableConcept 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

protected CodeableConcept 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

protected List<CodeableConcept> modifier

Item typification or modifiers codes to convey additional context for the product or service.

programCode

protected List<CodeableConcept> programCode

Identifies the program under which this may be recovered.

patientPaid

protected Money 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

protected Quantity quantity

The number of repetitions of a service or product.

unitPrice

protected Money 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

protected DecimalType 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

protected Money tax

The total of taxes applicable for this product or service.

net

protected Money net

The total amount claimed for the group (if a grouper) or the line item.detail. Net = unit price * quantity * factor.

udi

protected List<Reference> udi

Unique Device Identifiers associated with this line item.

subDetail

protected List<Claim.SubDetailComponent> subDetail

A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

Constructor Details

DetailComponent

public DetailComponent()

Constructor

DetailComponent

public DetailComponent(int sequence)

Constructor

Method Details

getSequenceElement

public PositiveIntType 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

public boolean hasSequenceElement()

hasSequence

public boolean hasSequence()

setSequenceElement

public Claim.DetailComponent setSequenceElement(PositiveIntType value)

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

public int getSequence()

Returns:

A number to uniquely identify item entries.

setSequence

public Claim.DetailComponent setSequence(int value)

Parameters:

value - A number to uniquely identify item entries.

getTraceNumber

public List<Identifier> getTraceNumber()

Returns:

traceNumber (Trace number for tracking purposes. May be defined at the jurisdiction level or between trading partners.)

setTraceNumber

public Claim.DetailComponent setTraceNumber(List<Identifier> theTraceNumber)

Returns:

Returns a reference to this for easy method chaining

hasTraceNumber

public boolean hasTraceNumber()

addTraceNumber

public Identifier addTraceNumber()

addTraceNumber

public Claim.DetailComponent addTraceNumber(Identifier t)

getTraceNumberFirstRep

public Identifier getTraceNumberFirstRep()

Returns:

The first repetition of repeating field traceNumber, creating it if it does not already exist {3}

getRevenue

public CodeableConcept getRevenue()

Returns:

revenue (The type of revenue or cost center providing the product and/or service.)

hasRevenue

public boolean hasRevenue()

setRevenue

public Claim.DetailComponent setRevenue(CodeableConcept value)

Parameters:

value - revenue (The type of revenue or cost center providing the product and/or service.)

getCategory

public CodeableConcept getCategory()

Returns:

category (Code to identify the general type of benefits under which products and services are provided.)

hasCategory

public boolean hasCategory()

setCategory

public Claim.DetailComponent setCategory(CodeableConcept value)

Parameters:

value - category (Code to identify the general type of benefits under which products and services are provided.)

getProductOrService

public CodeableConcept 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

public boolean hasProductOrService()

setProductOrService

public Claim.DetailComponent setProductOrService(CodeableConcept value)

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

public CodeableConcept 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

public boolean hasProductOrServiceEnd()

setProductOrServiceEnd

public Claim.DetailComponent setProductOrServiceEnd(CodeableConcept value)

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

public List<CodeableConcept> getModifier()

Returns:

modifier (Item typification or modifiers codes to convey additional context for the product or service.)

setModifier

public Claim.DetailComponent setModifier(List<CodeableConcept> theModifier)

Returns:

Returns a reference to this for easy method chaining

hasModifier

public boolean hasModifier()

addModifier

public CodeableConcept addModifier()

addModifier

public Claim.DetailComponent addModifier(CodeableConcept t)

getModifierFirstRep

public CodeableConcept getModifierFirstRep()

Returns:

The first repetition of repeating field modifier, creating it if it does not already exist {3}

getProgramCode

public List<CodeableConcept> getProgramCode()

Returns:

programCode (Identifies the program under which this may be recovered.)

setProgramCode

public Claim.DetailComponent setProgramCode(List<CodeableConcept> theProgramCode)

Returns:

Returns a reference to this for easy method chaining

hasProgramCode

public boolean hasProgramCode()

addProgramCode

public CodeableConcept addProgramCode()

addProgramCode

public Claim.DetailComponent addProgramCode(CodeableConcept t)

getProgramCodeFirstRep

public CodeableConcept getProgramCodeFirstRep()

Returns:

The first repetition of repeating field programCode, creating it if it does not already exist {3}

getPatientPaid

public Money 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

public boolean hasPatientPaid()

setPatientPaid

public Claim.DetailComponent setPatientPaid(Money value)

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

public Quantity getQuantity()

Returns:

quantity (The number of repetitions of a service or product.)

hasQuantity

public boolean hasQuantity()

setQuantity

public Claim.DetailComponent setQuantity(Quantity value)

Parameters:

value - quantity (The number of repetitions of a service or product.)

getUnitPrice

public Money 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

public boolean hasUnitPrice()

setUnitPrice

public Claim.DetailComponent setUnitPrice(Money value)

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

public DecimalType 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

public boolean hasFactorElement()

hasFactor

public boolean hasFactor()

setFactorElement

public Claim.DetailComponent setFactorElement(DecimalType value)

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

public BigDecimal 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

public Claim.DetailComponent setFactor(BigDecimal value)

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

public Claim.DetailComponent setFactor(long value)

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

public Claim.DetailComponent setFactor(double value)

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

public Money getTax()

Returns:

tax (The total of taxes applicable for this product or service.)

hasTax

public boolean hasTax()

setTax

public Claim.DetailComponent setTax(Money value)

Parameters:

value - tax (The total of taxes applicable for this product or service.)

getNet

public Money getNet()

Returns:

net (The total amount claimed for the group (if a grouper) or the line item.detail. Net = unit price * quantity * factor.)

hasNet

public boolean hasNet()

setNet

public Claim.DetailComponent setNet(Money value)

Parameters:

value - net (The total amount claimed for the group (if a grouper) or the line item.detail. Net = unit price * quantity * factor.)

getUdi

public List<Reference> getUdi()

Returns:

udi (Unique Device Identifiers associated with this line item.)

setUdi

public Claim.DetailComponent setUdi(List<Reference> theUdi)

Returns:

Returns a reference to this for easy method chaining

hasUdi

public boolean hasUdi()

addUdi

public Reference addUdi()

addUdi

public Claim.DetailComponent addUdi(Reference t)

getUdiFirstRep

public Reference getUdiFirstRep()

Returns:

The first repetition of repeating field udi, creating it if it does not already exist {3}

getSubDetail

public List<Claim.SubDetailComponent> getSubDetail()

Returns:

subDetail (A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.)

setSubDetail

public Claim.DetailComponent setSubDetail(List<Claim.SubDetailComponent> theSubDetail)

Returns:

Returns a reference to this for easy method chaining

hasSubDetail

public boolean hasSubDetail()

addSubDetail

public Claim.SubDetailComponent addSubDetail()

addSubDetail

public Claim.DetailComponent addSubDetail(Claim.SubDetailComponent t)

getSubDetailFirstRep

public Claim.SubDetailComponent getSubDetailFirstRep()

Returns:

The first repetition of repeating field subDetail, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneElement

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 class BackboneElement

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 class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public Claim.DetailComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(Claim.DetailComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class BackboneElement

Returns:

the FHIR type name of the instance (not the java class name)