Class PaymentNotice.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Resource>
-
- org.linuxforhealth.fhir.model.resource.Resource.Builder
-
- org.linuxforhealth.fhir.model.resource.DomainResource.Builder
-
- org.linuxforhealth.fhir.model.resource.PaymentNotice.Builder
-
- Enclosing class:
- PaymentNotice
public static class PaymentNotice.Builder extends DomainResource.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource.Builder
contained, extension, modifierExtension, text
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.Resource.Builder
id, implicitRules, language, meta
-
Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PaymentNotice.Builder
amount(Money amount)
The amount sent to the payee.PaymentNotice
build()
Build thePaymentNotice
PaymentNotice.Builder
contained(java.util.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.PaymentNotice.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.PaymentNotice.Builder
created(DateTime created)
The date when this resource was created.PaymentNotice.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource.PaymentNotice.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected PaymentNotice.Builder
from(PaymentNotice paymentNotice)
PaymentNotice.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.PaymentNotice.Builder
identifier(java.util.Collection<Identifier> identifier)
A unique identifier assigned to this payment notice.PaymentNotice.Builder
identifier(Identifier... identifier)
A unique identifier assigned to this payment notice.PaymentNotice.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.PaymentNotice.Builder
language(Code language)
The base language in which the resource is written.PaymentNotice.Builder
meta(Meta meta)
The metadata about the resource.PaymentNotice.Builder
modifierExtension(java.util.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.PaymentNotice.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.PaymentNotice.Builder
payee(Reference payee)
The party who will receive or has received payment that is the subject of this notification.PaymentNotice.Builder
payment(Reference payment)
A reference to the payment which is the subject of this notice.PaymentNotice.Builder
paymentDate(java.time.LocalDate paymentDate)
Convenience method for settingpaymentDate
.PaymentNotice.Builder
paymentDate(Date paymentDate)
The date when the above payment action occurred.PaymentNotice.Builder
paymentStatus(CodeableConcept paymentStatus)
A code indicating whether payment has been sent or cleared.PaymentNotice.Builder
provider(Reference provider)
The practitioner who is responsible for the services rendered to the patient.PaymentNotice.Builder
recipient(Reference recipient)
The party who is notified of the payment status.PaymentNotice.Builder
request(Reference request)
Reference of resource for which payment is being made.PaymentNotice.Builder
response(Reference response)
Reference of response to resource for which payment is being made.PaymentNotice.Builder
status(PaymentNoticeStatus status)
The status of the resource instance.PaymentNotice.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.protected void
validate(PaymentNotice paymentNotice)
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public PaymentNotice.Builder id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.- Overrides:
id
in classDomainResource.Builder
- Parameters:
id
- Logical id of this artifact- Returns:
- A reference to this Builder instance
-
meta
public PaymentNotice.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:
meta
in classDomainResource.Builder
- Parameters:
meta
- Metadata about the resource- Returns:
- A reference to this Builder instance
-
implicitRules
public PaymentNotice.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:
implicitRules
in classDomainResource.Builder
- Parameters:
implicitRules
- A set of rules under which this content was created- Returns:
- A reference to this Builder instance
-
language
public PaymentNotice.Builder language(Code language)
The base language in which the resource is written.- Overrides:
language
in classDomainResource.Builder
- Parameters:
language
- Language of the resource content- Returns:
- A reference to this Builder instance
-
text
public PaymentNotice.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:
text
in classDomainResource.Builder
- Parameters:
text
- Text summary of the resource, for human interpretation- Returns:
- A reference to this Builder instance
-
contained
public PaymentNotice.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:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
contained
public PaymentNotice.Builder contained(java.util.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:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
extension
public PaymentNotice.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:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public PaymentNotice.Builder extension(java.util.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:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
modifierExtension
public PaymentNotice.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:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
modifierExtension
public PaymentNotice.Builder modifierExtension(java.util.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:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
identifier
public PaymentNotice.Builder identifier(Identifier... identifier)
A unique identifier assigned to this payment notice.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- Business Identifier for the payment noctice- Returns:
- A reference to this Builder instance
-
identifier
public PaymentNotice.Builder identifier(java.util.Collection<Identifier> identifier)
A unique identifier assigned to this payment notice.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 the payment noctice- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
status
public PaymentNotice.Builder status(PaymentNoticeStatus status)
The status of the resource instance.This element is required.
- Parameters:
status
- active | cancelled | draft | entered-in-error- Returns:
- A reference to this Builder instance
-
request
public PaymentNotice.Builder request(Reference request)
Reference of resource for which payment is being made.- Parameters:
request
- Request reference- Returns:
- A reference to this Builder instance
-
response
public PaymentNotice.Builder response(Reference response)
Reference of response to resource for which payment is being made.- Parameters:
response
- Response reference- Returns:
- A reference to this Builder instance
-
created
public PaymentNotice.Builder created(DateTime created)
The date when this resource was created.This element is required.
- Parameters:
created
- Creation date- Returns:
- A reference to this Builder instance
-
provider
public PaymentNotice.Builder provider(Reference provider)
The practitioner who is responsible for the services rendered to the patient.Allowed resource types for this reference:
- Parameters:
provider
- Responsible practitioner- Returns:
- A reference to this Builder instance
-
payment
public PaymentNotice.Builder payment(Reference payment)
A reference to the payment which is the subject of this notice.This element is required.
Allowed resource types for this reference:
- Parameters:
payment
- Payment reference- Returns:
- A reference to this Builder instance
-
paymentDate
public PaymentNotice.Builder paymentDate(java.time.LocalDate paymentDate)
Convenience method for settingpaymentDate
.- Parameters:
paymentDate
- Payment or clearing date- Returns:
- A reference to this Builder instance
- See Also:
paymentDate(org.linuxforhealth.fhir.model.type.Date)
-
paymentDate
public PaymentNotice.Builder paymentDate(Date paymentDate)
The date when the above payment action occurred.- Parameters:
paymentDate
- Payment or clearing date- Returns:
- A reference to this Builder instance
-
payee
public PaymentNotice.Builder payee(Reference payee)
The party who will receive or has received payment that is the subject of this notification.Allowed resource types for this reference:
- Parameters:
payee
- Party being paid- Returns:
- A reference to this Builder instance
-
recipient
public PaymentNotice.Builder recipient(Reference recipient)
The party who is notified of the payment status.This element is required.
Allowed resource types for this reference:
- Parameters:
recipient
- Party being notified- Returns:
- A reference to this Builder instance
-
amount
public PaymentNotice.Builder amount(Money amount)
The amount sent to the payee.This element is required.
- Parameters:
amount
- Monetary amount of the payment- Returns:
- A reference to this Builder instance
-
paymentStatus
public PaymentNotice.Builder paymentStatus(CodeableConcept paymentStatus)
A code indicating whether payment has been sent or cleared.- Parameters:
paymentStatus
- Issued or cleared Status of the payment- Returns:
- A reference to this Builder instance
-
build
public PaymentNotice build()
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
PaymentNotice
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid PaymentNotice per the base specification
-
validate
protected void validate(PaymentNotice paymentNotice)
-
from
protected PaymentNotice.Builder from(PaymentNotice paymentNotice)
-
-