Package org.hl7.fhir.dstu3.model
Class Claim.ItemComponent
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.ItemComponent
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseBackboneElement
,org.hl7.fhir.instance.model.api.IBaseElement
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
- Enclosing class:
Claim
public static class Claim.ItemComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected CodeableConcept
Physical service site on the patient (limb, tooth, etc).protected List
<PositiveIntType> CareTeam applicable for this service or product line.protected CodeableConcept
Health Care Service Type Codes to identify the classification of service or benefits.protected List
<Claim.DetailComponent> Second tier of goods and services.protected List
<PositiveIntType> Diagnosis applicable for this service or product line.A billed item may include goods or services provided in multiple encounters.The actual objects that are the target of the reference (A billed item may include goods or services provided in multiple encounters.)protected DecimalType
A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received.protected List
<PositiveIntType> Exceptions, special conditions and supporting information pplicable for this service or product line.protected Type
Where the service was provided.protected List
<CodeableConcept> 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
The quantity times the unit price for an addittional service or product or charge.protected List
<PositiveIntType> Procedures applicable for this service or product line.protected List
<CodeableConcept> For programs which require reason codes for the inclusion or covering of this billed item under the program or sub-program.protected SimpleQuantity
The number of repetitions of a service or product.protected CodeableConcept
The type of reveneu or cost center providing the product and/or service.protected PositiveIntType
A service line number.protected CodeableConcept
If this is an actual service or product line, ie.protected Type
The date or dates when the enclosed suite of services were performed or completed.protected List
<CodeableConcept> A region or surface of the site, eg.List of Unique Device Identifiers associated with this line item.The actual objects that are the target of the reference (List of Unique Device Identifiers associated with this line item.)protected Money
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
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddCareTeamLinkId
(int value) addDiagnosisLinkId
(int value) Deprecated.Use Reference#setResource(IBaseResource) insteadaddInformationLinkId
(int value) addProcedureLinkId
(int value) addUdi()
Deprecated.Use Reference#setResource(IBaseResource) insteadcopy()
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
Deprecated.Use Reference#setResource(IBaseResource) insteadgetNamedProperty
(int _hash, String _name, boolean _checkValid) getNet()
Base[]
getProperty
(int hash, String name, boolean checkValid) int
String[]
getTypesForProperty
(int hash, String name) getUdi()
Deprecated.Use Reference#setResource(IBaseResource) insteadboolean
boolean
boolean
hasCareTeamLinkId
(int value) boolean
boolean
boolean
boolean
hasDiagnosisLinkId
(int value) boolean
boolean
boolean
boolean
boolean
hasInformationLinkId
(int value) boolean
boolean
boolean
boolean
boolean
boolean
hasNet()
boolean
boolean
hasProcedureLinkId
(int value) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasUdi()
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setBodySite
(CodeableConcept value) setCareTeamLinkId
(List<PositiveIntType> theCareTeamLinkId) setCategory
(CodeableConcept value) setDetail
(List<Claim.DetailComponent> theDetail) setDiagnosisLinkId
(List<PositiveIntType> theDiagnosisLinkId) setEncounter
(List<Reference> theEncounter) setFactor
(double value) setFactor
(long value) setFactor
(BigDecimal value) setFactorElement
(DecimalType value) setInformationLinkId
(List<PositiveIntType> theInformationLinkId) setLocation
(Type value) setModifier
(List<CodeableConcept> theModifier) setProcedureLinkId
(List<PositiveIntType> theProcedureLinkId) setProgramCode
(List<CodeableConcept> theProgramCode) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setQuantity
(SimpleQuantity value) setRevenue
(CodeableConcept value) setSequence
(int value) setService
(CodeableConcept value) setServiced
(Type value) setSubSite
(List<CodeableConcept> theSubSite) 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, getExtensionByUrl, 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
A service line number. -
careTeamLinkId
CareTeam applicable for this service or product line. -
diagnosisLinkId
Diagnosis applicable for this service or product line. -
procedureLinkId
Procedures applicable for this service or product line. -
informationLinkId
Exceptions, special conditions and supporting information pplicable for this service or product line. -
revenue
The type of reveneu or cost center providing the product and/or service. -
category
Health Care Service Type Codes to identify the classification of service or benefits. -
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,RXNorm,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'. -
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
For programs which require reason codes for the inclusion or covering of this billed item under the program or sub-program. -
serviced
The date or dates when the enclosed suite of services were performed or completed. -
location
Where the service was provided. -
quantity
The number of repetitions of a service or product. -
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
A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount. -
net
The quantity times the unit price for an 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
List of Unique Device Identifiers associated with this line item. -
udiTarget
The actual objects that are the target of the reference (List of Unique Device Identifiers associated with this line item.) -
bodySite
Physical service site on the patient (limb, tooth, etc). -
subSite
A region or surface of the site, eg. limb region or tooth surface(s). -
encounter
A billed item may include goods or services provided in multiple encounters. -
encounterTarget
The actual objects that are the target of the reference (A billed item may include goods or services provided in multiple encounters.) -
detail
Second tier of goods and services.
-
-
Constructor Details
-
ItemComponent
public ItemComponent()Constructor -
ItemComponent
Constructor
-
-
Method Details
-
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
-
hasSequence
-
setSequenceElement
- 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
- Returns:
- A service line number.
-
setSequence
- Parameters:
value
- A service line number.
-
getCareTeamLinkId
- Returns:
careTeamLinkId
(CareTeam applicable for this service or product line.)
-
setCareTeamLinkId
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCareTeamLinkId
-
addCareTeamLinkIdElement
- Returns:
careTeamLinkId
(CareTeam applicable for this service or product line.)
-
addCareTeamLinkId
- Parameters:
value
-careTeamLinkId
(CareTeam applicable for this service or product line.)
-
hasCareTeamLinkId
- Parameters:
value
-careTeamLinkId
(CareTeam applicable for this service or product line.)
-
getDiagnosisLinkId
- Returns:
diagnosisLinkId
(Diagnosis applicable for this service or product line.)
-
setDiagnosisLinkId
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDiagnosisLinkId
-
addDiagnosisLinkIdElement
- Returns:
diagnosisLinkId
(Diagnosis applicable for this service or product line.)
-
addDiagnosisLinkId
- Parameters:
value
-diagnosisLinkId
(Diagnosis applicable for this service or product line.)
-
hasDiagnosisLinkId
- Parameters:
value
-diagnosisLinkId
(Diagnosis applicable for this service or product line.)
-
getProcedureLinkId
- Returns:
procedureLinkId
(Procedures applicable for this service or product line.)
-
setProcedureLinkId
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasProcedureLinkId
-
addProcedureLinkIdElement
- Returns:
procedureLinkId
(Procedures applicable for this service or product line.)
-
addProcedureLinkId
- Parameters:
value
-procedureLinkId
(Procedures applicable for this service or product line.)
-
hasProcedureLinkId
- Parameters:
value
-procedureLinkId
(Procedures applicable for this service or product line.)
-
getInformationLinkId
- Returns:
informationLinkId
(Exceptions, special conditions and supporting information pplicable for this service or product line.)
-
setInformationLinkId
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInformationLinkId
-
addInformationLinkIdElement
- Returns:
informationLinkId
(Exceptions, special conditions and supporting information pplicable for this service or product line.)
-
addInformationLinkId
- Parameters:
value
-informationLinkId
(Exceptions, special conditions and supporting information pplicable for this service or product line.)
-
hasInformationLinkId
- Parameters:
value
-informationLinkId
(Exceptions, special conditions and supporting information pplicable for this service or product line.)
-
getRevenue
- Returns:
revenue
(The type of reveneu or cost center providing the product and/or service.)
-
hasRevenue
-
setRevenue
- Parameters:
value
-revenue
(The type of reveneu or cost center providing the product and/or service.)
-
getCategory
- Returns:
category
(Health Care Service Type Codes to identify the classification of service or benefits.)
-
hasCategory
-
setCategory
- Parameters:
value
-category
(Health Care Service Type Codes to identify the classification of service or benefits.)
-
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,RXNorm,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'.)
-
hasService
-
setService
- 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,RXNorm,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. 'glasses' or 'compound'.)
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasModifier
-
addModifier
-
addModifier
-
getModifierFirstRep
- Returns:
- The first repetition of repeating field
modifier
, creating it if it does not already exist
-
getProgramCode
- Returns:
programCode
(For programs which require reason codes for the inclusion or covering of this billed item under the program or sub-program.)
-
setProgramCode
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasProgramCode
-
addProgramCode
-
addProgramCode
-
getProgramCodeFirstRep
- Returns:
- The first repetition of repeating field
programCode
, creating it if it does not already exist
-
getServiced
- Returns:
serviced
(The date or dates when the enclosed suite of services were performed or completed.)
-
getServicedDateType
- Returns:
serviced
(The date or dates when the enclosed suite of services were performed or completed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasServicedDateType
-
getServicedPeriod
- Returns:
serviced
(The date or dates when the enclosed suite of services were performed or completed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasServicedPeriod
-
hasServiced
-
setServiced
- Parameters:
value
-serviced
(The date or dates when the enclosed suite of services were performed or completed.)- Throws:
org.hl7.fhir.exceptions.FHIRFormatError
-
getLocation
- Returns:
location
(Where the service was provided.)
-
getLocationCodeableConcept
- Returns:
location
(Where the service was provided.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasLocationCodeableConcept
-
getLocationAddress
- Returns:
location
(Where the service was provided.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasLocationAddress
-
getLocationReference
- Returns:
location
(Where the service was provided.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasLocationReference
-
hasLocation
-
setLocation
- Parameters:
value
-location
(Where the service was provided.)- Throws:
org.hl7.fhir.exceptions.FHIRFormatError
-
getQuantity
- Returns:
quantity
(The number of repetitions of a service or product.)
-
hasQuantity
-
setQuantity
- Parameters:
value
-quantity
(The number of repetitions of a service or product.)
-
getUnitPrice
- Returns:
unitPrice
(If the item is 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
-
setUnitPrice
- 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
- Returns:
factor
(A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.). This is the underlying object with id, value and extensions. The accessor "getFactor" gives direct access to the value
-
hasFactorElement
-
hasFactor
-
setFactorElement
- Parameters:
value
-factor
(A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.). This is the underlying object with id, value and extensions. The accessor "getFactor" gives direct access to the value
-
getFactor
- Returns:
- A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
setFactor
- Parameters:
value
- A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
setFactor
- Parameters:
value
- A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
setFactor
- Parameters:
value
- A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
getNet
- Returns:
net
(The quantity times the unit price for an 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
-
setNet
- 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
- Returns:
udi
(List of Unique Device Identifiers associated with this line item.)
-
setUdi
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUdi
-
addUdi
-
addUdi
-
getUdiFirstRep
- Returns:
- The first repetition of repeating field
udi
, creating it if it does not already exist
-
getUdiTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addUdiTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getBodySite
- Returns:
bodySite
(Physical service site on the patient (limb, tooth, etc).)
-
hasBodySite
-
setBodySite
- Parameters:
value
-bodySite
(Physical service site on the patient (limb, tooth, etc).)
-
getSubSite
- Returns:
subSite
(A region or surface of the site, eg. limb region or tooth surface(s).)
-
setSubSite
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSubSite
-
addSubSite
-
addSubSite
-
getSubSiteFirstRep
- Returns:
- The first repetition of repeating field
subSite
, creating it if it does not already exist
-
getEncounter
- Returns:
encounter
(A billed item may include goods or services provided in multiple encounters.)
-
setEncounter
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEncounter
-
addEncounter
-
addEncounter
-
getEncounterFirstRep
- Returns:
- The first repetition of repeating field
encounter
, creating it if it does not already exist
-
getEncounterTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addEncounterTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getDetail
- Returns:
detail
(Second tier of goods and services.)
-
setDetail
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDetail
-
addDetail
-
addDetail
-
getDetailFirstRep
- Returns:
- The first repetition of repeating field
detail
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classBackboneElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
- Specified by:
copy
in classBackboneElement
-
equalsDeep
- Overrides:
equalsDeep
in classBackboneElement
-
equalsShallow
- Overrides:
equalsShallow
in classBackboneElement
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classBackboneElement
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classBackboneElement
-