Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.ChargeItem

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

Item containing charge code(s) associated with the provision of healthcare provider products.

Property 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 XMLPROJECTION = ELEMENT;
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.

Properties

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

Account to place this charge.

Account

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

Anatomical location, if relevant.

any FHIR4 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.vR4.Model.Datatype.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

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

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

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

Encounter / Episode associated with event.

Encounter | EpisodeOfCare

Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property costCenter as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "costCenter", XMLPROJECTION = "ELEMENT");
Reference

Organization that has ownership of the (potential, future) revenue.

Organization

Property methods: costCenterGet(), costCenterGetSwizzled(), costCenterIsValid(), costCenterNewObject(), costCenterSet()
property definitionCanonical as list of %String (MAXLEN = 1000000, XMLNAME = "definitionCanonical", XMLPROJECTION = "ELEMENT");
canonical

Resource defining the code of this ChargeItem.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: definitionCanonicalBuildValueArray(), definitionCanonicalCollectionToDisplay(), definitionCanonicalCollectionToOdbc(), definitionCanonicalDisplayToCollection(), definitionCanonicalDisplayToLogical(), definitionCanonicalGet(), definitionCanonicalGetObject(), definitionCanonicalGetObjectId(), definitionCanonicalGetSwizzled(), definitionCanonicalIsValid(), definitionCanonicalLogicalToDisplay(), definitionCanonicalLogicalToOdbc(), definitionCanonicalNormalize(), definitionCanonicalOdbcToCollection(), definitionCanonicalSet(), definitionCanonicalSetObject(), definitionCanonicalSetObjectId()
property definitionUri as list of %String (MAXLEN = 1000000, XMLNAME = "definitionUri", XMLPROJECTION = "ELEMENT");
uri

Defining information about the code of this charge item.

Property methods: definitionUriBuildValueArray(), definitionUriCollectionToDisplay(), definitionUriCollectionToOdbc(), definitionUriDisplayToCollection(), definitionUriDisplayToLogical(), definitionUriGet(), definitionUriGetObject(), definitionUriGetObjectId(), definitionUriGetSwizzled(), definitionUriIsValid(), definitionUriLogicalToDisplay(), definitionUriLogicalToOdbc(), definitionUriNormalize(), definitionUriOdbcToCollection(), definitionUriSet(), definitionUriSetObject(), definitionUriSetObjectId()
property enteredDate as %String (MAXLEN = 1000000, XMLNAME = "enteredDate", XMLPROJECTION = "ATTRIBUTE");
dateTime

Date the charge item was entered.

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

Individual who was entering.

Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson

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

Factor overriding the associated rules.

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

Business Identifier for item.

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

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");
dateTime

When the charged service was applied.

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

When the charged service was applied.

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

When the charged service was applied.

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

Reason for overriding the list price/factor.

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

Part of referenced ChargeItem.

ChargeItem

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

Who performed charged service.

Property methods: performerBuildValueArray(), performerCollectionToDisplay(), performerCollectionToOdbc(), performerDisplayToCollection(), performerGet(), performerGetObject(), performerGetObjectId(), performerGetSwizzled(), performerIsValid(), performerOdbcToCollection(), performerSet(), performerSetObject(), performerSetObjectId()
property performingOrganization as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "performingOrganization", XMLPROJECTION = "ELEMENT");
Reference

Organization providing the charged service.

Organization

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

Price overriding the associated rules.

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

Product charged.

any FHIR4 code may be used; device-kind shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: productCodeableConceptGet(), productCodeableConceptGetSwizzled(), productCodeableConceptIsValid(), productCodeableConceptNewObject(), productCodeableConceptSet()
property productReference as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "productReference", XMLPROJECTION = "ELEMENT");
Reference

Product charged.

Device | Medication | Substance

Property methods: productReferenceGet(), productReferenceGetSwizzled(), productReferenceIsValid(), productReferenceNewObject(), productReferenceSet()
property quantity as HS.FHIR.DTL.vR4.Model.Datatype.Quantity (XMLNAME = "quantity", XMLPROJECTION = "ELEMENT");
Quantity

Quantity of which the charge item has been serviced.

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

Why was the charged service rendered?

any FHIR4 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.vR4.Model.Base.Reference (XMLNAME = "requestingOrganization", XMLPROJECTION = "ELEMENT");
Reference

Organization requesting the charged service.

Organization

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

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 ];
code

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

chargeitem-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend chargeitem-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") [ Required ];
Reference

Individual service was done for/to.

Patient | Group

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

Further information supporting this charge.

Any FHIR4 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