Package org.hl7.fhir.dstu3.model

Class Claim.DetailComponent

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.Element

org.hl7.fhir.dstu3.model.BackboneElement

org.hl7.fhir.dstu3.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

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeableConcept	category	Health Care Service Type Codes to identify the classification of service or benefits.
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, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
protected Money	net	The quantity times the unit price for an addittional service or product or charge.
protected List<CodeableConcept>	programCode	For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.
protected SimpleQuantity	quantity	The number of repetitions of a service or product.
protected CodeableConcept	revenue	The type of reveneu or cost center providing the product and/or service.
protected PositiveIntType	sequence	A service line number.
protected CodeableConcept	service	If this is an actual service or product line, ie.
protected List<Claim.SubDetailComponent>	subDetail	Third tier of goods and services.
protected List<Reference>	udi	List of Unique Device Identifiers associated with this line item.
protected List<Device>	udiTarget	The actual objects that are the target of the reference (List of Unique Device Identifiers associated with this line item.)
protected Money	unitPrice	If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
DetailComponent()	Constructor
DetailComponent(PositiveIntType 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)
Reference	addUdi()
Claim.DetailComponent	addUdi(Reference t)
Device	addUdiTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Claim.DetailComponent	copy()
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()
List<CodeableConcept>	getProgramCode()
CodeableConcept	getProgramCodeFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
SimpleQuantity	getQuantity()
CodeableConcept	getRevenue()
int	getSequence()
PositiveIntType	getSequenceElement()
CodeableConcept	getService()
List<Claim.SubDetailComponent>	getSubDetail()
Claim.SubDetailComponent	getSubDetailFirstRep()
String[]	getTypesForProperty(int hash, String name)
List<Reference>	getUdi()
Reference	getUdiFirstRep()
List<Device>	getUdiTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Money	getUnitPrice()
boolean	hasCategory()
boolean	hasFactor()
boolean	hasFactorElement()
boolean	hasModifier()
boolean	hasNet()
boolean	hasProgramCode()
boolean	hasQuantity()
boolean	hasRevenue()
boolean	hasSequence()
boolean	hasSequenceElement()
boolean	hasService()
boolean	hasSubDetail()
boolean	hasUdi()
boolean	hasUnitPrice()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
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	setProgramCode(List<CodeableConcept> theProgramCode)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Claim.DetailComponent	setQuantity(SimpleQuantity value)
Claim.DetailComponent	setRevenue(CodeableConcept value)
Claim.DetailComponent	setSequence(int value)
Claim.DetailComponent	setSequenceElement(PositiveIntType value)
Claim.DetailComponent	setService(CodeableConcept value)
Claim.DetailComponent	setSubDetail(List<Claim.SubDetailComponent> theSubDetail)
Claim.DetailComponent	setUdi(List<Reference> theUdi)
Claim.DetailComponent	setUnitPrice(Money value)

Methods inherited from class org.hl7.fhir.dstu3.model.BackboneElement

addModifierExtension, addModifierExtension, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.dstu3.model.Element

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.dstu3.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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

protected PositiveIntType sequence

A service line number.

revenue

protected CodeableConcept revenue

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

category

protected CodeableConcept category

Health Care Service Type Codes to identify the classification of service or benefits.

service

protected CodeableConcept service

If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'.

modifier

protected List<CodeableConcept> modifier

Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.

programCode

protected List<CodeableConcept> programCode

For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.

quantity

protected SimpleQuantity quantity

The number of repetitions of a service or product.

unitPrice

protected Money unitPrice

If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children 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.

net

protected Money net

The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.

udi

protected List<Reference> udi

List of Unique Device Identifiers associated with this line item.

udiTarget

protected List<Device> udiTarget

The actual objects that are the target of the reference (List of Unique Device Identifiers associated with this line item.)

subDetail

protected List<Claim.SubDetailComponent> subDetail

Third tier of goods and services.

Constructor Details

DetailComponent

public DetailComponent()

Constructor

DetailComponent

public DetailComponent(PositiveIntType sequence)

Constructor

Method Details

getSequenceElement

public PositiveIntType getSequenceElement()

Returns:

sequence (A service line number.). 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 service line number.). 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 service line number.

setSequence

public Claim.DetailComponent setSequence(int value)

Parameters:

value - A service line number.

getRevenue

public CodeableConcept getRevenue()

Returns:

revenue (The type of reveneu 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 reveneu or cost center providing the product and/or service.)

getCategory

public CodeableConcept getCategory()

Returns:

category (Health Care Service Type Codes to identify the classification of service or benefits.)

hasCategory

public boolean hasCategory()

setCategory

public Claim.DetailComponent setCategory(CodeableConcept value)

Parameters:

value - category (Health Care Service Type Codes to identify the classification of service or benefits.)

getService

public CodeableConcept getService()

Returns:

service (If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'.)

hasService

public boolean hasService()

setService

public Claim.DetailComponent setService(CodeableConcept value)

Parameters:

value - service (If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'.)

getModifier

public List<CodeableConcept> getModifier()

Returns:

modifier (Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.)

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

getProgramCode

public List<CodeableConcept> getProgramCode()

Returns:

programCode (For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.)

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

getQuantity

public SimpleQuantity getQuantity()

Returns:

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

hasQuantity

public boolean hasQuantity()

setQuantity

public Claim.DetailComponent setQuantity(SimpleQuantity value)

Parameters:

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

getUnitPrice

public Money getUnitPrice()

Returns:

unitPrice (If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.)

hasUnitPrice

public boolean hasUnitPrice()

setUnitPrice

public Claim.DetailComponent setUnitPrice(Money value)

Parameters:

value - unitPrice (If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children 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.

getNet

public Money getNet()

Returns:

net (The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.)

hasNet

public boolean hasNet()

setNet

public Claim.DetailComponent setNet(Money value)

Parameters:

value - net (The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.)

getUdi

public List<Reference> getUdi()

Returns:

udi (List of 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

getUdiTarget

@Deprecated
public List<Device> getUdiTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addUdiTarget

@Deprecated
public Device addUdiTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getSubDetail

public List<Claim.SubDetailComponent> getSubDetail()

Returns:

subDetail (Third tier of goods and services.)

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

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

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

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