Package org.hl7.fhir.r5.model

Class ChargeItem

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.ChargeItem

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

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.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChargeItem.ChargeItemPerformerComponent
static enum	ChargeItem.ChargeItemStatus
static class	ChargeItem.ChargeItemStatusEnumFactory

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Reference>	account	Account into which this ChargeItems belongs.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ACCOUNT	Fluent Client search parameter constant for account
protected List<CodeableConcept>	bodysite	The anatomical location where the related service has been applied.
protected CodeableConcept	code	A code that identifies the charge, like a billing code.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CODE	Fluent Client search parameter constant for code
protected Reference	costCenter	The financial cost center permits the tracking of charge attribution.
protected List<CanonicalType>	definitionCanonical	References the source of pricing information, rules of application for the code this ChargeItem uses.
protected List<UriType>	definitionUri	References the (external) source of pricing information, rules of application for the code this ChargeItem uses.
protected Reference	encounter	This ChargeItem has the details of how the associated Encounter should be billed or otherwise be handled by finance systems.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENCOUNTER	Fluent Client search parameter constant for encounter
static final ca.uhn.fhir.rest.gclient.DateClientParam	ENTERED_DATE	Fluent Client search parameter constant for entered-date
protected DateTimeType	enteredDate	Date the charge item was entered.
protected Reference	enterer	The device, practitioner, etc.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENTERER	Fluent Client search parameter constant for enterer
static final ca.uhn.fhir.rest.gclient.NumberClientParam	FACTOR_OVERRIDE	Fluent Client search parameter constant for factor-override
protected List<Identifier>	identifier	Identifiers assigned to this event performer or other systems.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_ACCOUNT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ENCOUNTER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ENTERER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PERFORMER_ACTOR	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PERFORMING_ORGANIZATION	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_REQUESTING_ORGANIZATION	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SERVICE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUBJECT	Constant for fluent queries to be used to add include statements.
protected List<Annotation>	note	Comments made about the event by the performer, subject or other participants.
protected DataType	occurrence	Date/time(s) or duration when the charged service was applied.
static final ca.uhn.fhir.rest.gclient.DateClientParam	OCCURRENCE	Fluent Client search parameter constant for occurrence
protected CodeableConcept	overrideReason	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.
protected List<Reference>	partOf	ChargeItems can be grouped to larger ChargeItems covering the whole set.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected List<ChargeItem.ChargeItemPerformerComponent>	performer	Indicates who or what performed or participated in the charged service.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PERFORMER_ACTOR	Fluent Client search parameter constant for performer-actor
static final ca.uhn.fhir.rest.gclient.TokenClientParam	PERFORMER_FUNCTION	Fluent Client search parameter constant for performer-function
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PERFORMING_ORGANIZATION	Fluent Client search parameter constant for performing-organization
protected Reference	performingOrganization	The organization performing the service.
static final ca.uhn.fhir.rest.gclient.QuantityClientParam	PRICE_OVERRIDE	Fluent Client search parameter constant for price-override
protected List<CodeableReference>	product	Identifies the device, food, drug or other product being charged either by type code or reference to an instance.
protected Quantity	quantity	Quantity of which the charge item has been serviced.
static final ca.uhn.fhir.rest.gclient.QuantityClientParam	QUANTITY	Fluent Client search parameter constant for quantity
protected List<CodeableConcept>	reason	Describes why the event occurred in coded or textual form.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	REQUESTING_ORGANIZATION	Fluent Client search parameter constant for requesting-organization
protected Reference	requestingOrganization	The organization requesting the service.
protected List<CodeableReference>	service	Indicated the rendered service that caused this charge.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SERVICE	Fluent Client search parameter constant for service
static final String	SP_ACCOUNT	Search parameter: account
static final String	SP_CODE	Search parameter: code
static final String	SP_ENCOUNTER	Search parameter: encounter
static final String	SP_ENTERED_DATE	Search parameter: entered-date
static final String	SP_ENTERER	Search parameter: enterer
static final String	SP_FACTOR_OVERRIDE	Search parameter: factor-override
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_OCCURRENCE	Search parameter: occurrence
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_PERFORMER_ACTOR	Search parameter: performer-actor
static final String	SP_PERFORMER_FUNCTION	Search parameter: performer-function
static final String	SP_PERFORMING_ORGANIZATION	Search parameter: performing-organization
static final String	SP_PRICE_OVERRIDE	Search parameter: price-override
static final String	SP_QUANTITY	Search parameter: quantity
static final String	SP_REQUESTING_ORGANIZATION	Search parameter: requesting-organization
static final String	SP_SERVICE	Search parameter: service
static final String	SP_SUBJECT	Search parameter: subject
protected Enumeration<ChargeItem.ChargeItemStatus>	status	The current state of the ChargeItem.
protected Reference	subject	The individual or set of individuals the action is being or was performed on.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBJECT	Fluent Client search parameter constant for subject
protected List<Reference>	supportingInformation	Further information supporting this charge.
protected MonetaryComponent	totalPriceComponent	The total price for the chargable item, accounting for the quantity.
protected MonetaryComponent	unitPriceComponent	The unit price of the chargable item.

Fields inherited from class org.hl7.fhir.r5.model.DomainResource

contained, extension, modifierExtension, SP_TEXT, text, TEXT

Fields inherited from class org.hl7.fhir.r5.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, SP_RES_ID

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
ChargeItem()	Constructor
ChargeItem(ChargeItem.ChargeItemStatus status, CodeableConcept code, Reference subject)	Constructor

Method Summary

Modifier and Type	Method	Description
Reference	addAccount()
ChargeItem	addAccount(Reference t)
CodeableConcept	addBodysite()
ChargeItem	addBodysite(CodeableConcept t)
Base	addChild(String name)
ChargeItem	addDefinitionCanonical(String value)
CanonicalType	addDefinitionCanonicalElement()
ChargeItem	addDefinitionUri(String value)
UriType	addDefinitionUriElement()
Identifier	addIdentifier()
ChargeItem	addIdentifier(Identifier t)
Annotation	addNote()
ChargeItem	addNote(Annotation t)
Reference	addPartOf()
ChargeItem	addPartOf(Reference t)
ChargeItem.ChargeItemPerformerComponent	addPerformer()
ChargeItem	addPerformer(ChargeItem.ChargeItemPerformerComponent t)
CodeableReference	addProduct()
ChargeItem	addProduct(CodeableReference t)
CodeableConcept	addReason()
ChargeItem	addReason(CodeableConcept t)
CodeableReference	addService()
ChargeItem	addService(CodeableReference t)
Reference	addSupportingInformation()
ChargeItem	addSupportingInformation(Reference t)
ChargeItem	copy()
void	copyValues(ChargeItem dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<Reference>	getAccount()
Reference	getAccountFirstRep()
List<CodeableConcept>	getBodysite()
CodeableConcept	getBodysiteFirstRep()
CodeableConcept	getCode()
Reference	getCostCenter()
List<CanonicalType>	getDefinitionCanonical()
List<UriType>	getDefinitionUri()
Reference	getEncounter()
Date	getEnteredDate()
DateTimeType	getEnteredDateElement()
Reference	getEnterer()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
DataType	getOccurrence()
DateTimeType	getOccurrenceDateTimeType()
Period	getOccurrencePeriod()
Timing	getOccurrenceTiming()
CodeableConcept	getOverrideReason()
List<Reference>	getPartOf()
Reference	getPartOfFirstRep()
List<ChargeItem.ChargeItemPerformerComponent>	getPerformer()
ChargeItem.ChargeItemPerformerComponent	getPerformerFirstRep()
Reference	getPerformingOrganization()
List<CodeableReference>	getProduct()
CodeableReference	getProductFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
Quantity	getQuantity()
List<CodeableConcept>	getReason()
CodeableConcept	getReasonFirstRep()
Reference	getRequestingOrganization()
ResourceType	getResourceType()
List<CodeableReference>	getService()
CodeableReference	getServiceFirstRep()
ChargeItem.ChargeItemStatus	getStatus()
Enumeration<ChargeItem.ChargeItemStatus>	getStatusElement()
Reference	getSubject()
List<Reference>	getSupportingInformation()
Reference	getSupportingInformationFirstRep()
MonetaryComponent	getTotalPriceComponent()
String[]	getTypesForProperty(int hash, String name)
MonetaryComponent	getUnitPriceComponent()
boolean	hasAccount()
boolean	hasBodysite()
boolean	hasCode()
boolean	hasCostCenter()
boolean	hasDefinitionCanonical()
boolean	hasDefinitionCanonical(String value)
boolean	hasDefinitionUri()
boolean	hasDefinitionUri(String value)
boolean	hasEncounter()
boolean	hasEnteredDate()
boolean	hasEnteredDateElement()
boolean	hasEnterer()
boolean	hasIdentifier()
boolean	hasNote()
boolean	hasOccurrence()
boolean	hasOccurrenceDateTimeType()
boolean	hasOccurrencePeriod()
boolean	hasOccurrenceTiming()
boolean	hasOverrideReason()
boolean	hasPartOf()
boolean	hasPerformer()
boolean	hasPerformingOrganization()
boolean	hasProduct()
boolean	hasQuantity()
boolean	hasReason()
boolean	hasRequestingOrganization()
boolean	hasService()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	hasSupportingInformation()
boolean	hasTotalPriceComponent()
boolean	hasUnitPriceComponent()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
ChargeItem	setAccount(List<Reference> theAccount)
ChargeItem	setBodysite(List<CodeableConcept> theBodysite)
ChargeItem	setCode(CodeableConcept value)
ChargeItem	setCostCenter(Reference value)
ChargeItem	setDefinitionCanonical(List<CanonicalType> theDefinitionCanonical)
ChargeItem	setDefinitionUri(List<UriType> theDefinitionUri)
ChargeItem	setEncounter(Reference value)
ChargeItem	setEnteredDate(Date value)
ChargeItem	setEnteredDateElement(DateTimeType value)
ChargeItem	setEnterer(Reference value)
ChargeItem	setIdentifier(List<Identifier> theIdentifier)
ChargeItem	setNote(List<Annotation> theNote)
ChargeItem	setOccurrence(DataType value)
ChargeItem	setOverrideReason(CodeableConcept value)
ChargeItem	setPartOf(List<Reference> thePartOf)
ChargeItem	setPerformer(List<ChargeItem.ChargeItemPerformerComponent> thePerformer)
ChargeItem	setPerformingOrganization(Reference value)
ChargeItem	setProduct(List<CodeableReference> theProduct)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ChargeItem	setQuantity(Quantity value)
ChargeItem	setReason(List<CodeableConcept> theReason)
ChargeItem	setRequestingOrganization(Reference value)
ChargeItem	setService(List<CodeableReference> theService)
ChargeItem	setStatus(ChargeItem.ChargeItemStatus value)
ChargeItem	setStatusElement(Enumeration<ChargeItem.ChargeItemStatus> value)
ChargeItem	setSubject(Reference value)
ChargeItem	setSupportingInformation(List<Reference> theSupportingInformation)
ChargeItem	setTotalPriceComponent(MonetaryComponent value)
ChargeItem	setUnitPriceComponent(MonetaryComponent value)
protected ChargeItem	typedCopy()

Methods inherited from class org.hl7.fhir.r5.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r5.model.Resource

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage

Methods inherited from class org.hl7.fhir.r5.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

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

addDefinition, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, hasValidationInfo, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, removeChild, 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.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, setId

Field Details

identifier

protected List<Identifier> identifier

Identifiers assigned to this event performer or other systems.

definitionUri

protected List<UriType> definitionUri

References the (external) source of pricing information, rules of application for the code this ChargeItem uses.

definitionCanonical

protected List<CanonicalType> definitionCanonical

References the source of pricing information, rules of application for the code this ChargeItem uses.

status

protected Enumeration<ChargeItem.ChargeItemStatus> status

The current state of the ChargeItem.

partOf

protected List<Reference> partOf

ChargeItems can be grouped to larger ChargeItems covering the whole set.

code

protected CodeableConcept code

A code that identifies the charge, like a billing code.

subject

protected Reference subject

The individual or set of individuals the action is being or was performed on.

encounter

protected Reference encounter

This ChargeItem has the details of how the associated Encounter should be billed or otherwise be handled by finance systems.

occurrence

protected DataType occurrence

Date/time(s) or duration when the charged service was applied.

performer

protected List<ChargeItem.ChargeItemPerformerComponent> performer

Indicates who or what performed or participated in the charged service.

performingOrganization

protected Reference performingOrganization

The organization performing the service.

requestingOrganization

protected Reference requestingOrganization

The organization requesting the service.

costCenter

protected Reference costCenter

The financial cost center permits the tracking of charge attribution.

quantity

protected Quantity quantity

Quantity of which the charge item has been serviced.

bodysite

protected List<CodeableConcept> bodysite

The anatomical location where the related service has been applied.

unitPriceComponent

protected MonetaryComponent unitPriceComponent

The unit price of the chargable item.

totalPriceComponent

protected MonetaryComponent totalPriceComponent

The total price for the chargable item, accounting for the quantity.

overrideReason

protected CodeableConcept overrideReason

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.

enterer

protected Reference enterer

The device, practitioner, etc. who entered the charge item.

enteredDate

protected DateTimeType enteredDate

Date the charge item was entered.

reason

protected List<CodeableConcept> reason

Describes why the event occurred in coded or textual form.

service

protected List<CodeableReference> service

Indicated the rendered service that caused this charge.

product

protected List<CodeableReference> product

Identifies the device, food, drug or other product being charged either by type code or reference to an instance.

account

protected List<Reference> account

Account into which this ChargeItems belongs.

note

protected List<Annotation> note

Comments made about the event by the performer, subject or other participants.

supportingInformation

protected List<Reference> supportingInformation

Further information supporting this charge.

SP_ACCOUNT

public static final String SP_ACCOUNT

Search parameter: account

Description: Account to place this charge
Type: reference
Path: ChargeItem.account

See Also:

• Constant Field Values

ACCOUNT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ACCOUNT

Fluent Client search parameter constant for account

Description: Account to place this charge
Type: reference
Path: ChargeItem.account

INCLUDE_ACCOUNT

public static final ca.uhn.fhir.model.api.Include INCLUDE_ACCOUNT

Constant for fluent queries to be used to add include statements. Specifies the path value of "ChargeItem:account".

SP_CODE

public static final String SP_CODE

Search parameter: code

Description: A code that identifies the charge, like a billing code
Type: token
Path: ChargeItem.code

See Also:

• Constant Field Values

CODE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE

Fluent Client search parameter constant for code

Description: A code that identifies the charge, like a billing code
Type: token
Path: ChargeItem.code

SP_ENCOUNTER

public static final String SP_ENCOUNTER

Search parameter: encounter

Description: Encounter associated with event
Type: reference
Path: ChargeItem.encounter

See Also:

• Constant Field Values

ENCOUNTER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER

Fluent Client search parameter constant for encounter

Description: Encounter associated with event
Type: reference
Path: ChargeItem.encounter

INCLUDE_ENCOUNTER

public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER

Constant for fluent queries to be used to add include statements. Specifies the path value of "ChargeItem:encounter".

SP_ENTERED_DATE

public static final String SP_ENTERED_DATE

Search parameter: entered-date

Description: Date the charge item was entered
Type: date
Path: ChargeItem.enteredDate

See Also:

• Constant Field Values

ENTERED_DATE

public static final ca.uhn.fhir.rest.gclient.DateClientParam ENTERED_DATE

Fluent Client search parameter constant for entered-date

Description: Date the charge item was entered
Type: date
Path: ChargeItem.enteredDate

SP_ENTERER

public static final String SP_ENTERER

Search parameter: enterer

Description: Individual who was entering
Type: reference
Path: ChargeItem.enterer

See Also:

• Constant Field Values

ENTERER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENTERER

Fluent Client search parameter constant for enterer

Description: Individual who was entering
Type: reference
Path: ChargeItem.enterer

INCLUDE_ENTERER

public static final ca.uhn.fhir.model.api.Include INCLUDE_ENTERER

Constant for fluent queries to be used to add include statements. Specifies the path value of "ChargeItem:enterer".

SP_FACTOR_OVERRIDE

public static final String SP_FACTOR_OVERRIDE

Search parameter: factor-override

Description: Factor overriding the associated rules
Type: number
Path: ChargeItem.totalPriceComponent.factor

See Also:

• Constant Field Values

FACTOR_OVERRIDE

public static final ca.uhn.fhir.rest.gclient.NumberClientParam FACTOR_OVERRIDE

Fluent Client search parameter constant for factor-override

Description: Factor overriding the associated rules
Type: number
Path: ChargeItem.totalPriceComponent.factor

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Business Identifier for item
Type: token
Path: ChargeItem.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: Business Identifier for item
Type: token
Path: ChargeItem.identifier

SP_OCCURRENCE

public static final String SP_OCCURRENCE

Search parameter: occurrence

Description: When the charged service was applied
Type: date
Path: ChargeItem.occurrence.as(dateTime) | ChargeItem.occurrence.as(Period) | ChargeItem.occurrence.as(Timing)

See Also:

• Constant Field Values

OCCURRENCE

public static final ca.uhn.fhir.rest.gclient.DateClientParam OCCURRENCE

Fluent Client search parameter constant for occurrence

Description: When the charged service was applied
Type: date
Path: ChargeItem.occurrence.as(dateTime) | ChargeItem.occurrence.as(Period) | ChargeItem.occurrence.as(Timing)

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: Individual service was done for/to
Type: reference
Path: ChargeItem.subject.where(resolve() is Patient)

See Also:

• Constant Field Values

PATIENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description: Individual service was done for/to
Type: reference
Path: ChargeItem.subject.where(resolve() is Patient)

INCLUDE_PATIENT

public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "ChargeItem:patient".

SP_PERFORMER_ACTOR

public static final String SP_PERFORMER_ACTOR

Search parameter: performer-actor

Description: Individual who was performing
Type: reference
Path: ChargeItem.performer.actor

See Also:

• Constant Field Values

PERFORMER_ACTOR

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PERFORMER_ACTOR

Fluent Client search parameter constant for performer-actor

Description: Individual who was performing
Type: reference
Path: ChargeItem.performer.actor

INCLUDE_PERFORMER_ACTOR

public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMER_ACTOR

Constant for fluent queries to be used to add include statements. Specifies the path value of "ChargeItem:performer-actor".

SP_PERFORMER_FUNCTION

public static final String SP_PERFORMER_FUNCTION

Search parameter: performer-function

Description: What type of performance was done
Type: token
Path: ChargeItem.performer.function

See Also:

• Constant Field Values

PERFORMER_FUNCTION

public static final ca.uhn.fhir.rest.gclient.TokenClientParam PERFORMER_FUNCTION

Fluent Client search parameter constant for performer-function

Description: What type of performance was done
Type: token
Path: ChargeItem.performer.function

SP_PERFORMING_ORGANIZATION

public static final String SP_PERFORMING_ORGANIZATION

Search parameter: performing-organization

Description: Organization providing the charged service
Type: reference
Path: ChargeItem.performingOrganization

See Also:

• Constant Field Values

PERFORMING_ORGANIZATION

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PERFORMING_ORGANIZATION

Fluent Client search parameter constant for performing-organization

Description: Organization providing the charged service
Type: reference
Path: ChargeItem.performingOrganization

INCLUDE_PERFORMING_ORGANIZATION

public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMING_ORGANIZATION

Constant for fluent queries to be used to add include statements. Specifies the path value of "ChargeItem:performing-organization".

SP_PRICE_OVERRIDE

public static final String SP_PRICE_OVERRIDE

Search parameter: price-override

Description: Price overriding the associated rules
Type: quantity
Path: ChargeItem.totalPriceComponent.amount

See Also:

• Constant Field Values

PRICE_OVERRIDE

public static final ca.uhn.fhir.rest.gclient.QuantityClientParam PRICE_OVERRIDE

Fluent Client search parameter constant for price-override

Description: Price overriding the associated rules
Type: quantity
Path: ChargeItem.totalPriceComponent.amount

SP_QUANTITY

public static final String SP_QUANTITY

Search parameter: quantity

Description: Quantity of which the charge item has been serviced
Type: quantity
Path: ChargeItem.quantity

See Also:

• Constant Field Values

QUANTITY

public static final ca.uhn.fhir.rest.gclient.QuantityClientParam QUANTITY

Fluent Client search parameter constant for quantity

Description: Quantity of which the charge item has been serviced
Type: quantity
Path: ChargeItem.quantity

SP_REQUESTING_ORGANIZATION

public static final String SP_REQUESTING_ORGANIZATION

Search parameter: requesting-organization

Description: Organization requesting the charged service
Type: reference
Path: ChargeItem.requestingOrganization

See Also:

• Constant Field Values

REQUESTING_ORGANIZATION

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REQUESTING_ORGANIZATION

Fluent Client search parameter constant for requesting-organization

Description: Organization requesting the charged service
Type: reference
Path: ChargeItem.requestingOrganization

INCLUDE_REQUESTING_ORGANIZATION

public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUESTING_ORGANIZATION

Constant for fluent queries to be used to add include statements. Specifies the path value of "ChargeItem:requesting-organization".

SP_SERVICE

public static final String SP_SERVICE

Search parameter: service

Description: Which rendered service is being charged?
Type: reference
Path: ChargeItem.service.reference

See Also:

• Constant Field Values

SERVICE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SERVICE

Fluent Client search parameter constant for service

Description: Which rendered service is being charged?
Type: reference
Path: ChargeItem.service.reference

INCLUDE_SERVICE

public static final ca.uhn.fhir.model.api.Include INCLUDE_SERVICE

Constant for fluent queries to be used to add include statements. Specifies the path value of "ChargeItem:service".

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: subject

Description: Individual service was done for/to
Type: reference
Path: ChargeItem.subject

See Also:

• Constant Field Values

SUBJECT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT

Fluent Client search parameter constant for subject

Description: Individual service was done for/to
Type: reference
Path: ChargeItem.subject

INCLUDE_SUBJECT

public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT

Constant for fluent queries to be used to add include statements. Specifies the path value of "ChargeItem:subject".

Constructor Details

ChargeItem

public ChargeItem()

Constructor

ChargeItem

public ChargeItem(ChargeItem.ChargeItemStatus status,
 CodeableConcept code,
 Reference subject)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Identifiers assigned to this event performer or other systems.)

setIdentifier

public ChargeItem setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public ChargeItem addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist {3}

getDefinitionUri

public List<UriType> getDefinitionUri()

Returns:

definitionUri (References the (external) source of pricing information, rules of application for the code this ChargeItem uses.)

setDefinitionUri

public ChargeItem setDefinitionUri(List<UriType> theDefinitionUri)

Returns:

Returns a reference to this for easy method chaining

hasDefinitionUri

public boolean hasDefinitionUri()

addDefinitionUriElement

public UriType addDefinitionUriElement()

Returns:

definitionUri (References the (external) source of pricing information, rules of application for the code this ChargeItem uses.)

addDefinitionUri

public ChargeItem addDefinitionUri(String value)

Parameters:

value - definitionUri (References the (external) source of pricing information, rules of application for the code this ChargeItem uses.)

hasDefinitionUri

public boolean hasDefinitionUri(String value)

Parameters:

value - definitionUri (References the (external) source of pricing information, rules of application for the code this ChargeItem uses.)

getDefinitionCanonical

public List<CanonicalType> getDefinitionCanonical()

Returns:

definitionCanonical (References the source of pricing information, rules of application for the code this ChargeItem uses.)

setDefinitionCanonical

public ChargeItem setDefinitionCanonical(List<CanonicalType> theDefinitionCanonical)

Returns:

Returns a reference to this for easy method chaining

hasDefinitionCanonical

public boolean hasDefinitionCanonical()

addDefinitionCanonicalElement

public CanonicalType addDefinitionCanonicalElement()

Returns:

definitionCanonical (References the source of pricing information, rules of application for the code this ChargeItem uses.)

addDefinitionCanonical

public ChargeItem addDefinitionCanonical(String value)

Parameters:

value - definitionCanonical (References the source of pricing information, rules of application for the code this ChargeItem uses.)

hasDefinitionCanonical

public boolean hasDefinitionCanonical(String value)

Parameters:

value - definitionCanonical (References the source of pricing information, rules of application for the code this ChargeItem uses.)

getStatusElement

public Enumeration<ChargeItem.ChargeItemStatus> getStatusElement()

Returns:

status (The current state of the ChargeItem.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public ChargeItem setStatusElement(Enumeration<ChargeItem.ChargeItemStatus> value)

Parameters:

value - status (The current state of the ChargeItem.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public ChargeItem.ChargeItemStatus getStatus()

Returns:

The current state of the ChargeItem.

setStatus

public ChargeItem setStatus(ChargeItem.ChargeItemStatus value)

Parameters:

value - The current state of the ChargeItem.

getPartOf

public List<Reference> getPartOf()

Returns:

partOf (ChargeItems can be grouped to larger ChargeItems covering the whole set.)

setPartOf

public ChargeItem setPartOf(List<Reference> thePartOf)

Returns:

Returns a reference to this for easy method chaining

hasPartOf

public boolean hasPartOf()

addPartOf

public Reference addPartOf()

addPartOf

public ChargeItem addPartOf(Reference t)

getPartOfFirstRep

public Reference getPartOfFirstRep()

Returns:

The first repetition of repeating field partOf, creating it if it does not already exist {3}

getCode

public CodeableConcept getCode()

Returns:

code (A code that identifies the charge, like a billing code.)

hasCode

public boolean hasCode()

setCode

public ChargeItem setCode(CodeableConcept value)

Parameters:

value - code (A code that identifies the charge, like a billing code.)

getSubject

public Reference getSubject()

Returns:

subject (The individual or set of individuals the action is being or was performed on.)

hasSubject

public boolean hasSubject()

setSubject

public ChargeItem setSubject(Reference value)

Parameters:

value - subject (The individual or set of individuals the action is being or was performed on.)

getEncounter

public Reference getEncounter()

Returns:

encounter (This ChargeItem has the details of how the associated Encounter should be billed or otherwise be handled by finance systems.)

hasEncounter

public boolean hasEncounter()

setEncounter

public ChargeItem setEncounter(Reference value)

Parameters:

value - encounter (This ChargeItem has the details of how the associated Encounter should be billed or otherwise be handled by finance systems.)

getOccurrence

public DataType getOccurrence()

Returns:

occurrence (Date/time(s) or duration when the charged service was applied.)

getOccurrenceDateTimeType

public DateTimeType getOccurrenceDateTimeType()
                                       throws org.hl7.fhir.exceptions.FHIRException

Returns:

occurrence (Date/time(s) or duration when the charged service was applied.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasOccurrenceDateTimeType

public boolean hasOccurrenceDateTimeType()

getOccurrencePeriod

public Period getOccurrencePeriod()
                           throws org.hl7.fhir.exceptions.FHIRException

Returns:

occurrence (Date/time(s) or duration when the charged service was applied.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasOccurrencePeriod

public boolean hasOccurrencePeriod()

getOccurrenceTiming

public Timing getOccurrenceTiming()
                           throws org.hl7.fhir.exceptions.FHIRException

Returns:

occurrence (Date/time(s) or duration when the charged service was applied.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasOccurrenceTiming

public boolean hasOccurrenceTiming()

hasOccurrence

public boolean hasOccurrence()

setOccurrence

public ChargeItem setOccurrence(DataType value)

Parameters:

value - occurrence (Date/time(s) or duration when the charged service was applied.)

getPerformer

public List<ChargeItem.ChargeItemPerformerComponent> getPerformer()

Returns:

performer (Indicates who or what performed or participated in the charged service.)

setPerformer

public ChargeItem setPerformer(List<ChargeItem.ChargeItemPerformerComponent> thePerformer)

Returns:

Returns a reference to this for easy method chaining

hasPerformer

public boolean hasPerformer()

addPerformer

public ChargeItem.ChargeItemPerformerComponent addPerformer()

addPerformer

public ChargeItem addPerformer(ChargeItem.ChargeItemPerformerComponent t)

getPerformerFirstRep

public ChargeItem.ChargeItemPerformerComponent getPerformerFirstRep()

Returns:

The first repetition of repeating field performer, creating it if it does not already exist {3}

getPerformingOrganization

public Reference getPerformingOrganization()

Returns:

performingOrganization (The organization performing the service.)

hasPerformingOrganization

public boolean hasPerformingOrganization()

setPerformingOrganization

public ChargeItem setPerformingOrganization(Reference value)

Parameters:

value - performingOrganization (The organization performing the service.)

getRequestingOrganization

public Reference getRequestingOrganization()

Returns:

requestingOrganization (The organization requesting the service.)

hasRequestingOrganization

public boolean hasRequestingOrganization()

setRequestingOrganization

public ChargeItem setRequestingOrganization(Reference value)

Parameters:

value - requestingOrganization (The organization requesting the service.)

getCostCenter

public Reference getCostCenter()

Returns:

costCenter (The financial cost center permits the tracking of charge attribution.)

hasCostCenter

public boolean hasCostCenter()

setCostCenter

public ChargeItem setCostCenter(Reference value)

Parameters:

value - costCenter (The financial cost center permits the tracking of charge attribution.)

getQuantity

public Quantity getQuantity()

Returns:

quantity (Quantity of which the charge item has been serviced.)

hasQuantity

public boolean hasQuantity()

setQuantity

public ChargeItem setQuantity(Quantity value)

Parameters:

value - quantity (Quantity of which the charge item has been serviced.)

getBodysite

public List<CodeableConcept> getBodysite()

Returns:

bodysite (The anatomical location where the related service has been applied.)

setBodysite

public ChargeItem setBodysite(List<CodeableConcept> theBodysite)

Returns:

Returns a reference to this for easy method chaining

hasBodysite

public boolean hasBodysite()

addBodysite

public CodeableConcept addBodysite()

addBodysite

public ChargeItem addBodysite(CodeableConcept t)

getBodysiteFirstRep

public CodeableConcept getBodysiteFirstRep()

Returns:

The first repetition of repeating field bodysite, creating it if it does not already exist {3}

getUnitPriceComponent

public MonetaryComponent getUnitPriceComponent()

Returns:

unitPriceComponent (The unit price of the chargable item.)

hasUnitPriceComponent

public boolean hasUnitPriceComponent()

setUnitPriceComponent

public ChargeItem setUnitPriceComponent(MonetaryComponent value)

Parameters:

value - unitPriceComponent (The unit price of the chargable item.)

getTotalPriceComponent

public MonetaryComponent getTotalPriceComponent()

Returns:

totalPriceComponent (The total price for the chargable item, accounting for the quantity.)

hasTotalPriceComponent

public boolean hasTotalPriceComponent()

setTotalPriceComponent

public ChargeItem setTotalPriceComponent(MonetaryComponent value)

Parameters:

value - totalPriceComponent (The total price for the chargable item, accounting for the quantity.)

getOverrideReason

public CodeableConcept getOverrideReason()

Returns:

overrideReason (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.)

hasOverrideReason

public boolean hasOverrideReason()

setOverrideReason

public ChargeItem setOverrideReason(CodeableConcept value)

Parameters:

value - overrideReason (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.)

getEnterer

public Reference getEnterer()

Returns:

enterer (The device, practitioner, etc. who entered the charge item.)

hasEnterer

public boolean hasEnterer()

setEnterer

public ChargeItem setEnterer(Reference value)

Parameters:

value - enterer (The device, practitioner, etc. who entered the charge item.)

getEnteredDateElement

public DateTimeType getEnteredDateElement()

Returns:

enteredDate (Date the charge item was entered.). This is the underlying object with id, value and extensions. The accessor "getEnteredDate" gives direct access to the value

hasEnteredDateElement

public boolean hasEnteredDateElement()

hasEnteredDate

public boolean hasEnteredDate()

setEnteredDateElement

public ChargeItem setEnteredDateElement(DateTimeType value)

Parameters:

value - enteredDate (Date the charge item was entered.). This is the underlying object with id, value and extensions. The accessor "getEnteredDate" gives direct access to the value

getEnteredDate

public Date getEnteredDate()

Returns:

Date the charge item was entered.

setEnteredDate

public ChargeItem setEnteredDate(Date value)

Parameters:

value - Date the charge item was entered.

getReason

public List<CodeableConcept> getReason()

Returns:

reason (Describes why the event occurred in coded or textual form.)

setReason

public ChargeItem setReason(List<CodeableConcept> theReason)

Returns:

Returns a reference to this for easy method chaining

hasReason

public boolean hasReason()

addReason

public CodeableConcept addReason()

addReason

public ChargeItem addReason(CodeableConcept t)

getReasonFirstRep

public CodeableConcept getReasonFirstRep()

Returns:

The first repetition of repeating field reason, creating it if it does not already exist {3}

getService

public List<CodeableReference> getService()

Returns:

service (Indicated the rendered service that caused this charge.)

setService

public ChargeItem setService(List<CodeableReference> theService)

Returns:

Returns a reference to this for easy method chaining

hasService

public boolean hasService()

addService

public CodeableReference addService()

addService

public ChargeItem addService(CodeableReference t)

getServiceFirstRep

public CodeableReference getServiceFirstRep()

Returns:

The first repetition of repeating field service, creating it if it does not already exist {3}

getProduct

public List<CodeableReference> getProduct()

Returns:

product (Identifies the device, food, drug or other product being charged either by type code or reference to an instance.)

setProduct

public ChargeItem setProduct(List<CodeableReference> theProduct)

Returns:

Returns a reference to this for easy method chaining

hasProduct

public boolean hasProduct()

addProduct

public CodeableReference addProduct()

addProduct

public ChargeItem addProduct(CodeableReference t)

getProductFirstRep

public CodeableReference getProductFirstRep()

Returns:

The first repetition of repeating field product, creating it if it does not already exist {3}

getAccount

public List<Reference> getAccount()

Returns:

account (Account into which this ChargeItems belongs.)

setAccount

public ChargeItem setAccount(List<Reference> theAccount)

Returns:

Returns a reference to this for easy method chaining

hasAccount

public boolean hasAccount()

addAccount

public Reference addAccount()

addAccount

public ChargeItem addAccount(Reference t)

getAccountFirstRep

public Reference getAccountFirstRep()

Returns:

The first repetition of repeating field account, creating it if it does not already exist {3}

getNote

public List<Annotation> getNote()

Returns:

note (Comments made about the event by the performer, subject or other participants.)

setNote

public ChargeItem setNote(List<Annotation> theNote)

Returns:

Returns a reference to this for easy method chaining

hasNote

public boolean hasNote()

addNote

public Annotation addNote()

addNote

public ChargeItem addNote(Annotation t)

getNoteFirstRep

public Annotation getNoteFirstRep()

Returns:

The first repetition of repeating field note, creating it if it does not already exist {3}

getSupportingInformation

public List<Reference> getSupportingInformation()

Returns:

supportingInformation (Further information supporting this charge.)

setSupportingInformation

public ChargeItem setSupportingInformation(List<Reference> theSupportingInformation)

Returns:

Returns a reference to this for easy method chaining

hasSupportingInformation

public boolean hasSupportingInformation()

addSupportingInformation

public Reference addSupportingInformation()

addSupportingInformation

public ChargeItem addSupportingInformation(Reference t)

getSupportingInformationFirstRep

public Reference getSupportingInformationFirstRep()

Returns:

The first repetition of repeating field supportingInformation, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

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 DomainResource

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 DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public ChargeItem copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(ChargeItem dst)

typedCopy

protected ChargeItem typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource