Skip to main content

HS.FHIRModel.R4.ChargeItem

class HS.FHIRModel.R4.ChargeItem extends HS.FHIRModel.FHIRClassSuper

*****************************************
** ChargeItem generated class schema
*****************************************
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

Method Inventory

Parameters

parameter XMLTYPE = R4_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.

Properties

property _definitionUri as HS.FHIRModel.R4.SeqOfElement;
Extensions for definitionUri
Property methods: _definitionUriGet(), _definitionUriGetSwizzled(), _definitionUriIsValid(), _definitionUriNewObject(), _definitionUriSet()
property _enteredDate as HS.FHIRModel.R4.Element;
Extensions for enteredDate
Property methods: _enteredDateGet(), _enteredDateGetSwizzled(), _enteredDateIsValid(), _enteredDateNewObject(), _enteredDateSet()
property _factorOverride as HS.FHIRModel.R4.Element;
Extensions for factorOverride
Property methods: _factorOverrideGet(), _factorOverrideGetSwizzled(), _factorOverrideIsValid(), _factorOverrideNewObject(), _factorOverrideSet()
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 _occurrenceDateTime as HS.FHIRModel.R4.Element;
Extensions for occurrenceDateTime
Property methods: _occurrenceDateTimeGet(), _occurrenceDateTimeGetSwizzled(), _occurrenceDateTimeIsValid(), _occurrenceDateTimeNewObject(), _occurrenceDateTimeSet()
property _overrideReason as HS.FHIRModel.R4.Element;
Extensions for overrideReason
Property methods: _overrideReasonGet(), _overrideReasonGetSwizzled(), _overrideReasonIsValid(), _overrideReasonNewObject(), _overrideReasonSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property account as HS.FHIRModel.R4.SeqOfReference;
Account into which this ChargeItems belongs.
Property methods: accountGet(), accountGetSwizzled(), accountIsValid(), accountNewObject(), accountSet()
property bodysite as HS.FHIRModel.R4.SeqOfCodeableConcept;
The anatomical location where the related service has been applied.
Property methods: bodysiteGet(), bodysiteGetSwizzled(), bodysiteIsValid(), bodysiteNewObject(), bodysiteSet()
property code as HS.FHIRModel.R4.CodeableConcept [ Required ];
A code that identifies the charge, like a billing code.
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
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 context as HS.FHIRModel.R4.Reference;
The encounter or episode of care that establishes the context for this event.
Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property costCenter as HS.FHIRModel.R4.Reference;
The financial cost center permits the tracking of charge attribution.
Property methods: costCenterGet(), costCenterGetSwizzled(), costCenterIsValid(), costCenterNewObject(), costCenterSet()
property definitionCanonical as HS.FHIRModel.R4.SeqOfString;
References the source of pricing information, rules of application for the code this ChargeItem uses.
Property methods: definitionCanonicalGet(), definitionCanonicalGetSwizzled(), definitionCanonicalIsValid(), definitionCanonicalNewObject(), definitionCanonicalSet()
property definitionUri as HS.FHIRModel.R4.SeqOfString;
References the (external) source of pricing information, rules of application for the code this ChargeItem uses.
Property methods: definitionUriGet(), definitionUriGetSwizzled(), definitionUriIsValid(), definitionUriNewObject(), definitionUriSet()
property enteredDate as %String;
Date the charge item was entered.
Property methods: enteredDateDisplayToLogical(), enteredDateGet(), enteredDateIsValid(), enteredDateLogicalToDisplay(), enteredDateLogicalToOdbc(), enteredDateNormalize(), enteredDateSet()
property enterer as HS.FHIRModel.R4.Reference;
The device, practitioner, etc. who entered the charge item.
Property methods: entererGet(), entererGetSwizzled(), entererIsValid(), entererNewObject(), entererSet()
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 factorOverride as %Integer;
Factor overriding the factor determined by the rules associated with the code.
Property methods: factorOverrideDisplayToLogical(), factorOverrideGet(), factorOverrideIsValid(), factorOverrideLogicalToDisplay(), factorOverrideNormalize(), factorOverrideSet(), factorOverrideXSDToLogical()
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;
Identifiers assigned to this event performer or other systems.
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 language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
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 event by the performer, subject or other participants.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property occurrenceDateTime as %String;
Date/time(s) or duration when the charged service was applied.
Property methods: occurrenceDateTimeDisplayToLogical(), occurrenceDateTimeGet(), occurrenceDateTimeIsValid(), occurrenceDateTimeLogicalToDisplay(), occurrenceDateTimeLogicalToOdbc(), occurrenceDateTimeNormalize(), occurrenceDateTimeSet()
property occurrencePeriod as HS.FHIRModel.R4.Period;
Date/time(s) or duration when the charged service was applied.
Property methods: occurrencePeriodGet(), occurrencePeriodGetSwizzled(), occurrencePeriodIsValid(), occurrencePeriodNewObject(), occurrencePeriodSet()
property occurrenceTiming as HS.FHIRModel.R4.Timing;
Date/time(s) or duration when the charged service was applied.
Property methods: occurrenceTimingGet(), occurrenceTimingGetSwizzled(), occurrenceTimingIsValid(), occurrenceTimingNewObject(), occurrenceTimingSet()
property overrideReason as %String;
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: overrideReasonDisplayToLogical(), overrideReasonGet(), overrideReasonIsValid(), overrideReasonLogicalToDisplay(), overrideReasonLogicalToOdbc(), overrideReasonNormalize(), overrideReasonSet()
property partOf as HS.FHIRModel.R4.SeqOfReference;
ChargeItems can be grouped to larger ChargeItems covering the whole set.
Property methods: partOfGet(), partOfGetSwizzled(), partOfIsValid(), partOfNewObject(), partOfSet()
Indicates who or what performed or participated in the charged service.
Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet()
property performingOrganization as HS.FHIRModel.R4.Reference;
The organization requesting the service.
Property methods: performingOrganizationGet(), performingOrganizationGetSwizzled(), performingOrganizationIsValid(), performingOrganizationNewObject(), performingOrganizationSet()
property priceOverride as HS.FHIRModel.R4.Money;
Total price of the charge overriding the list price associated with the code.
Property methods: priceOverrideGet(), priceOverrideGetSwizzled(), priceOverrideIsValid(), priceOverrideNewObject(), priceOverrideSet()
property productCodeableConcept as HS.FHIRModel.R4.CodeableConcept;
Identifies the device, food, drug or other product being charged either by type code or reference to an instance.
Property methods: productCodeableConceptGet(), productCodeableConceptGetSwizzled(), productCodeableConceptIsValid(), productCodeableConceptNewObject(), productCodeableConceptSet()
property productReference as HS.FHIRModel.R4.Reference;
Identifies the device, food, drug or other product being charged either by type code or reference to an instance.
Property methods: productReferenceGet(), productReferenceGetSwizzled(), productReferenceIsValid(), productReferenceNewObject(), productReferenceSet()
property quantity as HS.FHIRModel.R4.Quantity;
Quantity of which the charge item has been serviced.
Property methods: quantityGet(), quantityGetSwizzled(), quantityIsValid(), quantityNewObject(), quantitySet()
Describes why the event occurred in coded or textual form.
Property methods: reasonGet(), reasonGetSwizzled(), reasonIsValid(), reasonNewObject(), reasonSet()
property requestingOrganization as HS.FHIRModel.R4.Reference;
The organization performing the service.
Property methods: requestingOrganizationGet(), requestingOrganizationGetSwizzled(), requestingOrganizationIsValid(), requestingOrganizationNewObject(), requestingOrganizationSet()
property resourceType as %String [ InitialExpression = "ChargeItem" , Required ];
This is a ChargeItem resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property service as HS.FHIRModel.R4.SeqOfReference;
Indicated the rendered service that caused this charge.
Property methods: serviceGet(), serviceGetSwizzled(), serviceIsValid(), serviceNewObject(), serviceSet()
property status as %String (VALUELIST = ",planned,billable,not-billable,aborted,billed,entered-in-error,unknown");
The current state of the ChargeItem.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIRModel.R4.Reference [ 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 HS.FHIRModel.R4.SeqOfReference;
Further information supporting this charge.
Property methods: supportingInformationGet(), supportingInformationGetSwizzled(), supportingInformationIsValid(), supportingInformationNewObject(), supportingInformationSet()
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()

Methods

method IncludeAccount()
method IncludeBodysite()
method IncludeCode()
method IncludeContained()
method IncludeContext()
method IncludeCostCenter()
method IncludeDefinitionCanonical()
method IncludeDefinitionUri()
method IncludeEnterer()
method IncludeExtension()
method IncludeIdentifier()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludeOccurrencePeriod()
method IncludeOccurrenceTiming()
method IncludePartOf()
method IncludePerformer()
method IncludePerformingOrganization()
method IncludePriceOverride()
method IncludeProductCodeableConcept()
method IncludeProductReference()
method IncludeQuantity()
method IncludeReason()
method IncludeRequestingOrganization()
method IncludeService()
method IncludeSubject()
method IncludeSupportingInformation()
method IncludeText()
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