Claim.SubDetailComponent (HAPI FHIR Structures

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.Claim.SubDetailComponent

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.SubDetailComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected CodeableConcept`	`billcode` A code to indicate the Professional Service or Product supplied (e.g.
`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, e.g.
`protected Money`	`net` The quantity times the unit price for an additional 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 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 service line number.
`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` The fee for an addittional service or product or charge.

Fields inherited from class org.hl7.fhir.r4.model.BackboneElement
modifierExtension

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

Constructor Summary

Constructors
Constructor and Description

SubDetailComponent()
Constructor

SubDetailComponent(PositiveIntType sequence)
Constructor

Constructors
Constructor and Description
`SubDetailComponent()` Constructor
`SubDetailComponent(PositiveIntType sequence)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`CodeableConcept`	`addModifier()`
`Claim.SubDetailComponent`	`addModifier(CodeableConcept t)`
`CodeableConcept`	`addProgramCode()`
`Claim.SubDetailComponent`	`addProgramCode(CodeableConcept t)`
`Reference`	`addUdi()`
`Claim.SubDetailComponent`	`addUdi(Reference t)`
`Device`	`addUdiTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`Claim.SubDetailComponent`	`copy()`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`CodeableConcept`	`getBillcode()`
`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)`
`Quantity`	`getQuantity()`
`CodeableConcept`	`getRevenue()`
`int`	`getSequence()`
`PositiveIntType`	`getSequenceElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`List<Reference>`	`getUdi()`
`Reference`	`getUdiFirstRep()`
`List<Device>`	`getUdiTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`Money`	`getUnitPrice()`
`boolean`	`hasBillcode()`
`boolean`	`hasCategory()`
`boolean`	`hasFactor()`
`boolean`	`hasFactorElement()`
`boolean`	`hasModifier()`
`boolean`	`hasNet()`
`boolean`	`hasProgramCode()`
`boolean`	`hasQuantity()`
`boolean`	`hasRevenue()`
`boolean`	`hasSequence()`
`boolean`	`hasSequenceElement()`
`boolean`	`hasUdi()`
`boolean`	`hasUnitPrice()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`Claim.SubDetailComponent`	`setBillcode(CodeableConcept value)`
`Claim.SubDetailComponent`	`setCategory(CodeableConcept value)`
`Claim.SubDetailComponent`	`setFactor(BigDecimal value)`
`Claim.SubDetailComponent`	`setFactor(double value)`
`Claim.SubDetailComponent`	`setFactor(long value)`
`Claim.SubDetailComponent`	`setFactorElement(DecimalType value)`
`Claim.SubDetailComponent`	`setModifier(List<CodeableConcept> theModifier)`
`Claim.SubDetailComponent`	`setNet(Money value)`
`Claim.SubDetailComponent`	`setProgramCode(List<CodeableConcept> theProgramCode)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Claim.SubDetailComponent`	`setQuantity(Quantity value)`
`Claim.SubDetailComponent`	`setRevenue(CodeableConcept value)`
`Claim.SubDetailComponent`	`setSequence(int value)`
`Claim.SubDetailComponent`	`setSequenceElement(PositiveIntType value)`
`Claim.SubDetailComponent`	`setUdi(List<Reference> theUdi)`
`Claim.SubDetailComponent`	`setUnitPrice(Money value)`

Methods inherited from class org.hl7.fhir.r4.model.BackboneElement
addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.r4.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, 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, 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, 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, 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.
  - revenue
```
protected CodeableConcept revenue
```
    The type of revenue 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.
  - billcode
```
protected CodeableConcept billcode
```
    A code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI).
  - modifier
```
protected List<CodeableConcept> modifier
```
    Item typification or modifiers codes, e.g. 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 Quantity quantity
```
    The number of repetitions of a service or product.
  - unitPrice
```
protected Money unitPrice
```
    The fee for an addittional service or product or charge.
  - 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 additional 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.)
- Constructor Detail
  - SubDetailComponent
```
public SubDetailComponent()
```
    Constructor
  - SubDetailComponent
```
public SubDetailComponent(PositiveIntType sequence)
```
    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.SubDetailComponent 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.SubDetailComponent setSequence(int value)
```
    Parameters:
    
    value - A service line number.
  - 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.SubDetailComponent 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 (Health Care Service Type Codes to identify the classification of service or benefits.)
  - hasCategory
```
public boolean hasCategory()
```
  - setCategory
```
public Claim.SubDetailComponent setCategory(CodeableConcept value)
```
    Parameters:
    
    value - category (Health Care Service Type Codes to identify the classification of service or benefits.)
  - getBillcode
```
public CodeableConcept getBillcode()
```
    Returns:
    
    billcode (A code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI).)
  - hasBillcode
```
public boolean hasBillcode()
```
  - setBillcode
```
public Claim.SubDetailComponent setBillcode(CodeableConcept value)
```
    Parameters:
    
    value - billcode (A code to indicate the Professional Service or Product supplied (e.g. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI).)
  - getModifier
```
public List<CodeableConcept> getModifier()
```
    Returns:
    
    modifier (Item typification or modifiers codes, e.g. 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.SubDetailComponent 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.SubDetailComponent 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.SubDetailComponent 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.SubDetailComponent 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 Quantity getQuantity()
```
    Returns:
    
    quantity (The number of repetitions of a service or product.)
  - hasQuantity
```
public boolean hasQuantity()
```
  - setQuantity
```
public Claim.SubDetailComponent setQuantity(Quantity value)
```
    Parameters:
    
    value - quantity (The number of repetitions of a service or product.)
  - getUnitPrice
```
public Money getUnitPrice()
```
    Returns:
    
    unitPrice (The fee for an addittional service or product or charge.)
  - hasUnitPrice
```
public boolean hasUnitPrice()
```
  - setUnitPrice
```
public Claim.SubDetailComponent setUnitPrice(Money value)
```
    Parameters:
    
    value - unitPrice (The fee for an addittional service or product or charge.)
  - 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.SubDetailComponent 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.SubDetailComponent 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.SubDetailComponent 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.SubDetailComponent 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 additional 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.SubDetailComponent setNet(Money value)
```
    Parameters:
    
    value - net (The quantity times the unit price for an additional 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.SubDetailComponent 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.SubDetailComponent 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
  - 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.SubDetailComponent 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.SubDetailComponent

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class org.hl7.fhir.r4.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

revenue

category

billcode

modifier

programCode

quantity

unitPrice

factor

net

udi

udiTarget

Constructor Detail

SubDetailComponent

SubDetailComponent

Method Detail

getSequenceElement

hasSequenceElement

hasSequence

setSequenceElement

getSequence

setSequence

getRevenue

hasRevenue

setRevenue

getCategory

hasCategory

setCategory

getBillcode

hasBillcode

setBillcode

getModifier

setModifier

hasModifier

addModifier

addModifier

getModifierFirstRep

getProgramCode

setProgramCode

hasProgramCode

addProgramCode

addProgramCode

getProgramCodeFirstRep

getQuantity

hasQuantity

setQuantity

getUnitPrice

hasUnitPrice

setUnitPrice

getFactorElement

hasFactorElement

hasFactor

setFactorElement

getFactor

setFactor

setFactor

setFactor

getNet

hasNet

setNet

getUdi

setUdi

hasUdi

addUdi

addUdi

getUdiFirstRep