Claim.DetailComponent (HAPI FHIR Structures - DSTU2.1 (2016May) 3.3.0 API)

java.lang.Object
- org.hl7.fhir.dstu2016may.model.Base
- - org.hl7.fhir.dstu2016may.model.Element
  - - org.hl7.fhir.dstu2016may.model.BackboneElement
    - - org.hl7.fhir.dstu2016may.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 and Description
`protected DecimalType`	`factor` A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received.
`protected Money`	`net` The quantity times the unit price for an addittional service or product or charge.
`protected DecimalType`	`points` An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered.
`protected List<Coding>`	`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 PositiveIntType`	`sequence` A service line number.
`protected Coding`	`service` If a grouping item then 'GROUP' otherwise it is a node therefore a code to indicate the Professional Service or Product supplied.
`protected List<Claim.SubDetailComponent>`	`subDetail` Third tier of goods and services.
`protected Coding`	`type` The type of product or service.
`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.dstu2016may.model.BackboneElement
modifierExtension

Fields inherited from class org.hl7.fhir.dstu2016may.model.Element
extension, id

Constructor Summary

Constructors
Constructor and Description

DetailComponent()
Constructor

DetailComponent(PositiveIntType sequence, Coding type, Coding service)
Constructor

Constructors
Constructor and Description
`DetailComponent()` Constructor
`DetailComponent(PositiveIntType sequence, Coding type, Coding service)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Coding`	`addProgramCode()`
`Claim.DetailComponent`	`addProgramCode(Coding t)`
`Claim.SubDetailComponent`	`addSubDetail()`
`Claim.DetailComponent`	`addSubDetail(Claim.SubDetailComponent t)`
`Reference`	`addUdi()`
`Claim.DetailComponent`	`addUdi(Reference t)`
`Device`	`addUdiTarget()`
`Claim.DetailComponent`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`BigDecimal`	`getFactor()`
`DecimalType`	`getFactorElement()`
`Money`	`getNet()`
`BigDecimal`	`getPoints()`
`DecimalType`	`getPointsElement()`
`List<Coding>`	`getProgramCode()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`SimpleQuantity`	`getQuantity()`
`int`	`getSequence()`
`PositiveIntType`	`getSequenceElement()`
`Coding`	`getService()`
`List<Claim.SubDetailComponent>`	`getSubDetail()`
`Coding`	`getType()`
`List<Reference>`	`getUdi()`
`List<Device>`	`getUdiTarget()`
`Money`	`getUnitPrice()`
`boolean`	`hasFactor()`
`boolean`	`hasFactorElement()`
`boolean`	`hasNet()`
`boolean`	`hasPoints()`
`boolean`	`hasPointsElement()`
`boolean`	`hasProgramCode()`
`boolean`	`hasQuantity()`
`boolean`	`hasSequence()`
`boolean`	`hasSequenceElement()`
`boolean`	`hasService()`
`boolean`	`hasSubDetail()`
`boolean`	`hasType()`
`boolean`	`hasUdi()`
`boolean`	`hasUnitPrice()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`Claim.DetailComponent`	`setFactor(BigDecimal value)`
`Claim.DetailComponent`	`setFactor(double value)`
`Claim.DetailComponent`	`setFactor(long value)`
`Claim.DetailComponent`	`setFactorElement(DecimalType value)`
`Claim.DetailComponent`	`setNet(Money value)`
`Claim.DetailComponent`	`setPoints(BigDecimal value)`
`Claim.DetailComponent`	`setPoints(double value)`
`Claim.DetailComponent`	`setPoints(long value)`
`Claim.DetailComponent`	`setPointsElement(DecimalType value)`
`void`	`setProperty(int hash, String name, Base value)`
`void`	`setProperty(String name, Base value)`
`Claim.DetailComponent`	`setQuantity(SimpleQuantity value)`
`Claim.DetailComponent`	`setSequence(int value)`
`Claim.DetailComponent`	`setSequenceElement(PositiveIntType value)`
`Claim.DetailComponent`	`setService(Coding value)`
`Claim.DetailComponent`	`setType(Coding value)`
`Claim.DetailComponent`	`setUnitPrice(Money value)`

Methods inherited from class org.hl7.fhir.dstu2016may.model.BackboneElement
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, hasModifierExtension

Methods inherited from class org.hl7.fhir.dstu2016may.model.Element
addExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, 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, hasFormatComment

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 Detail
  - sequence
```
protected PositiveIntType sequence
```
    A service line number.
  - type
```
protected Coding type
```
    The type of product or service.
  - service
```
protected Coding service
```
    If a grouping item then 'GROUP' otherwise it is a node therefore a code to indicate the Professional Service or Product supplied.
  - programCode
```
protected List<Coding> 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.
  - points
```
protected DecimalType points
```
    An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.
  - 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 Detail
  - DetailComponent
```
public DetailComponent()
```
    Constructor
  - DetailComponent
```
public DetailComponent(PositiveIntType sequence,
                       Coding type,
                       Coding service)
```
    Constructor
- Method Detail
  - 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.
  - getType
```
public Coding getType()
```
    Returns:
    
    type (The type of product or service.)
  - hasType
```
public boolean hasType()
```
  - setType
```
public Claim.DetailComponent setType(Coding value)
```
    Parameters:
    
    value - type (The type of product or service.)
  - getService
```
public Coding getService()
```
    Returns:
    
    service (If a grouping item then 'GROUP' otherwise it is a node therefore a code to indicate the Professional Service or Product supplied.)
  - hasService
```
public boolean hasService()
```
  - setService
```
public Claim.DetailComponent setService(Coding value)
```
    Parameters:
    
    value - service (If a grouping item then 'GROUP' otherwise it is a node therefore a code to indicate the Professional Service or Product supplied.)
  - getProgramCode
```
public List<Coding> getProgramCode()
```
    Returns:
    
    programCode (For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.)
  - hasProgramCode
```
public boolean hasProgramCode()
```
  - addProgramCode
```
public Coding addProgramCode()
```
    Returns:
    
    programCode (For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.)
  - addProgramCode
```
public Claim.DetailComponent addProgramCode(Coding t)
```
  - 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.
  - getPointsElement
```
public DecimalType getPointsElement()
```
    Returns:
    
    points (An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.). This is the underlying object with id, value and extensions. The accessor "getPoints" gives direct access to the value
  - hasPointsElement
```
public boolean hasPointsElement()
```
  - hasPoints
```
public boolean hasPoints()
```
  - setPointsElement
```
public Claim.DetailComponent setPointsElement(DecimalType value)
```
    Parameters:
    
    value - points (An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.). This is the underlying object with id, value and extensions. The accessor "getPoints" gives direct access to the value
  - getPoints
```
public BigDecimal getPoints()
```
    Returns:
    
    An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.
  - setPoints
```
public Claim.DetailComponent setPoints(BigDecimal value)
```
    Parameters:
    
    value - An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.
  - setPoints
```
public Claim.DetailComponent setPoints(long value)
```
    Parameters:
    
    value - An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.
  - setPoints
```
public Claim.DetailComponent setPoints(double value)
```
    Parameters:
    
    value - An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.
  - 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.)
  - hasUdi
```
public boolean hasUdi()
```
  - addUdi
```
public Reference addUdi()
```
    Returns:
    
    udi (List of Unique Device Identifiers associated with this line item.)
  - addUdi
```
public Claim.DetailComponent addUdi(Reference t)
```
  - getUdiTarget
```
public List<Device> getUdiTarget()
```
    Returns:
    
    udi (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. List of Unique Device Identifiers associated with this line item.)
  - addUdiTarget
```
public Device addUdiTarget()
```
    Returns:
    
    udi (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. List of Unique Device Identifiers associated with this line item.)
  - getSubDetail
```
public List<Claim.SubDetailComponent> getSubDetail()
```
    Returns:
    
    subDetail (Third tier of goods and services.)
  - hasSubDetail
```
public boolean hasSubDetail()
```
  - addSubDetail
```
public Claim.SubDetailComponent addSubDetail()
```
    Returns:
    
    subDetail (Third tier of goods and services.)
  - addSubDetail
```
public Claim.DetailComponent addSubDetail(Claim.SubDetailComponent t)
```
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class BackboneElement
  - 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 void 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 void 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
  - 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()
```
    Overrides:
    
    fhirType in class BackboneElement

Class Claim.DetailComponent

Field Summary

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Field Detail

sequence

type

service

programCode

quantity

unitPrice

factor

points

net

udi

udiTarget

subDetail

Constructor Detail

DetailComponent

DetailComponent

Method Detail

getSequenceElement

hasSequenceElement

hasSequence

setSequenceElement

getSequence

setSequence

getType

hasType

setType

getService

hasService

setService

getProgramCode

hasProgramCode

addProgramCode

addProgramCode

getQuantity

hasQuantity

setQuantity

getUnitPrice

hasUnitPrice

setUnitPrice

getFactorElement

hasFactorElement

hasFactor

setFactorElement

getFactor

setFactor

setFactor

setFactor

getPointsElement

hasPointsElement

hasPoints

setPointsElement

getPoints

setPoints

setPoints

setPoints

getNet

hasNet

setNet

getUdi

hasUdi

addUdi

addUdi

getUdiTarget

addUdiTarget

getSubDetail

hasSubDetail

addSubDetail