Data Model Libraries
    Preparing search index...

    Class ChargeItem

    ChargeItem Class

    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.

    FHIR Specification

    • Short: Item containing charge code(s) associated with the provision of healthcare provider products
    • Definition: 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.
    • FHIR Version: 5.0.0

    FHIR ChargeItem

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? definitionUri? definitionCanonical? chargeitemStatusEnum status partOf? code subject encounter? occurrence? performer? performingOrganization? requestingOrganization? costCenter? quantity? bodysite? unitPriceComponent? totalPriceComponent? overrideReason? enterer? enteredDate? reason? service? product? account? note? supportingInformation?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getDefinitionUriElement setDefinitionUriElement addDefinitionUriElement hasDefinitionUriElement getDefinitionUri setDefinitionUri addDefinitionUri hasDefinitionUri getDefinitionCanonicalElement setDefinitionCanonicalElement addDefinitionCanonicalElement hasDefinitionCanonicalElement getDefinitionCanonical setDefinitionCanonical addDefinitionCanonical hasDefinitionCanonical getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getPartOf setPartOf addPartOf hasPartOf getCode setCode hasCode getSubject setSubject hasSubject getEncounter setEncounter hasEncounter getOccurrence setOccurrence hasOccurrence getOccurrenceDateTimeType hasOccurrenceDateTimeType getOccurrencePeriod hasOccurrencePeriod getOccurrenceTiming hasOccurrenceTiming getPerformer setPerformer addPerformer hasPerformer getPerformingOrganization setPerformingOrganization hasPerformingOrganization getRequestingOrganization setRequestingOrganization hasRequestingOrganization getCostCenter setCostCenter hasCostCenter getQuantity setQuantity hasQuantity getBodysite setBodysite addBodysite hasBodysite getUnitPriceComponent setUnitPriceComponent hasUnitPriceComponent getTotalPriceComponent setTotalPriceComponent hasTotalPriceComponent getOverrideReason setOverrideReason hasOverrideReason getEnterer setEnterer hasEnterer getEnteredDateElement setEnteredDateElement hasEnteredDateElement getEnteredDate setEnteredDate hasEnteredDate getReason setReason addReason hasReason getService setService addService hasService getProduct setProduct addProduct hasProduct getAccount setAccount addAccount hasAccount getNote setNote addNote hasNote getSupportingInformation setSupportingInformation addSupportingInformation hasSupportingInformation fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initDefinitionUri initDefinitionCanonical initPartOf initPerformer initBodysite initReason initService initProduct initAccount initNote initSupportingInformation

    Constructors

    Properties

    identifier?: Identifier[]

    ChargeItem.identifier Element

    FHIR Specification

    • Short: Business Identifier for item
    • Definition: Identifiers assigned to this event performer or other systems.
    • Requirements: Allows identification of the charge Item as it is known by various participating systems and in a way that remains consistent across servers.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    definitionUri?: UriType[]

    ChargeItem.definitionUri Element

    FHIR Specification

    • Short: Defining information about the code of this charge item
    • Definition: References the (external) source of pricing information, rules of application for the code this ChargeItem uses.
    • FHIR Type: uri
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    definitionCanonical?: CanonicalType[]

    ChargeItem.definitionCanonical Element

    FHIR Specification

    • Short: Resource defining the code of this ChargeItem
    • Definition: References the source of pricing information, rules of application for the code this ChargeItem uses.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    chargeitemStatusEnum: ChargeitemStatusEnum

    FHIR CodeSystem: ChargeitemStatus

    ChargeitemStatusEnum

    status: null | EnumCodeType

    ChargeItem.status Element

    FHIR Specification

    • Short: planned | billable | not-billable | aborted | billed | entered-in-error | unknown
    • Definition: The current state of the ChargeItem.
    • Comment: Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. This element is labeled as a modifier because the status contains the code entered-in-error that marks the charge item as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: ChargeitemStatusEnum

    partOf?: Reference[]

    ChargeItem.partOf Element

    FHIR Specification

    • Short: Part of referenced ChargeItem
    • Definition: ChargeItems can be grouped to larger ChargeItems covering the whole set.
    • Requirements: E.g. Drug administration as part of a procedure, procedure as part of observation, etc.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    code: null | CodeableConcept

    ChargeItem.code Element

    FHIR Specification

    • Short: A code that identifies the charge, like a billing code
    • Definition: A code that identifies the charge, like a billing code.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    subject: null | Reference

    ChargeItem.subject Element

    FHIR Specification

    encounter?: Reference

    ChargeItem.encounter Element

    FHIR Specification

    • Short: Encounter associated with this ChargeItem
    • Definition: This ChargeItem has the details of how the associated Encounter should be billed or otherwise be handled by finance systems.
    • Comment: This ChargeItem may be recorded during planning, execution or after the actual encounter takes place.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    occurrence?: IDataType

    ChargeItem.occurrence[x] Element

    @ChoiceDataTypesMeta('ChargeItem.occurrence[x]', ['dateTime','Period','Timing',]

    FHIR Specification

    • Short: When the charged service was applied
    • Definition: Date/time(s) or duration when the charged service was applied.
    • Comment: The list of types may be constrained as appropriate for the type of charge item.
    • FHIR Types: 'dateTime', 'Period', 'Timing',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    performer?: ChargeItemPerformerComponent[]

    ChargeItem.performer Element

    FHIR Specification

    • Short: Who performed charged service
    • Definition: Indicates who or what performed or participated in the charged service.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    performingOrganization?: Reference

    ChargeItem.performingOrganization Element

    FHIR Specification

    • Short: Organization providing the charged service
    • Definition: The organization performing the service.
    • Comment: Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which Organization the services have been rendered.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    requestingOrganization?: Reference

    ChargeItem.requestingOrganization Element

    FHIR Specification

    • Short: Organization requesting the charged service
    • Definition: The organization requesting the service.
    • Comment: The rendered Service might not be associated with a Request. This property indicates which Organization requested the services to be rendered. (In many cases, this may just be the Department associated with the Encounter.location).
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    costCenter?: Reference

    ChargeItem.costCenter Element

    FHIR Specification

    • Short: Organization that has ownership of the (potential, future) revenue
    • Definition: The financial cost center permits the tracking of charge attribution.
    • Comment: The costCenter could either be given as a reference to an Organization(Role) resource or as the identifier of the cost center determined by Reference.identifier.value and Reference.identifier.system, depending on use case requirements.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    quantity?: Quantity

    ChargeItem.quantity Element

    FHIR Specification

    • Short: Quantity of which the charge item has been serviced
    • Definition: Quantity of which the charge item has been serviced.
    • Comment: In many cases this may just be a value, if the underlying units are implicit in the definition of the charge item code.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    bodysite?: CodeableConcept[]

    ChargeItem.bodysite Element

    FHIR Specification

    • Short: Anatomical location, if relevant
    • Definition: The anatomical location where the related service has been applied.
    • Comment: Only used if not implicit in code found in Condition.code. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension http://hl7.org/fhir/StructureDefinition/bodySite. May be a summary code, or a reference to a very precise definition of the location, or both.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    unitPriceComponent?: MonetaryComponent

    ChargeItem.unitPriceComponent Element

    FHIR Specification

    • Short: Unit price overriding the associated rules
    • Definition: The unit price of the chargable item.
    • Comment: This could be communicated in ChargeItemDefinition. But if ChargeItemDefinition is not supported or not available, the unit price can be communicated in this property.
    • FHIR Type: MonetaryComponent
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    totalPriceComponent?: MonetaryComponent

    ChargeItem.totalPriceComponent Element

    FHIR Specification

    • Short: Total price overriding the associated rules
    • Definition: The total price for the chargable item, accounting for the quantity.
    • Comment: Often, the total price may be be calculated and recorded on the Invoice, but if a calculated total price must be exchanged prior to Invoice creation, it can be communicated in this property.
    • FHIR Type: MonetaryComponent
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    overrideReason?: CodeableConcept

    ChargeItem.overrideReason Element

    FHIR Specification

    • Short: Reason for overriding the list price/factor
    • Definition: 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.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    enterer?: Reference

    ChargeItem.enterer Element

    FHIR Specification

    enteredDate?: DateTimeType

    ChargeItem.enteredDate Element

    FHIR Specification

    • Short: Date the charge item was entered
    • Definition: Date the charge item was entered.
    • Comment: The actual date when the service associated with the charge has been rendered is captured in occurrence[x].
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    reason?: CodeableConcept[]

    ChargeItem.reason Element

    FHIR Specification

    • Short: Why was the charged service rendered?
    • Definition: Describes why the event occurred in coded or textual form.
    • Comment: If the application of the charge item requires a reason to be given, it can be captured here. Textual reasons can be captured using reasonCode.text.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    service?: CodeableReference[]

    ChargeItem.service Element

    FHIR Specification

    product?: CodeableReference[]

    ChargeItem.product Element

    FHIR Specification

    account?: Reference[]

    ChargeItem.account Element

    FHIR Specification

    • Short: Account to place this charge
    • Definition: Account into which this ChargeItems belongs.
    • Comment: Systems posting the ChargeItems might not always be able to determine, which accounts the Items need to be places into. It is up to the postprocessing Financial System to apply internal rules to decide based on the Encounter/EpisodeOfCare/Patient/Coverage context and the type of ChargeItem, which Account is appropriate.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    note?: Annotation[]

    ChargeItem.note Element

    FHIR Specification

    • Short: Comments made about the ChargeItem
    • Definition: Comments made about the event by the performer, subject or other participants.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    supportingInformation?: Reference[]

    ChargeItem.supportingInformation Element

    FHIR Specification

    • Short: Further information supporting this charge
    • Definition: Further information supporting this charge.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided ChargeItem JSON to instantiate the ChargeItem data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR ChargeItem

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ChargeItem

      Returns undefined | ChargeItem

      ChargeItem data model or undefined for ChargeItem

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided PerformingOrganization object value to the performingOrganization property.

      Parameters

      • value: undefined | Reference

        the performingOrganization object value

      Returns this

      this

      @ReferenceTargets('ChargeItem.performingOrganization', ['Organization',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided RequestingOrganization object value to the requestingOrganization property.

      Parameters

      • value: undefined | Reference

        the requestingOrganization object value

      Returns this

      this

      @ReferenceTargets('ChargeItem.requestingOrganization', ['Organization',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided Enterer object value to the enterer property.

      Parameters

      • value: undefined | Reference

        the enterer object value

      Returns this

      this

      @ReferenceTargets('ChargeItem.enterer', ['Practitioner','PractitionerRole','Organization','Patient','Device','RelatedPerson',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided Reference array value to the supportingInformation property.

      Parameters

      • value: undefined | Reference[]

        the supportingInformation array value

      Returns this

      this

      @ReferenceTargets('ChargeItem.supportingInformation', ['Resource',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetDefinitionUriElementsetDefinitionUriElementaddDefinitionUriElementhasDefinitionUriElementgetDefinitionUrisetDefinitionUriaddDefinitionUrihasDefinitionUrigetDefinitionCanonicalElementsetDefinitionCanonicalElementaddDefinitionCanonicalElementhasDefinitionCanonicalElementgetDefinitionCanonicalsetDefinitionCanonicaladdDefinitionCanonicalhasDefinitionCanonicalgetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetPartOfsetPartOfaddPartOfhasPartOfgetCodesetCodehasCodegetSubjectsetSubjecthasSubjectgetEncountersetEncounterhasEncountergetOccurrencesetOccurrencehasOccurrencegetOccurrenceDateTimeTypehasOccurrenceDateTimeTypegetOccurrencePeriodhasOccurrencePeriodgetOccurrenceTiminghasOccurrenceTiminggetPerformersetPerformeraddPerformerhasPerformergetPerformingOrganizationsetPerformingOrganizationhasPerformingOrganizationgetRequestingOrganizationsetRequestingOrganizationhasRequestingOrganizationgetCostCentersetCostCenterhasCostCentergetQuantitysetQuantityhasQuantitygetBodysitesetBodysiteaddBodysitehasBodysitegetUnitPriceComponentsetUnitPriceComponenthasUnitPriceComponentgetTotalPriceComponentsetTotalPriceComponenthasTotalPriceComponentgetOverrideReasonsetOverrideReasonhasOverrideReasongetEnterersetEntererhasEnterergetEnteredDateElementsetEnteredDateElementhasEnteredDateElementgetEnteredDatesetEnteredDatehasEnteredDategetReasonsetReasonaddReasonhasReasongetServicesetServiceaddServicehasServicegetProductsetProductaddProducthasProductgetAccountsetAccountaddAccounthasAccountgetNotesetNoteaddNotehasNotegetSupportingInformationsetSupportingInformationaddSupportingInformationhasSupportingInformationfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitDefinitionUriinitDefinitionCanonicalinitPartOfinitPerformerinitBodysiteinitReasoninitServiceinitProductinitAccountinitNoteinitSupportingInformation