Package com.ibm.fhir.model.resource
Class ChargeItem
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.resource.Resource
-
- com.ibm.fhir.model.resource.DomainResource
-
- com.ibm.fhir.model.resource.ChargeItem
-
- All Implemented Interfaces:
Visitable
@Generated("com.ibm.fhir.tools.CodeGenerator") public class ChargeItem extends DomainResource
The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.Maturity level: FMM0 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classChargeItem.Builderstatic classChargeItem.PerformerIndicates who or what performed or participated in the charged service.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static ChargeItem.Builderbuilder()booleanequals(Object obj)List<Reference>getAccount()Account into which this ChargeItems belongs.List<CodeableConcept>getBodysite()The anatomical location where the related service has been applied.CodeableConceptgetCode()A code that identifies the charge, like a billing code.ReferencegetContext()The encounter or episode of care that establishes the context for this event.ReferencegetCostCenter()The financial cost center permits the tracking of charge attribution.List<Canonical>getDefinitionCanonical()References the source of pricing information, rules of application for the code this ChargeItem uses.List<Uri>getDefinitionUri()References the (external) source of pricing information, rules of application for the code this ChargeItem uses.DateTimegetEnteredDate()Date the charge item was entered.ReferencegetEnterer()The device, practitioner, etc.DecimalgetFactorOverride()Factor overriding the factor determined by the rules associated with the code.List<Identifier>getIdentifier()Identifiers assigned to this event performer or other systems.List<Annotation>getNote()Comments made about the event by the performer, subject or other participants.ElementgetOccurrence()Date/time(s) or duration when the charged service was applied.StringgetOverrideReason()If the list price or the rule-based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.List<Reference>getPartOf()ChargeItems can be grouped to larger ChargeItems covering the whole set.List<ChargeItem.Performer>getPerformer()Indicates who or what performed or participated in the charged service.ReferencegetPerformingOrganization()The organization requesting the service.MoneygetPriceOverride()Total price of the charge overriding the list price associated with the code.ElementgetProduct()Identifies the device, food, drug or other product being charged either by type code or reference to an instance.QuantitygetQuantity()Quantity of which the charge item has been serviced.List<CodeableConcept>getReason()Describes why the event occurred in coded or textual form.ReferencegetRequestingOrganization()The organization performing the service.List<Reference>getService()Indicated the rendered service that caused this charge.ChargeItemStatusgetStatus()The current state of the ChargeItem.ReferencegetSubject()The individual or set of individuals the action is being or was performed on.List<Reference>getSupportingInformation()Further information supporting this charge.booleanhasChildren()inthashCode()ChargeItem.BuildertoBuilder()Create a new Builder from the contents of this Resource-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class com.ibm.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
Identifiers assigned to this event performer or other systems.- Returns:
- An unmodifiable list containing immutable objects of type
Identifierthat may be empty.
-
getDefinitionUri
public List<Uri> getDefinitionUri()
References the (external) source of pricing information, rules of application for the code this ChargeItem uses.- Returns:
- An unmodifiable list containing immutable objects of type
Urithat may be empty.
-
getDefinitionCanonical
public List<Canonical> getDefinitionCanonical()
References the source of pricing information, rules of application for the code this ChargeItem uses.- Returns:
- An unmodifiable list containing immutable objects of type
Canonicalthat may be empty.
-
getStatus
public ChargeItemStatus getStatus()
The current state of the ChargeItem.- Returns:
- An immutable object of type
ChargeItemStatusthat is non-null.
-
getPartOf
public List<Reference> getPartOf()
ChargeItems can be grouped to larger ChargeItems covering the whole set.- Returns:
- An unmodifiable list containing immutable objects of type
Referencethat may be empty.
-
getCode
public CodeableConcept getCode()
A code that identifies the charge, like a billing code.- Returns:
- An immutable object of type
CodeableConceptthat is non-null.
-
getSubject
public Reference getSubject()
The individual or set of individuals the action is being or was performed on.- Returns:
- An immutable object of type
Referencethat is non-null.
-
getContext
public Reference getContext()
The encounter or episode of care that establishes the context for this event.- Returns:
- An immutable object of type
Referencethat may be null.
-
getOccurrence
public Element getOccurrence()
Date/time(s) or duration when the charged service was applied.- Returns:
- An immutable object of type
Elementthat may be null.
-
getPerformer
public List<ChargeItem.Performer> getPerformer()
Indicates who or what performed or participated in the charged service.- Returns:
- An unmodifiable list containing immutable objects of type
ChargeItem.Performerthat may be empty.
-
getPerformingOrganization
public Reference getPerformingOrganization()
The organization requesting the service.- Returns:
- An immutable object of type
Referencethat may be null.
-
getRequestingOrganization
public Reference getRequestingOrganization()
The organization performing the service.- Returns:
- An immutable object of type
Referencethat may be null.
-
getCostCenter
public Reference getCostCenter()
The financial cost center permits the tracking of charge attribution.- Returns:
- An immutable object of type
Referencethat may be null.
-
getQuantity
public Quantity getQuantity()
Quantity of which the charge item has been serviced.- Returns:
- An immutable object of type
Quantitythat may be null.
-
getBodysite
public List<CodeableConcept> getBodysite()
The anatomical location where the related service has been applied.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConceptthat may be empty.
-
getFactorOverride
public Decimal getFactorOverride()
Factor overriding the factor determined by the rules associated with the code.- Returns:
- An immutable object of type
Decimalthat may be null.
-
getPriceOverride
public Money getPriceOverride()
Total price of the charge overriding the list price associated with the code.- Returns:
- An immutable object of type
Moneythat may be null.
-
getOverrideReason
public String getOverrideReason()
If the list price or the rule-based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.- Returns:
- An immutable object of type
Stringthat may be null.
-
getEnterer
public Reference getEnterer()
The device, practitioner, etc. who entered the charge item.- Returns:
- An immutable object of type
Referencethat may be null.
-
getEnteredDate
public DateTime getEnteredDate()
Date the charge item was entered.- Returns:
- An immutable object of type
DateTimethat may be null.
-
getReason
public List<CodeableConcept> getReason()
Describes why the event occurred in coded or textual form.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConceptthat may be empty.
-
getService
public List<Reference> getService()
Indicated the rendered service that caused this charge.- Returns:
- An unmodifiable list containing immutable objects of type
Referencethat may be empty.
-
getProduct
public Element getProduct()
Identifies the device, food, drug or other product being charged either by type code or reference to an instance.- Returns:
- An immutable object of type
Elementthat may be null.
-
getAccount
public List<Reference> getAccount()
Account into which this ChargeItems belongs.- Returns:
- An unmodifiable list containing immutable objects of type
Referencethat may be empty.
-
getNote
public List<Annotation> getNote()
Comments made about the event by the performer, subject or other participants.- Returns:
- An unmodifiable list containing immutable objects of type
Annotationthat may be empty.
-
getSupportingInformation
public List<Reference> getSupportingInformation()
Further information supporting this charge.- Returns:
- An unmodifiable list containing immutable objects of type
Referencethat may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classDomainResource
-
accept
public void accept(String elementName, int elementIndex, Visitor visitor)
Description copied from interface:VisitableAccept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }- Specified by:
acceptin interfaceVisitable- Specified by:
acceptin classAbstractVisitable- Parameters:
elementName- the name of the element in the context of this visitelementIndex- the index of the element in a list or -1 if it is not contained within a Listvisitor- the visitor to use
-
toBuilder
public ChargeItem.Builder toBuilder()
Description copied from class:ResourceCreate a new Builder from the contents of this Resource- Specified by:
toBuilderin classDomainResource
-
builder
public static ChargeItem.Builder builder()
-
-