BillingLineItem

Introduction #

The BillingLineItem model represents billing line items linked to Notes that can be found in the note footer. BillingLineItems are also linked to Patient instances.

Usage #

The BillingLineItem model can be used to find all of the billable codes linked to a patient note. For example, to find all of the current billing line items for a note, the Note.billing_line_items method can be used:

>>> from canvas_sdk.v1.data.note import Note
>>> from canvas_sdk.v1.data.billing import BillingLineItemStatus
>>> note_1 = Note.objects.get(id="a74592ae8a6c4d0ebe0799d3fb3713d1")
>>> note_1_billing_line_items = note_1.billing_line_items.filter(status=BillingLineItemStatus.ACTIVE)
>>> print([item.cpt for item in note_1_billing_line_items])
['99213', '90703']

Alternatively, you could find all the BillingLineItem instances for a single Patient:

>>> from canvas_sdk.v1.data.patient import Patient
>>> patient_1 = Patient.objects.get(id="aebe4d3f5d18410388dc69c4b5169fc3")
>>> patient_billing_line_items = patient_1.billing_line_items.all()
>>> print([item.cpt for item in patient_billing_line_items])
['99213', '90703', '76942', '67505']

You can also access all BillingLineItemModifiers associated with a BillingLineItem:

>>> from canvas_sdk.v1.data.billing import BillingLineItem, BillingLineItemModifier
>>> line_item = BillingLineItem.objects.get(id="b80b1cdc2e6a4aca90ccebc02e683f35")
>>> line_item_modifiers = line_item.modifiers.all()
>>> print([mod.code for mod in line_item_modifiers])
['25', '59']

Filtering #

The filter method can be used to filter by desired attributes. The following examples show commonly used operations to filter billing line item data:

Show a Patient’s active BillingLineItems that start with ‘99-‘ in order of descending charge amount

>>> from canvas_sdk.v1.data.patient import Patient
>>> from canvas_sdk.v1.data.billing import BillingLineItemStatus
>>> patient_1 = Patient.objects.get(id="aebe4d3f5d18410388dc69c4b5169fc3")
>>> office_visit_charges = patient_1.billing_line_items.filter(status=BillingLineItemStatus.ACTIVE, cpt__startswith='99').order_by("charge")
>>> print([(item.cpt, item.charge,) for item in office_visit_charges])
[('99215', 200.00), ('99215', 190.00), ('99214', 100.00), ('99213', 80.00)]

Find All Removed BillingLineItems from a Note

>>> import arrow
>>> from canvas_sdk.v1.data.note import Note
>>> from canvas_sdk.v1.data.billing import BillingLineItemStatus
>>> note_1 = Note.objects.get(id="a74592ae8a6c4d0ebe0799d3fb3713d1")
>>> note_1_removed_items = note_1.billing_line_items.filter(status=BillingLineItemStatus.REMOVED)
>>> print([item.cpt for item in note_1_removed_items])
['11901', '00950']

Find a Patient’s BillingLineItems in a Value Set

To check whether a patient was billed for a kind of encounter, such as when computing an electronic clinical quality measure (eCQM), pass a Value Set to the find method:

from canvas_sdk.v1.data.patient import Patient
from canvas_sdk.value_set.v2022.encounter import OfficeVisit

patient = Patient.objects.get(id="aebe4d3f5d18410388dc69c4b5169fc3")
office_visit_items = patient.billing_line_items.find(OfficeVisit)

A billing line item stores its code in the cpt field without a code system, so find matches the field against the value set’s CPT, HCPCSLEVELII, and HCPCS codes.

For examples of how to use the BillingLineItem data class with the BillingLineItem effects, check out this page

Attributes #

BillingLineItem #

Field NameType
idUUID
dbidInteger
createdDateTime
modifiedDateTime
noteNote
patientPatient
cptString
chargeDecimal
descriptionString
unitsInteger
command_typeString
command_idInteger
statusBillingLineItemStatus
assessmentsAssessment[]
modifiersBillingLineItemModifier[]
claimlineitem_setClaimLineItem[]

BillingLineItemModifier #

Field NameType
dbidInteger
createdDateTime
modifiedDateTime
line_itemBillingLineItem
systemString
versionString
codeString
displayString
user_selectedBoolean

Enumeration types #

BillingLineItemStatus #

ValueLabel
ACTIVEActive
REMOVEDRemoved