Invoice class
Invoice Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
- Inheritance
-
- Object
- FhirBase
- Resource
- DomainResource
- Invoice
- Available extensions
Constructors
-
Invoice({FhirString? id, FhirMeta? meta, FhirUri? implicitRules, AllLanguages? language, Narrative? text, List<
Resource> ? contained, List<FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, List<Identifier> ? identifier, required InvoiceStatus status, FhirString? cancelledReason, CodeableConcept? type, Reference? subject, Reference? recipient, FhirDateTime? date, FhirDateTime? creation, PeriodXInvoice? periodX, FhirDate? periodDate, Period? periodPeriod, List<InvoiceParticipant> ? participant, Reference? issuer, Reference? account, List<InvoiceLineItem> ? lineItem, List<MonetaryComponent> ? totalPriceComponent, Money? totalNet, Money? totalGross, FhirMarkdown? paymentTerms, List<Annotation> ? note}) -
Primary constructor for
Invoice
const
-
Invoice.fromJson(Map<
String, dynamic> json) -
Factory constructor that accepts Map<String, dynamic> as an argument
factory
- Invoice.fromJsonString(String source)
-
Factory constructor for
Invoice
that takes in a String
Convenience method to avoid the json Encoding/Decoding normally required
to get data from a String
factory
- Invoice.fromYaml(dynamic yaml)
-
Deserialize Invoice
from a String or
YamlMap
objectfactory
Properties
- account → Reference?
-
account
Account which is supposed to be balanced with this Invoice.
final
- cancelledReason → FhirString?
-
cancelledReason
In case of Invoice cancellation a reason must be given (entered in
error, superseded by corrected invoice etc.).
final
-
contained
→ List<
Resource> ? -
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
finalinherited
-
copyWith
→ $InvoiceCopyWith<
Invoice> -
Copy function for Invoice
Returns a copy of the current instance with the provided fields modified.
If a field is not provided, it will retain its original value.
If a null is provided, this will clearn the field, unless the
field is required, in which case it will keep its current value.
no setteroverride
-
copyWith
→ $InvoiceCopyWith<
Invoice> -
Available on Invoice, provided by the InvoiceCopyWithExtension extension
no setter - creation → FhirDateTime?
-
creation
Date/time(s) of when this Invoice was posted.
final
- date → FhirDateTime?
-
date
Depricared by the element below.
final
-
extension_
→ List<
FhirExtension> ? -
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.",
finalinherited
- fhirType → String
-
Returns the FHIR type of the object.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasPrimitiveValue → bool
-
Checks if the object has a primitive value.
no setterinherited
- id → FhirString?
-
The logical id of the resource, as used in the URL for the resource.
finalinherited
-
identifier
→ List<
Identifier> ? -
identifier
Identifier of this Invoice, often used for reference in correspondence
about this invoice or for tracking of payments.
final
- implicitRules → FhirUri?
-
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.
finalinherited
- isMetadataBased → bool
-
All FhirBases and Resources are NOT metadata based
no setterinherited
- isPrimitive → bool
-
Checks if the object is primitive.
no setterinherited
- issuer → Reference?
-
issuer
The organizationissuing the Invoice.
final
- language → AllLanguages?
-
The base language in which the resource is written.
This should be the language of the text value in the content element
when a text value is present.
finalinherited
-
lineItem
→ List<
InvoiceLineItem> ? -
lineItem
Each line item represents one charge for goods and services rendered.
Details such.ofType(date), code and amount are found in the referenced
ChargeItem resource.
final
- meta → FhirMeta?
-
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.
finalinherited
-
modifierExtension
→ List<
FhirExtension> ? -
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\u0027s 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.\n\nModifier extensions SHALL
NOT change the meaning of any elements on Resource or DomainResource
(including cannot change the meaning of modifierExtension itself).",
finalinherited
-
note
→ List<
Annotation> ? -
note
Comments made about the invoice by the issuer, subject, or other
participants.
final
-
participant
→ List<
InvoiceParticipant> ? -
participant
Indicates who or what performed or participated in the charged service.
final
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
- paymentTerms → FhirMarkdown?
-
paymentTerms
Payment details such as banking details, period of payment,
deductibles, methods of payment.
final
- periodDate → FhirDate?
-
Getter for periodDate as a FhirDate
no setter
- periodPeriod → Period?
-
Getter for periodPeriod as a Period
no setter
- periodX → PeriodXInvoice?
-
periodX
Date/time(s) range of services included in this invoice.
final
- primitiveValue → String?
-
Retrieves the primitive value of the object.
no setterinherited
- recipient → Reference?
-
recipient
The individual or Organization responsible for balancing of this
invoice.
final
- resourceType → R5ResourceType
-
The type of resource
finalinherited
- resourceTypeString → String
-
produce a string of the resourceType
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- status → InvoiceStatus
-
status
The current state of the Invoice.
final
- subject → Reference?
-
subject
The individual or set of individuals receiving the goods and services
billed in this invoice.
final
- text → Narrative?
-
A human-readable summary of the resource conveying the essential clinical
and business information for the resource.",
finalinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
- totalGross → Money?
-
totalGross
Invoice total, tax included.
final
- totalNet → Money?
-
totalNet
Invoice total , taxes excluded.
final
-
totalPriceComponent
→ List<
MonetaryComponent> ? -
totalPriceComponent
The total amount for the Invoice may be calculated as the sum of the
line items with surcharges/deductions that apply in certain conditions.
The priceComponent element can be used to offer transparency to the
recipient of the Invoice of how the total price was calculated.
final
- type → CodeableConcept?
-
type
Type of Invoice depending on domain, realm an usage (e.g.
internal/external, dental, preliminary).
final
Methods
-
clone(
) → Invoice -
Subclasses must implement the clone method.
override
-
compareDeepStrings(
String? s1, String? s2, bool allowNull) → bool -
Checks if the object is equal to another object.
inherited
-
equalsDeep(
FhirBase? o) → bool -
Performs a deep comparison between two instances.
override
-
getChildByName(
String name) → FhirBase? -
Retrieves a single field value by its name.
override
-
getChildrenByName(
String fieldName, [bool checkValid = false]) → List< FhirBase> -
Retrieves all matching child fields by name.
Optionally validates the name.
override
-
hasType(
List< String> names) → bool -
Checks if the object has a given type.
inherited
-
hasValues(
) → bool -
Checks if the object has values.
inherited
-
isAs<
T extends FhirBase> () → T? -
Returns an Object cast as a Type if it is that type.
inherited
-
isEmpty(
) → bool -
Checks if the object is empty.
inherited
-
listChildrenNames(
) → List< String> -
Lists the JSON keys for the object.
override
-
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
-
prettyPrint(
) → String -
Converts the object to a pretty JSON string.
inherited
-
toJson(
) → Map< String, dynamic> -
Returns a Map<String, dynamic> of the DomainResource
override
-
toJsonString(
) → String -
Converts the object to a JSON string.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Converts the object to a YAML string.
inherited
-
updateVersion(
{FhirMeta? oldMeta, bool versionIdAsTime = false}) → 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