Skip to main content

HS.FHIRModel.R4.Invoice

class HS.FHIRModel.R4.Invoice extends HS.FHIRModel.FHIRClassSuper

*****************************************
** Invoice generated class schema
*****************************************
Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_INVOICE;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _cancelledReason as HS.FHIRModel.R4.Element;
Extensions for cancelledReason
Property methods: _cancelledReasonGet(), _cancelledReasonGetSwizzled(), _cancelledReasonIsValid(), _cancelledReasonNewObject(), _cancelledReasonSet()
property _date as HS.FHIRModel.R4.Element;
Extensions for date
Property methods: _dateGet(), _dateGetSwizzled(), _dateIsValid(), _dateNewObject(), _dateSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _paymentTerms as HS.FHIRModel.R4.Element;
Extensions for paymentTerms
Property methods: _paymentTermsGet(), _paymentTermsGetSwizzled(), _paymentTermsIsValid(), _paymentTermsNewObject(), _paymentTermsSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property account as HS.FHIRModel.R4.Reference;
Account which is supposed to be balanced with this Invoice.
Property methods: accountGet(), accountGetSwizzled(), accountIsValid(), accountNewObject(), accountSet()
property cancelledReason as %String;
In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).
Property methods: cancelledReasonDisplayToLogical(), cancelledReasonGet(), cancelledReasonIsValid(), cancelledReasonLogicalToDisplay(), cancelledReasonLogicalToOdbc(), cancelledReasonNormalize(), cancelledReasonSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
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.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property date as %String;
Date/time(s) of when this Invoice was posted.
Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
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.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
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.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property issuer as HS.FHIRModel.R4.Reference;
The organizationissuing the Invoice.
Property methods: issuerGet(), issuerGetSwizzled(), issuerIsValid(), issuerNewObject(), issuerSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
Each line item represents one charge for goods and services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource.
Property methods: lineItemGet(), lineItemGetSwizzled(), lineItemIsValid(), lineItemNewObject(), lineItemSet()
property meta as HS.FHIRModel.R4.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.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
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).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
Comments made about the invoice by the issuer, subject, or other participants.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
Indicates who or what performed or participated in the charged service.
Property methods: participantGet(), participantGetSwizzled(), participantIsValid(), participantNewObject(), participantSet()
property paymentTerms as %String;
Payment details such as banking details, period of payment, deductibles, methods of payment.
Property methods: paymentTermsDisplayToLogical(), paymentTermsGet(), paymentTermsIsValid(), paymentTermsLogicalToDisplay(), paymentTermsLogicalToOdbc(), paymentTermsNormalize(), paymentTermsSet()
property recipient as HS.FHIRModel.R4.Reference;
The individual or Organization responsible for balancing of this invoice.
Property methods: recipientGet(), recipientGetSwizzled(), recipientIsValid(), recipientNewObject(), recipientSet()
property resourceType as %String [ InitialExpression = "Invoice" , Required ];
This is a Invoice resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property status as %String (VALUELIST = ",draft,issued,balanced,cancelled,entered-in-error");
The current state of the Invoice.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIRModel.R4.Reference;
The individual or set of individuals receiving the goods and services billed in this invoice.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property text as HS.FHIRModel.R4.Narrative;
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.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property totalGross as HS.FHIRModel.R4.Money;
Invoice total, tax included.
Property methods: totalGrossGet(), totalGrossGetSwizzled(), totalGrossIsValid(), totalGrossNewObject(), totalGrossSet()
property totalNet as HS.FHIRModel.R4.Money;
Invoice total , taxes excluded.
Property methods: totalNetGet(), totalNetGetSwizzled(), totalNetIsValid(), totalNetNewObject(), totalNetSet()
property totalPriceComponent as HS.FHIRModel.R4.InvoiceX.SeqOfInvoiceXPriceComponent;
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.
Property methods: totalPriceComponentGet(), totalPriceComponentGetSwizzled(), totalPriceComponentIsValid(), totalPriceComponentNewObject(), totalPriceComponentSet()
Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Methods

method IncludeAccount()
method IncludeContained()
method IncludeExtension()
method IncludeIdentifier()
method IncludeIssuer()
method IncludeLineItem()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludeParticipant()
method IncludeRecipient()
method IncludeSubject()
method IncludeText()
method IncludeTotalGross()
method IncludeTotalNet()
method IncludeTotalPriceComponent()
method IncludeType()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab