Class ChargeItem.Builder
- java.lang.Object
-
- com.ibm.fhir.model.builder.AbstractBuilder<Resource>
-
- com.ibm.fhir.model.resource.Resource.Builder
-
- com.ibm.fhir.model.resource.DomainResource.Builder
-
- com.ibm.fhir.model.resource.ChargeItem.Builder
-
- Enclosing class:
- ChargeItem
public static class ChargeItem.Builder extends DomainResource.Builder
-
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource.Builder
contained, extension, modifierExtension, text
-
Fields inherited from class com.ibm.fhir.model.resource.Resource.Builder
id, implicitRules, language, meta
-
Fields inherited from class com.ibm.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ChargeItem.Builderaccount(Reference... account)Account into which this ChargeItems belongs.ChargeItem.Builderaccount(Collection<Reference> account)Account into which this ChargeItems belongs.ChargeItem.Builderbodysite(CodeableConcept... bodysite)The anatomical location where the related service has been applied.ChargeItem.Builderbodysite(Collection<CodeableConcept> bodysite)The anatomical location where the related service has been applied.ChargeItembuild()Build theChargeItemChargeItem.Buildercode(CodeableConcept code)A code that identifies the charge, like a billing code.ChargeItem.Buildercontained(Resource... contained)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.ChargeItem.Buildercontained(Collection<Resource> contained)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.ChargeItem.Buildercontext(Reference context)The encounter or episode of care that establishes the context for this event.ChargeItem.BuildercostCenter(Reference costCenter)The financial cost center permits the tracking of charge attribution.ChargeItem.BuilderdefinitionCanonical(Canonical... definitionCanonical)References the source of pricing information, rules of application for the code this ChargeItem uses.ChargeItem.BuilderdefinitionCanonical(Collection<Canonical> definitionCanonical)References the source of pricing information, rules of application for the code this ChargeItem uses.ChargeItem.BuilderdefinitionUri(Uri... definitionUri)References the (external) source of pricing information, rules of application for the code this ChargeItem uses.ChargeItem.BuilderdefinitionUri(Collection<Uri> definitionUri)References the (external) source of pricing information, rules of application for the code this ChargeItem uses.ChargeItem.BuilderenteredDate(DateTime enteredDate)Date the charge item was entered.ChargeItem.Builderenterer(Reference enterer)The device, practitioner, etc.ChargeItem.Builderextension(Extension... extension)May be used to represent additional information that is not part of the basic definition of the resource.ChargeItem.Builderextension(Collection<Extension> extension)May be used to represent additional information that is not part of the basic definition of the resource.ChargeItem.BuilderfactorOverride(Decimal factorOverride)Factor overriding the factor determined by the rules associated with the code.protected ChargeItem.Builderfrom(ChargeItem chargeItem)ChargeItem.Builderid(String id)The logical id of the resource, as used in the URL for the resource.ChargeItem.Builderidentifier(Identifier... identifier)Identifiers assigned to this event performer or other systems.ChargeItem.Builderidentifier(Collection<Identifier> identifier)Identifiers assigned to this event performer or other systems.ChargeItem.BuilderimplicitRules(Uri implicitRules)A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.ChargeItem.Builderlanguage(Code language)The base language in which the resource is written.ChargeItem.Buildermeta(Meta meta)The metadata about the resource.ChargeItem.BuildermodifierExtension(Extension... modifierExtension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants.ChargeItem.BuildermodifierExtension(Collection<Extension> modifierExtension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants.ChargeItem.Buildernote(Annotation... note)Comments made about the event by the performer, subject or other participants.ChargeItem.Buildernote(Collection<Annotation> note)Comments made about the event by the performer, subject or other participants.ChargeItem.Builderoccurrence(Element occurrence)Date/time(s) or duration when the charged service was applied.ChargeItem.BuilderoverrideReason(String 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.ChargeItem.BuilderoverrideReason(String overrideReason)Convenience method for settingoverrideReason.ChargeItem.BuilderpartOf(Reference... partOf)ChargeItems can be grouped to larger ChargeItems covering the whole set.ChargeItem.BuilderpartOf(Collection<Reference> partOf)ChargeItems can be grouped to larger ChargeItems covering the whole set.ChargeItem.Builderperformer(ChargeItem.Performer... performer)Indicates who or what performed or participated in the charged service.ChargeItem.Builderperformer(Collection<ChargeItem.Performer> performer)Indicates who or what performed or participated in the charged service.ChargeItem.BuilderperformingOrganization(Reference performingOrganization)The organization requesting the service.ChargeItem.BuilderpriceOverride(Money priceOverride)Total price of the charge overriding the list price associated with the code.ChargeItem.Builderproduct(Element product)Identifies the device, food, drug or other product being charged either by type code or reference to an instance.ChargeItem.Builderquantity(Quantity quantity)Quantity of which the charge item has been serviced.ChargeItem.Builderreason(CodeableConcept... reason)Describes why the event occurred in coded or textual form.ChargeItem.Builderreason(Collection<CodeableConcept> reason)Describes why the event occurred in coded or textual form.ChargeItem.BuilderrequestingOrganization(Reference requestingOrganization)The organization performing the service.ChargeItem.Builderservice(Reference... service)Indicated the rendered service that caused this charge.ChargeItem.Builderservice(Collection<Reference> service)Indicated the rendered service that caused this charge.ChargeItem.Builderstatus(ChargeItemStatus status)The current state of the ChargeItem.ChargeItem.Buildersubject(Reference subject)The individual or set of individuals the action is being or was performed on.ChargeItem.BuildersupportingInformation(Reference... supportingInformation)Further information supporting this charge.ChargeItem.BuildersupportingInformation(Collection<Reference> supportingInformation)Further information supporting this charge.ChargeItem.Buildertext(Narrative text)A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human.protected voidvalidate(ChargeItem chargeItem)-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource.Builder
from, validate
-
Methods inherited from class com.ibm.fhir.model.resource.Resource.Builder
from, validate
-
Methods inherited from class com.ibm.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public ChargeItem.Builder id(String id)
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.- Overrides:
idin classDomainResource.Builder- Parameters:
id- Logical id of this artifact- Returns:
- A reference to this Builder instance
-
meta
public ChargeItem.Builder meta(Meta meta)
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.- Overrides:
metain classDomainResource.Builder- Parameters:
meta- Metadata about the resource- Returns:
- A reference to this Builder instance
-
implicitRules
public ChargeItem.Builder implicitRules(Uri implicitRules)
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.- Overrides:
implicitRulesin classDomainResource.Builder- Parameters:
implicitRules- A set of rules under which this content was created- Returns:
- A reference to this Builder instance
-
language
public ChargeItem.Builder language(Code language)
The base language in which the resource is written.- Overrides:
languagein classDomainResource.Builder- Parameters:
language- Language of the resource content- Returns:
- A reference to this Builder instance
-
text
public ChargeItem.Builder text(Narrative text)
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.- Overrides:
textin classDomainResource.Builder- Parameters:
text- Text summary of the resource, for human interpretation- Returns:
- A reference to this Builder instance
-
contained
public ChargeItem.Builder contained(Resource... contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Adds new element(s) to the existing list. If any of the elements are null, calling
build()will fail.- Overrides:
containedin classDomainResource.Builder- Parameters:
contained- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
contained
public ChargeItem.Builder contained(Collection<Resource> contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()will fail.- Overrides:
containedin classDomainResource.Builder- Parameters:
contained- Contained, inline Resources- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException- If the passed collection is null
-
extension
public ChargeItem.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Adds new element(s) to the existing list. If any of the elements are null, calling
build()will fail.- Overrides:
extensionin classDomainResource.Builder- Parameters:
extension- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public ChargeItem.Builder extension(Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()will fail.- Overrides:
extensionin classDomainResource.Builder- Parameters:
extension- Additional content defined by implementations- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException- If the passed collection is null
-
modifierExtension
public ChargeItem.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Adds new element(s) to the existing list. If any of the elements are null, calling
build()will fail.- Overrides:
modifierExtensionin classDomainResource.Builder- Parameters:
modifierExtension- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
modifierExtension
public ChargeItem.Builder modifierExtension(Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()will fail.- Overrides:
modifierExtensionin classDomainResource.Builder- Parameters:
modifierExtension- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException- If the passed collection is null
-
identifier
public ChargeItem.Builder identifier(Identifier... identifier)
Identifiers assigned to this event performer or other systems.Adds new element(s) to the existing list. If any of the elements are null, calling
build()will fail.- Parameters:
identifier- Business Identifier for item- Returns:
- A reference to this Builder instance
-
identifier
public ChargeItem.Builder identifier(Collection<Identifier> identifier)
Identifiers assigned to this event performer or other systems.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()will fail.- Parameters:
identifier- Business Identifier for item- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException- If the passed collection is null
-
definitionUri
public ChargeItem.Builder definitionUri(Uri... definitionUri)
References the (external) source of pricing information, rules of application for the code this ChargeItem uses.Adds new element(s) to the existing list. If any of the elements are null, calling
build()will fail.- Parameters:
definitionUri- Defining information about the code of this charge item- Returns:
- A reference to this Builder instance
-
definitionUri
public ChargeItem.Builder definitionUri(Collection<Uri> definitionUri)
References the (external) source of pricing information, rules of application for the code this ChargeItem uses.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()will fail.- Parameters:
definitionUri- Defining information about the code of this charge item- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException- If the passed collection is null
-
definitionCanonical
public ChargeItem.Builder definitionCanonical(Canonical... definitionCanonical)
References the source of pricing information, rules of application for the code this ChargeItem uses.Adds new element(s) to the existing list. If any of the elements are null, calling
build()will fail.- Parameters:
definitionCanonical- Resource defining the code of this ChargeItem- Returns:
- A reference to this Builder instance
-
definitionCanonical
public ChargeItem.Builder definitionCanonical(Collection<Canonical> definitionCanonical)
References the source of pricing information, rules of application for the code this ChargeItem uses.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()will fail.- Parameters:
definitionCanonical- Resource defining the code of this ChargeItem- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException- If the passed collection is null
-
status
public ChargeItem.Builder status(ChargeItemStatus status)
The current state of the ChargeItem.This element is required.
- Parameters:
status- planned | billable | not-billable | aborted | billed | entered-in-error | unknown- Returns:
- A reference to this Builder instance
-
partOf
public ChargeItem.Builder partOf(Reference... partOf)
ChargeItems can be grouped to larger ChargeItems covering the whole set.Adds new element(s) to the existing list. If any of the elements are null, calling
build()will fail.Allowed resource types for the references:
- Parameters:
partOf- Part of referenced ChargeItem- Returns:
- A reference to this Builder instance
-
partOf
public ChargeItem.Builder partOf(Collection<Reference> partOf)
ChargeItems can be grouped to larger ChargeItems covering the whole set.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()will fail.Allowed resource types for the references:
- Parameters:
partOf- Part of referenced ChargeItem- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException- If the passed collection is null
-
code
public ChargeItem.Builder code(CodeableConcept code)
A code that identifies the charge, like a billing code.This element is required.
- Parameters:
code- A code that identifies the charge, like a billing code- Returns:
- A reference to this Builder instance
-
subject
public ChargeItem.Builder subject(Reference subject)
The individual or set of individuals the action is being or was performed on.This element is required.
Allowed resource types for this reference:
- Parameters:
subject- Individual service was done for/to- Returns:
- A reference to this Builder instance
-
context
public ChargeItem.Builder context(Reference context)
The encounter or episode of care that establishes the context for this event.Allowed resource types for this reference:
- Parameters:
context- Encounter / Episode associated with event- Returns:
- A reference to this Builder instance
-
occurrence
public ChargeItem.Builder occurrence(Element occurrence)
Date/time(s) or duration when the charged service was applied.This is a choice element with the following allowed types:
- Parameters:
occurrence- When the charged service was applied- Returns:
- A reference to this Builder instance
-
performer
public ChargeItem.Builder performer(ChargeItem.Performer... performer)
Indicates who or what performed or participated in the charged service.Adds new element(s) to the existing list. If any of the elements are null, calling
build()will fail.- Parameters:
performer- Who performed charged service- Returns:
- A reference to this Builder instance
-
performer
public ChargeItem.Builder performer(Collection<ChargeItem.Performer> performer)
Indicates who or what performed or participated in the charged service.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()will fail.- Parameters:
performer- Who performed charged service- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException- If the passed collection is null
-
performingOrganization
public ChargeItem.Builder performingOrganization(Reference performingOrganization)
The organization requesting the service.Allowed resource types for this reference:
- Parameters:
performingOrganization- Organization providing the charged service- Returns:
- A reference to this Builder instance
-
requestingOrganization
public ChargeItem.Builder requestingOrganization(Reference requestingOrganization)
The organization performing the service.Allowed resource types for this reference:
- Parameters:
requestingOrganization- Organization requesting the charged service- Returns:
- A reference to this Builder instance
-
costCenter
public ChargeItem.Builder costCenter(Reference costCenter)
The financial cost center permits the tracking of charge attribution.Allowed resource types for this reference:
- Parameters:
costCenter- Organization that has ownership of the (potential, future) revenue- Returns:
- A reference to this Builder instance
-
quantity
public ChargeItem.Builder quantity(Quantity quantity)
Quantity of which the charge item has been serviced.- Parameters:
quantity- Quantity of which the charge item has been serviced- Returns:
- A reference to this Builder instance
-
bodysite
public ChargeItem.Builder bodysite(CodeableConcept... bodysite)
The anatomical location where the related service has been applied.Adds new element(s) to the existing list. If any of the elements are null, calling
build()will fail.- Parameters:
bodysite- Anatomical location, if relevant- Returns:
- A reference to this Builder instance
-
bodysite
public ChargeItem.Builder bodysite(Collection<CodeableConcept> bodysite)
The anatomical location where the related service has been applied.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()will fail.- Parameters:
bodysite- Anatomical location, if relevant- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException- If the passed collection is null
-
factorOverride
public ChargeItem.Builder factorOverride(Decimal factorOverride)
Factor overriding the factor determined by the rules associated with the code.- Parameters:
factorOverride- Factor overriding the associated rules- Returns:
- A reference to this Builder instance
-
priceOverride
public ChargeItem.Builder priceOverride(Money priceOverride)
Total price of the charge overriding the list price associated with the code.- Parameters:
priceOverride- Price overriding the associated rules- Returns:
- A reference to this Builder instance
-
overrideReason
public ChargeItem.Builder overrideReason(String overrideReason)
Convenience method for settingoverrideReason.- Parameters:
overrideReason- Reason for overriding the list price/factor- Returns:
- A reference to this Builder instance
- See Also:
overrideReason(com.ibm.fhir.model.type.String)
-
overrideReason
public ChargeItem.Builder overrideReason(String 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.- Parameters:
overrideReason- Reason for overriding the list price/factor- Returns:
- A reference to this Builder instance
-
enterer
public ChargeItem.Builder enterer(Reference enterer)
The device, practitioner, etc. who entered the charge item.Allowed resource types for this reference:
- Parameters:
enterer- Individual who was entering- Returns:
- A reference to this Builder instance
-
enteredDate
public ChargeItem.Builder enteredDate(DateTime enteredDate)
Date the charge item was entered.- Parameters:
enteredDate- Date the charge item was entered- Returns:
- A reference to this Builder instance
-
reason
public ChargeItem.Builder reason(CodeableConcept... reason)
Describes why the event occurred in coded or textual form.Adds new element(s) to the existing list. If any of the elements are null, calling
build()will fail.- Parameters:
reason- Why was the charged service rendered?- Returns:
- A reference to this Builder instance
-
reason
public ChargeItem.Builder reason(Collection<CodeableConcept> reason)
Describes why the event occurred in coded or textual form.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()will fail.- Parameters:
reason- Why was the charged service rendered?- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException- If the passed collection is null
-
service
public ChargeItem.Builder service(Reference... service)
Indicated the rendered service that caused this charge.Adds new element(s) to the existing list. If any of the elements are null, calling
build()will fail.Allowed resource types for the references:
- Parameters:
service- Which rendered service is being charged?- Returns:
- A reference to this Builder instance
-
service
public ChargeItem.Builder service(Collection<Reference> service)
Indicated the rendered service that caused this charge.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()will fail.Allowed resource types for the references:
- Parameters:
service- Which rendered service is being charged?- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException- If the passed collection is null
-
product
public ChargeItem.Builder product(Element product)
Identifies the device, food, drug or other product being charged either by type code or reference to an instance.This is a choice element with the following allowed types:
When of typeReference, the allowed resource types for this reference are:- Parameters:
product- Product charged- Returns:
- A reference to this Builder instance
-
account
public ChargeItem.Builder account(Reference... account)
Account into which this ChargeItems belongs.Adds new element(s) to the existing list. If any of the elements are null, calling
build()will fail.Allowed resource types for the references:
- Parameters:
account- Account to place this charge- Returns:
- A reference to this Builder instance
-
account
public ChargeItem.Builder account(Collection<Reference> account)
Account into which this ChargeItems belongs.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()will fail.Allowed resource types for the references:
- Parameters:
account- Account to place this charge- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException- If the passed collection is null
-
note
public ChargeItem.Builder note(Annotation... note)
Comments made about the event by the performer, subject or other participants.Adds new element(s) to the existing list. If any of the elements are null, calling
build()will fail.- Parameters:
note- Comments made about the ChargeItem- Returns:
- A reference to this Builder instance
-
note
public ChargeItem.Builder note(Collection<Annotation> note)
Comments made about the event by the performer, subject or other participants.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()will fail.- Parameters:
note- Comments made about the ChargeItem- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException- If the passed collection is null
-
supportingInformation
public ChargeItem.Builder supportingInformation(Reference... supportingInformation)
Further information supporting this charge.Adds new element(s) to the existing list. If any of the elements are null, calling
build()will fail.- Parameters:
supportingInformation- Further information supporting this charge- Returns:
- A reference to this Builder instance
-
supportingInformation
public ChargeItem.Builder supportingInformation(Collection<Reference> supportingInformation)
Further information supporting this charge.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()will fail.- Parameters:
supportingInformation- Further information supporting this charge- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException- If the passed collection is null
-
build
public ChargeItem build()
- Specified by:
buildin interfaceBuilder<Resource>- Specified by:
buildin classDomainResource.Builder- Returns:
- An immutable object of type
ChargeItem - Throws:
IllegalStateException- if the current state cannot be built into a valid ChargeItem per the base specification
-
validate
protected void validate(ChargeItem chargeItem)
-
from
protected ChargeItem.Builder from(ChargeItem chargeItem)
-
-