Skip to main content

HS.FHIR.vSTU3.Model.Resource.ChargeItem

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
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.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
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.

Properties

property account as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "account", XMLPROJECTION = "ELEMENT");
Account into which this ChargeItems belongs.
Property methods: accountBuildValueArray(), accountCollectionToDisplay(), accountCollectionToOdbc(), accountDisplayToCollection(), accountGet(), accountGetObject(), accountGetObjectId(), accountGetSwizzled(), accountIsValid(), accountOdbcToCollection(), accountSet(), accountSetObject(), accountSetObjectId()
property bodysite as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "bodysite", XMLPROJECTION = "ELEMENT");
The anatomical location where the related service has been applied.
Property methods: bodysiteBuildValueArray(), bodysiteCollectionToDisplay(), bodysiteCollectionToOdbc(), bodysiteDisplayToCollection(), bodysiteGet(), bodysiteGetObject(), bodysiteGetObjectId(), bodysiteGetSwizzled(), bodysiteIsValid(), bodysiteOdbcToCollection(), bodysiteSet(), bodysiteSetObject(), bodysiteSetObjectId()
property code as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT") [ Required ];
A code that identifies the charge, like a billing code.
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property context as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
The encounter or episode of care that establishes the context for this event.
Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property definition as list of HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "definition", XMLPROJECTION = "ELEMENT");
References the source of pricing information, rules of application for the code this ChargeItem uses.
Property methods: definitionBuildValueArray(), definitionCollectionToDisplay(), definitionCollectionToOdbc(), definitionDisplayToCollection(), definitionGet(), definitionGetObject(), definitionGetObjectId(), definitionGetSwizzled(), definitionIsValid(), definitionOdbcToCollection(), definitionSet(), definitionSetObject(), definitionSetObjectId()
property enteredDate as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "enteredDate", XMLPROJECTION = "ELEMENT");
Date the charge item was entered.
Property methods: enteredDateGet(), enteredDateGetSwizzled(), enteredDateIsValid(), enteredDateNewObject(), enteredDateSet()
property enterer as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "enterer", XMLPROJECTION = "ELEMENT");
The device, practitioner, etc. who entered the charge item.
Property methods: entererGet(), entererGetSwizzled(), entererIsValid(), entererNewObject(), entererSet()
property factorOverride as HS.FHIR.vSTU3.Model.Datatype.Decimal (XMLNAME = "factorOverride", XMLPROJECTION = "ELEMENT");
Factor overriding the factor determined by the rules associated with the code.
Property methods: factorOverrideGet(), factorOverrideGetSwizzled(), factorOverrideIsValid(), factorOverrideNewObject(), factorOverrideSet()
property identifier as HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifiers assigned to this event performer or other systems.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property note as list of HS.FHIR.vSTU3.Model.Base.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Comments made about the event by the performer, subject or other participants.
Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property occurrenceDateTime as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "occurrenceDateTime", XMLPROJECTION = "ELEMENT");
Property methods: occurrenceDateTimeGet(), occurrenceDateTimeGetSwizzled(), occurrenceDateTimeIsValid(), occurrenceDateTimeNewObject(), occurrenceDateTimeSet()
property occurrencePeriod as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "occurrencePeriod", XMLPROJECTION = "ELEMENT");
Property methods: occurrencePeriodGet(), occurrencePeriodGetSwizzled(), occurrencePeriodIsValid(), occurrencePeriodNewObject(), occurrencePeriodSet()
property occurrenceTiming as HS.FHIR.vSTU3.Model.Base.Timing (XMLNAME = "occurrenceTiming", XMLPROJECTION = "ELEMENT");
Property methods: occurrenceTimingGet(), occurrenceTimingGetSwizzled(), occurrenceTimingIsValid(), occurrenceTimingNewObject(), occurrenceTimingSet()
property overrideReason as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "overrideReason", XMLPROJECTION = "ELEMENT");
If the list price or the rule based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.
Property methods: overrideReasonGet(), overrideReasonGetSwizzled(), overrideReasonIsValid(), overrideReasonNewObject(), overrideReasonSet()
property partOf as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");
ChargeItems can be grouped to larger ChargeItems covering the whole set.
Property methods: partOfBuildValueArray(), partOfCollectionToDisplay(), partOfCollectionToOdbc(), partOfDisplayToCollection(), partOfGet(), partOfGetObject(), partOfGetObjectId(), partOfGetSwizzled(), partOfIsValid(), partOfOdbcToCollection(), partOfSet(), partOfSetObject(), partOfSetObjectId()
property participant as list of HS.FHIR.vSTU3.Model.Resource.ChargeItem.Participant (XMLNAME = "participant", XMLPROJECTION = "ELEMENT");
Indicates who or what performed or participated in the charged service.
Property methods: participantBuildValueArray(), participantCollectionToDisplay(), participantCollectionToOdbc(), participantDisplayToCollection(), participantGet(), participantGetObject(), participantGetObjectId(), participantGetSwizzled(), participantIsValid(), participantOdbcToCollection(), participantSet(), participantSetObject(), participantSetObjectId()
property performingOrganization as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "performingOrganization", XMLPROJECTION = "ELEMENT");
The organization requesting the service.
Property methods: performingOrganizationGet(), performingOrganizationGetSwizzled(), performingOrganizationIsValid(), performingOrganizationNewObject(), performingOrganizationSet()
property priceOverride as HS.FHIR.vSTU3.Model.Base.Money (XMLNAME = "priceOverride", XMLPROJECTION = "ELEMENT");
Total price of the charge overriding the list price associated with the code.
Property methods: priceOverrideGet(), priceOverrideGetSwizzled(), priceOverrideIsValid(), priceOverrideNewObject(), priceOverrideSet()
property quantity as HS.FHIR.vSTU3.Model.Base.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.vSTU3.Model.Base.CodeableConcept (XMLNAME = "reason", XMLPROJECTION = "ELEMENT");
Describes why the event occurred in coded or textual form.
Property methods: reasonBuildValueArray(), reasonCollectionToDisplay(), reasonCollectionToOdbc(), reasonDisplayToCollection(), reasonGet(), reasonGetObject(), reasonGetObjectId(), reasonGetSwizzled(), reasonIsValid(), reasonOdbcToCollection(), reasonSet(), reasonSetObject(), reasonSetObjectId()
property requestingOrganization as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "requestingOrganization", XMLPROJECTION = "ELEMENT");
The organization performing the service.
Property methods: requestingOrganizationGet(), requestingOrganizationGetSwizzled(), requestingOrganizationIsValid(), requestingOrganizationNewObject(), requestingOrganizationSet()
property service as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "service", XMLPROJECTION = "ELEMENT");
Indicated the rendered service that caused this charge.
Property methods: serviceBuildValueArray(), serviceCollectionToDisplay(), serviceCollectionToOdbc(), serviceDisplayToCollection(), serviceGet(), serviceGetObject(), serviceGetObjectId(), serviceGetSwizzled(), serviceIsValid(), serviceOdbcToCollection(), serviceSet(), serviceSetObject(), serviceSetObjectId()
property status as HS.FHIR.vSTU3.Model.Base.ChargeItemStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
The current state of the ChargeItem.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property subject as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT") [ Required ];
The individual or set of individuals the action is being or was performed on.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property supportingInformation as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "supportingInformation", XMLPROJECTION = "ELEMENT");
Further information supporting the this charge.
Property methods: supportingInformationBuildValueArray(), supportingInformationCollectionToDisplay(), supportingInformationCollectionToOdbc(), supportingInformationDisplayToCollection(), supportingInformationGet(), supportingInformationGetObject(), supportingInformationGetObjectId(), supportingInformationGetSwizzled(), supportingInformationIsValid(), supportingInformationOdbcToCollection(), supportingInformationSet(), supportingInformationSetObject(), supportingInformationSetObjectId()

Methods

deprecated method SetAccount(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "account" property.
deprecated method SetBodysite(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "bodysite" property.
deprecated method SetCode(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "code" property.
deprecated method SetContext(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "context" property.
deprecated method SetDefinition(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "definition" property.
deprecated method SetEnteredDate(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "enteredDate" property.
deprecated method SetEnterer(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "enterer" property.
deprecated method SetFactorOverride(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "factorOverride" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "identifier" property.
deprecated method SetOccurrenceDateTime(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "occurrenceDateTime" property.
deprecated method SetOccurrencePeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "occurrencePeriod" property.
deprecated method SetOverrideReason(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "overrideReason" property.
deprecated method SetPartOf(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "partOf" property.
deprecated method SetPerformingOrganization(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "performingOrganization" property.
deprecated method SetQuantity(pValue As %String = "", pComparator As %String = "", pUnit As %String = "", pSystem As %String = "", pCode As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "quantity" property.
deprecated method SetReason(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "reason" property.
deprecated method SetRequestingOrganization(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "requestingOrganization" property.
deprecated method SetService(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "service" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
deprecated method SetSubject(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "subject" property.
deprecated method SetSupportingInformation(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "supportingInformation" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab