Skip to main content


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

Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined.

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 = ChargeItemDefinition;
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 = ChargeItemDefinition;
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 applicability as list of HS.FHIR.DTL.vR4.Model.Element.ChargeItemDefinition.applicability (XMLNAME = "applicability", XMLPROJECTION = "ELEMENT");

Whether or not the billing code is applicable.

Property methods: applicabilityBuildValueArray(), applicabilityCollectionToDisplay(), applicabilityCollectionToOdbc(), applicabilityDisplayToCollection(), applicabilityGet(), applicabilityGetObject(), applicabilityGetObjectId(), applicabilityGetSwizzled(), applicabilityIsValid(), applicabilityOdbcToCollection(), applicabilitySet(), applicabilitySetObject(), applicabilitySetObjectId()
property approvalDate as %String (MAXLEN = 1000000, XMLNAME = "approvalDate", XMLPROJECTION = "ATTRIBUTE");

When the charge item definition was approved by publisher.

Property methods: approvalDateDisplayToLogical(), approvalDateGet(), approvalDateIsValid(), approvalDateLogicalToDisplay(), approvalDateLogicalToOdbc(), approvalDateNormalize(), approvalDateSet()
property code as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");

Billing codes or product types this definition applies to.

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 contact as list of HS.FHIR.DTL.vR4.Model.Datatype.ContactDetail (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");

Contact details for the publisher.

Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()

Use and/or publishing restrictions.

Property methods: copyrightDisplayToLogical(), copyrightGet(), copyrightIsValid(), copyrightLogicalToDisplay(), copyrightLogicalToOdbc(), copyrightNormalize(), copyrightSet()
property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE");

Date last changed.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property derivedFromUri as list of %String (MAXLEN = 1000000, XMLNAME = "derivedFromUri", XMLPROJECTION = "ELEMENT");

Underlying externally-defined charge item definition.

Property methods: derivedFromUriBuildValueArray(), derivedFromUriCollectionToDisplay(), derivedFromUriCollectionToOdbc(), derivedFromUriDisplayToCollection(), derivedFromUriDisplayToLogical(), derivedFromUriGet(), derivedFromUriGetObject(), derivedFromUriGetObjectId(), derivedFromUriGetSwizzled(), derivedFromUriIsValid(), derivedFromUriLogicalToDisplay(), derivedFromUriLogicalToOdbc(), derivedFromUriNormalize(), derivedFromUriOdbcToCollection(), derivedFromUriSet(), derivedFromUriSetObject(), derivedFromUriSetObjectId()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");

Natural language description of the charge item definition.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property effectivePeriod as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "effectivePeriod", XMLPROJECTION = "ELEMENT");

When the charge item definition is expected to be used.

Property methods: effectivePeriodGet(), effectivePeriodGetSwizzled(), effectivePeriodIsValid(), effectivePeriodNewObject(), effectivePeriodSet()
property experimental as %Boolean (XMLNAME = "experimental", XMLPROJECTION = "ATTRIBUTE");

For testing purposes, not real usage.

Property methods: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Additional identifier for the charge item definition.

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

Instances this definition applies to.

Medication | Substance | Device

Property methods: instanceBuildValueArray(), instanceCollectionToDisplay(), instanceCollectionToOdbc(), instanceDisplayToCollection(), instanceGet(), instanceGetObject(), instanceGetObjectId(), instanceGetSwizzled(), instanceIsValid(), instanceOdbcToCollection(), instanceSet(), instanceSetObject(), instanceSetObjectId()
property jurisdiction as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");

Intended jurisdiction for charge item definition (if applicable)

jurisdiction is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in jurisdiction, you may formally EXTEND jurisdiction to add codes to it.

Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
property lastReviewDate as %String (MAXLEN = 1000000, XMLNAME = "lastReviewDate", XMLPROJECTION = "ATTRIBUTE");

When the charge item definition was last reviewed.

Property methods: lastReviewDateDisplayToLogical(), lastReviewDateGet(), lastReviewDateIsValid(), lastReviewDateLogicalToDisplay(), lastReviewDateLogicalToOdbc(), lastReviewDateNormalize(), lastReviewDateSet()
property partOf as list of %String (MAXLEN = 1000000, XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");

A larger definition of which this particular definition is a component or step.

TO DO: Unrecognized value type for the FHIR4 model

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

Group of properties which are applicable under the same conditions.

Property methods: propertyGroupBuildValueArray(), propertyGroupCollectionToDisplay(), propertyGroupCollectionToOdbc(), propertyGroupDisplayToCollection(), propertyGroupGet(), propertyGroupGetObject(), propertyGroupGetObjectId(), propertyGroupGetSwizzled(), propertyGroupIsValid(), propertyGroupOdbcToCollection(), propertyGroupSet(), propertyGroupSetObject(), propertyGroupSetObjectId()
property publisher as %String (MAXLEN = 1000000, XMLNAME = "publisher", XMLPROJECTION = "ATTRIBUTE");

Name of the publisher (organization or individual)

Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
property replaces as list of %String (MAXLEN = 1000000, XMLNAME = "replaces", XMLPROJECTION = "ELEMENT");

Completed or terminated request(s) whose function is taken by this new request.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: replacesBuildValueArray(), replacesCollectionToDisplay(), replacesCollectionToOdbc(), replacesDisplayToCollection(), replacesDisplayToLogical(), replacesGet(), replacesGetObject(), replacesGetObjectId(), replacesGetSwizzled(), replacesIsValid(), replacesLogicalToDisplay(), replacesLogicalToOdbc(), replacesNormalize(), replacesOdbcToCollection(), replacesSet(), replacesSetObject(), replacesSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

draft | active | retired | unknown

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

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property title as %String (MAXLEN = 1000000, XMLNAME = "title", XMLPROJECTION = "ATTRIBUTE");

Name for this charge item definition (human friendly)

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Canonical identifier for this charge item definition, represented as a URI (globally unique)

Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property useContext as list of HS.FHIR.DTL.vR4.Model.Datatype.UsageContext (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");

The context that the content is intended to support.

Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()
property version as %String (MAXLEN = 1000000, XMLNAME = "version", XMLPROJECTION = "ATTRIBUTE");

Business version of the charge item definition.

Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab