PaymentReconciliation class
PaymentReconciliation This resource provides the details including amount of a payment and allocates the payment items being paid.
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
PaymentReconciliation({@Default(R5ResourceType.PaymentReconciliation) @JsonKey(unknownEnumValue: R5ResourceType.PaymentReconciliation) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<
Resource> ? contained, @JsonKey(name: 'extension') List<FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, List<Identifier> ? identifier, required CodeableConcept type, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, CodeableConcept? kind, Period? period, FhirDateTime? created, @JsonKey(name: '_created') Element? createdElement, Reference? enterer, CodeableConcept? issuerType, Reference? paymentIssuer, Reference? request, Reference? requestor, FhirCode? outcome, @JsonKey(name: '_outcome') Element? outcomeElement, String? disposition, @JsonKey(name: '_disposition') Element? dispositionElement, FhirDate? date, @JsonKey(name: '_date') Element? dateElement, Reference? location, CodeableConcept? method, String? cardBrand, @JsonKey(name: '_cardBrand') Element? cardBrandElement, String? accountNumber, @JsonKey(name: '_accountNumber') Element? accountNumberElement, FhirDate? expirationDate, @JsonKey(name: '_expirationDate') Element? expirationDateElement, String? processor, @JsonKey(name: '_processor') Element? processorElement, String? referenceNumber, @JsonKey(name: '_referenceNumber') Element? referenceNumberElement, String? authorization, @JsonKey(name: '_authorization') Element? authorizationElement, Money? tenderedAmount, Money? returnedAmount, required Money amount, Identifier? paymentIdentifier, List<PaymentReconciliationAllocation> ? allocation, CodeableConcept? formCode, List<PaymentReconciliationProcessNote> ? processNote}) -
PaymentReconciliation This resource provides the details including
amount of a payment and allocates the payment items being paid.
constfactory
-
PaymentReconciliation.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- PaymentReconciliation.fromJsonString(String source)
-
Acts like a constructor, returns a PaymentReconciliation, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- PaymentReconciliation.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
- accountNumber → String?
-
accountNumber A portion of the account number, often the last 4
digits, used for verification not charging purposes.
no setterinherited
- accountNumberElement → Element?
-
accountNumberElement ("_accountNumber") Extensions for accountNumber
no setterinherited
-
allocation
→ List<
PaymentReconciliationAllocation> ? -
allocation Distribution of the payment amount for a previously
acknowledged payable.
no setterinherited
- amount → Money
-
amount Total payment amount as indicated on the financial instrument.
no setterinherited
-
authorization An alphanumeric issued by the processor to confirm the
successful issuance of payment.
no setterinherited
-
authorizationElement ("_authorization") Extensions for authorization
no setterinherited
- cardBrand → String?
-
cardBrand The card brand such as debit, Visa, Amex etc. used if a
card is the method of payment.
no setterinherited
- cardBrandElement → Element?
-
cardBrandElement ("_cardBrand") Extensions for cardBrand
no setterinherited
-
contained
→ List<
Resource> ? -
contained These resources do not have an independent existence apart
from the resource that contains them - they cannot be identified
independently, nor can they have their own independent transaction
scope. This is allowed to be a Parameters resource if and only if it
is referenced by a resource that provides context/meaning.
no setterinherited
-
copyWith
→ $PaymentReconciliationCopyWith<
PaymentReconciliation> -
no setterinherited
- created → FhirDateTime?
-
created The date when the resource was created.
no setterinherited
- createdElement → Element?
-
createdElement ("_created") Extensions for created
no setterinherited
- date → FhirDate?
-
date The date of payment as indicated on the financial instrument.
no setterinherited
- dateElement → Element?
-
dateElement ("_date") Extensions for date
no setterinherited
- dbId → int?
-
no setterinherited
- disposition → String?
-
disposition A human readable description of the status of the request
for the reconciliation.
no setterinherited
- dispositionElement → Element?
-
dispositionElement ("_disposition") Extensions for disposition
no setterinherited
- enterer → Reference?
-
enterer Payment enterer if not the actual payment issuer.
no setterinherited
- expirationDate → FhirDate?
-
expirationDate The year and month (YYYY-MM) when the instrument,
typically card, expires.
no setterinherited
- expirationDateElement → Element?
-
expirationDateElement ("_expirationDate") Extensions for
expirationDate
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
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 managable, 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.
no setterinherited
- fhirId → FhirId?
-
id The logical id of the resource, as used in the URL for the
resource. Once assigned, this value never changes.
no setterinherited
- formCode → CodeableConcept?
-
formCode A code for the form to be used for printing the content.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ List<
Identifier> ? -
identifier A unique identifier assigned to this payment
reconciliation.
no setterinherited
- implicitRules → FhirUri?
-
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.
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement ("_implicitRules") Extensions for implicitRules
no setterinherited
- issuerType → CodeableConcept?
-
issuerType The type of the source such as patient or insurance.
no setterinherited
- kind → CodeableConcept?
-
kind The workflow or activity which gave rise to or during which the
payment ocurred such as a kiosk, deposit on account, periodic payment
etc.
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement ("_language") Extensions for language
no setterinherited
- location → Reference?
-
location The location of the site or device for electronic transfers
or physical location for cash payments.
no setterinherited
- meta → FhirMeta?
-
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.
no setterinherited
- method → CodeableConcept?
-
method The means of payment such as check, card cash, or electronic
funds transfer.
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
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 managable, 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).
no setterinherited
- outcome → FhirCode?
-
outcome The outcome of a request for a reconciliation.
no setterinherited
- outcomeElement → Element?
-
outcomeElement ("_outcome") Extensions for outcome
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
- paymentIdentifier → Identifier?
-
paymentIdentifier Issuer's unique identifier for the payment
instrument.
no setterinherited
- paymentIssuer → Reference?
-
paymentIssuer The party who generated the payment.
no setterinherited
- period → Period?
-
period The period of time for which payments have been gathered into
this bulk payment for settlement.
no setterinherited
-
processNote
→ List<
PaymentReconciliationProcessNote> ? -
processNote A note that describes or explains the processing in a
human readable form.
no setterinherited
- processor → String?
-
processor The name of the card processor, etf processor, bank for
checks.
no setterinherited
- processorElement → Element?
-
processorElement ("_processor") Extensions for processor
no setterinherited
- referenceNumber → String?
-
referenceNumber The check number, eft reference, car processor
reference.
no setterinherited
- referenceNumberElement → Element?
-
referenceNumberElement ("_referenceNumber") Extensions for
referenceNumber
no setterinherited
- request → Reference?
-
request Original request resource reference.
no setterinherited
- requestor → Reference?
-
requestor The practitioner who is responsible for the services
rendered to the patient.
no setterinherited
- resourceType → R5ResourceType
-
resourceType This is a PaymentReconciliation resource
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
- returnedAmount → Money?
-
returnedAmount The amount returned by the receiver which is excess to
the amount payable, often referred to as 'change'.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- status → FhirCode?
-
status The status of the resource instance.
no setterinherited
- statusElement → Element?
-
statusElement ("_status") Extensions for status
no setterinherited
- tenderedAmount → Money?
-
tenderedAmount The amount offered by the issuer, typically applies to
cash when the issuer provides an amount in bank note denominations
equal to or excess of the amount actually being paid.
no setterinherited
- 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.
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
- type → CodeableConcept
-
type Code to indicate the nature of the payment such as payment,
adjustment.
no setterinherited
Methods
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
inherited
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
override
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited