Skip to main content


class HS.FHIR.DTL.vSTU3.Model.Resource.ChargeItem extends HS.FHIR.DTL.vSTU3.Model.Base.DomainResource

The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.

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 = ChargeItem;
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 = ChargeItem;
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 list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "account", XMLPROJECTION = "ELEMENT");

Account to place this charge.


Property methods: accountBuildValueArray(), accountCollectionToDisplay(), accountCollectionToOdbc(), accountDisplayToCollection(), accountGet(), accountGetObject(), accountGetObjectId(), accountGetSwizzled(), accountIsValid(), accountOdbcToCollection(), accountSet(), accountSetObject(), accountSetObjectId()
property bodysite as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "bodysite", XMLPROJECTION = "ELEMENT");

Anatomical location, if relevant.

any FHIR3 code may be used; body-site shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: bodysiteBuildValueArray(), bodysiteCollectionToDisplay(), bodysiteCollectionToOdbc(), bodysiteDisplayToCollection(), bodysiteGet(), bodysiteGetObject(), bodysiteGetObjectId(), bodysiteGetSwizzled(), bodysiteIsValid(), bodysiteOdbcToCollection(), bodysiteSet(), bodysiteSetObject(), bodysiteSetObjectId()
property code as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT") [ Required ];

A code that identifies the charge, like a billing code.

chargeitem-billingcodes is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend chargeitem-billingcodes and you may NOT use codes from other ValueSets.

Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property context as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");

Encounter / Episode associated with event.

Encounter | EpisodeOfCare

Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property definition as list of %String (MAXLEN = 1000000, XMLNAME = "definition", XMLPROJECTION = "ELEMENT");

Defining information about the code of this charge item.

Property methods: definitionBuildValueArray(), definitionCollectionToDisplay(), definitionCollectionToOdbc(), definitionDisplayToCollection(), definitionDisplayToLogical(), definitionGet(), definitionGetObject(), definitionGetObjectId(), definitionGetSwizzled(), definitionIsValid(), definitionLogicalToDisplay(), definitionLogicalToOdbc(), definitionNormalize(), definitionOdbcToCollection(), definitionSet(), definitionSetObject(), definitionSetObjectId()
property enteredDate as %String (MAXLEN = 1000000, XMLNAME = "enteredDate", XMLPROJECTION = "ATTRIBUTE");

Date the charge item was entered.

Property methods: enteredDateDisplayToLogical(), enteredDateGet(), enteredDateIsValid(), enteredDateLogicalToDisplay(), enteredDateLogicalToOdbc(), enteredDateNormalize(), enteredDateSet()
property enterer as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "enterer", XMLPROJECTION = "ELEMENT");

Individual who was entering.

Practitioner | Organization | Patient | Device | RelatedPerson

Property methods: entererGet(), entererGetSwizzled(), entererIsValid(), entererNewObject(), entererSet()
property factorOverride as %Decimal (XMLNAME = "factorOverride", XMLPROJECTION = "ATTRIBUTE");

Factor overriding the associated rules.

Property methods: factorOverrideDisplayToLogical(), factorOverrideGet(), factorOverrideIsValid(), factorOverrideLogicalToDisplay(), factorOverrideNormalize(), factorOverrideSet(), factorOverrideXSDToLogical()
property identifier as HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Business Identifier for item.

Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property note as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");

Comments made about the ChargeItem.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property occurrenceDateTime as %String (MAXLEN = 1000000, XMLNAME = "occurrenceDateTime", XMLPROJECTION = "ATTRIBUTE");

When the charged service was applied.

Property methods: occurrenceDateTimeDisplayToLogical(), occurrenceDateTimeGet(), occurrenceDateTimeIsValid(), occurrenceDateTimeLogicalToDisplay(), occurrenceDateTimeLogicalToOdbc(), occurrenceDateTimeNormalize(), occurrenceDateTimeSet()
property occurrencePeriod as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "occurrencePeriod", XMLPROJECTION = "ELEMENT");

When the charged service was applied.

Property methods: occurrencePeriodGet(), occurrencePeriodGetSwizzled(), occurrencePeriodIsValid(), occurrencePeriodNewObject(), occurrencePeriodSet()
property occurrenceTiming as HS.FHIR.DTL.vSTU3.Model.Datatype.Timing (XMLNAME = "occurrenceTiming", XMLPROJECTION = "ELEMENT");

When the charged service was applied.

Property methods: occurrenceTimingGet(), occurrenceTimingGetSwizzled(), occurrenceTimingIsValid(), occurrenceTimingNewObject(), occurrenceTimingSet()
property overrideReason as %String (MAXLEN = 1000000, XMLNAME = "overrideReason", XMLPROJECTION = "ATTRIBUTE");

Reason for overriding the list price/factor.

Property methods: overrideReasonDisplayToLogical(), overrideReasonGet(), overrideReasonIsValid(), overrideReasonLogicalToDisplay(), overrideReasonLogicalToOdbc(), overrideReasonNormalize(), overrideReasonSet()
property partOf as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");

Part of referenced ChargeItem.


Property methods: partOfBuildValueArray(), partOfCollectionToDisplay(), partOfCollectionToOdbc(), partOfDisplayToCollection(), partOfGet(), partOfGetObject(), partOfGetObjectId(), partOfGetSwizzled(), partOfIsValid(), partOfOdbcToCollection(), partOfSet(), partOfSetObject(), partOfSetObjectId()
property participant as list of HS.FHIR.DTL.vSTU3.Model.Element.ChargeItem.participant (XMLNAME = "participant", XMLPROJECTION = "ELEMENT");

Who performed charged service.

Property methods: participantBuildValueArray(), participantCollectionToDisplay(), participantCollectionToOdbc(), participantDisplayToCollection(), participantGet(), participantGetObject(), participantGetObjectId(), participantGetSwizzled(), participantIsValid(), participantOdbcToCollection(), participantSet(), participantSetObject(), participantSetObjectId()
property performingOrganization as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "performingOrganization", XMLPROJECTION = "ELEMENT");

Organization providing the charged sevice.


Property methods: performingOrganizationGet(), performingOrganizationGetSwizzled(), performingOrganizationIsValid(), performingOrganizationNewObject(), performingOrganizationSet()
property priceOverride as HS.FHIR.DTL.vSTU3.Model.Datatype.Money (XMLNAME = "priceOverride", XMLPROJECTION = "ELEMENT");

Price overriding the associated rules.

Property methods: priceOverrideGet(), priceOverrideGetSwizzled(), priceOverrideIsValid(), priceOverrideNewObject(), priceOverrideSet()
property quantity as HS.FHIR.DTL.vSTU3.Model.Datatype.Quantity (XMLNAME = "quantity", XMLPROJECTION = "ELEMENT");

Quantity of which the charge item has been serviced.

Property methods: quantityGet(), quantityGetSwizzled(), quantityIsValid(), quantityNewObject(), quantitySet()
property reason as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "reason", XMLPROJECTION = "ELEMENT");

Why was the charged service rendered?

any FHIR3 code may be used; icd-10 shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: reasonBuildValueArray(), reasonCollectionToDisplay(), reasonCollectionToOdbc(), reasonDisplayToCollection(), reasonGet(), reasonGetObject(), reasonGetObjectId(), reasonGetSwizzled(), reasonIsValid(), reasonOdbcToCollection(), reasonSet(), reasonSetObject(), reasonSetObjectId()
property requestingOrganization as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "requestingOrganization", XMLPROJECTION = "ELEMENT");

Organization requesting the charged service.


Property methods: requestingOrganizationGet(), requestingOrganizationGetSwizzled(), requestingOrganizationIsValid(), requestingOrganizationNewObject(), requestingOrganizationSet()
property service as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "service", XMLPROJECTION = "ELEMENT");

Which rendered service is being charged?

DiagnosticReport | ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | Observation | Procedure | SupplyDelivery

Property methods: serviceBuildValueArray(), serviceCollectionToDisplay(), serviceCollectionToOdbc(), serviceDisplayToCollection(), serviceGet(), serviceGetObject(), serviceGetObjectId(), serviceGetSwizzled(), serviceIsValid(), serviceOdbcToCollection(), serviceSet(), serviceSetObject(), serviceSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

planned | billable | not-billable | aborted | billed | entered-in-error | unknown

any FHIR3 code may be used; chargeitem-status shows EXAMPLE codes, but you may use codes from any ValueSet.

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

Individual service was done for/to.

Patient | Group

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property supportingInformation as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "supportingInformation", XMLPROJECTION = "ELEMENT");

Further information supporting the this charge.

Any FHIR3 Resource may be indicated by this Reference

Property methods: supportingInformationBuildValueArray(), supportingInformationCollectionToDisplay(), supportingInformationCollectionToOdbc(), supportingInformationDisplayToCollection(), supportingInformationGet(), supportingInformationGetObject(), supportingInformationGetObjectId(), supportingInformationGetSwizzled(), supportingInformationIsValid(), supportingInformationOdbcToCollection(), supportingInformationSet(), supportingInformationSetObject(), supportingInformationSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab