Skip to main content


class HS.FHIR.DTL.vR4.Model.Resource.Invoice extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

Invoice containing ChargeItems from an Account.

Property Inventory


Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = Invoice;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = 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.


property account as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "account", XMLPROJECTION = "ELEMENT");

Account that is being balanced.


Property methods: accountGet(), accountGetSwizzled(), accountIsValid(), accountNewObject(), accountSet()
property cancelledReason as %String (MAXLEN = 1000000, XMLNAME = "cancelledReason", XMLPROJECTION = "ATTRIBUTE");

Reason for cancellation of this Invoice.

Property methods: cancelledReasonDisplayToLogical(), cancelledReasonGet(), cancelledReasonIsValid(), cancelledReasonLogicalToDisplay(), cancelledReasonLogicalToOdbc(), cancelledReasonNormalize(), cancelledReasonSet()
property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE");

Invoice date / posting date.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Business Identifier for item.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property issuer as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "issuer", XMLPROJECTION = "ELEMENT");

Issuing Organization of Invoice.


Property methods: issuerGet(), issuerGetSwizzled(), issuerIsValid(), issuerNewObject(), issuerSet()
property lineItem as list of HS.FHIR.DTL.vR4.Model.Element.Invoice.lineItem (XMLNAME = "lineItem", XMLPROJECTION = "ELEMENT");

Line items of this Invoice.

Property methods: lineItemBuildValueArray(), lineItemCollectionToDisplay(), lineItemCollectionToOdbc(), lineItemDisplayToCollection(), lineItemGet(), lineItemGetObject(), lineItemGetObjectId(), lineItemGetSwizzled(), lineItemIsValid(), lineItemOdbcToCollection(), lineItemSet(), lineItemSetObject(), lineItemSetObjectId()
property note as list of HS.FHIR.DTL.vR4.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");

Comments made about the invoice.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property participant as list of HS.FHIR.DTL.vR4.Model.Element.Invoice.participant (XMLNAME = "participant", XMLPROJECTION = "ELEMENT");

Participant in creation of this Invoice.

Property methods: participantBuildValueArray(), participantCollectionToDisplay(), participantCollectionToOdbc(), participantDisplayToCollection(), participantGet(), participantGetObject(), participantGetObjectId(), participantGetSwizzled(), participantIsValid(), participantOdbcToCollection(), participantSet(), participantSetObject(), participantSetObjectId()
property paymentTerms as %String (MAXLEN = 1000000, XMLNAME = "paymentTerms", XMLPROJECTION = "ATTRIBUTE");

Payment details.

Property methods: paymentTermsDisplayToLogical(), paymentTermsGet(), paymentTermsIsValid(), paymentTermsLogicalToDisplay(), paymentTermsLogicalToOdbc(), paymentTermsNormalize(), paymentTermsSet()
property recipient as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "recipient", XMLPROJECTION = "ELEMENT");

Recipient of this invoice.

Organization | Patient | RelatedPerson

Property methods: recipientGet(), recipientGetSwizzled(), recipientIsValid(), recipientNewObject(), recipientSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

draft | issued | balanced | cancelled | entered-in-error

invoice-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend invoice-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");

Recipient(s) of goods and services.

Patient | Group

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property totalGross as HS.FHIR.DTL.vR4.Model.Datatype.Money (XMLNAME = "totalGross", XMLPROJECTION = "ELEMENT");

Gross total of this Invoice.

Property methods: totalGrossGet(), totalGrossGetSwizzled(), totalGrossIsValid(), totalGrossNewObject(), totalGrossSet()
property totalNet as HS.FHIR.DTL.vR4.Model.Datatype.Money (XMLNAME = "totalNet", XMLPROJECTION = "ELEMENT");

Net total of this Invoice.

Property methods: totalNetGet(), totalNetGetSwizzled(), totalNetIsValid(), totalNetNewObject(), totalNetSet()
property totalPriceComponent as list of HS.FHIR.DTL.vR4.Model.Element.Invoice.lineItem.priceComponent (XMLNAME = "totalPriceComponent", XMLPROJECTION = "ELEMENT");

Components of Invoice total.

Property methods: totalPriceComponentBuildValueArray(), totalPriceComponentCollectionToDisplay(), totalPriceComponentCollectionToOdbc(), totalPriceComponentDisplayToCollection(), totalPriceComponentGet(), totalPriceComponentGetObject(), totalPriceComponentGetObjectId(), totalPriceComponentGetSwizzled(), totalPriceComponentIsValid(), totalPriceComponentOdbcToCollection(), totalPriceComponentSet(), totalPriceComponentSetObject(), totalPriceComponentSetObjectId()
property type as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");

Type of Invoice.

any FHIR4 code from any ValueSet may be used.

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab