Posting
Introduction #
This module defines models related to payments and postings associated with healthcare claims.
Basic usage #
To retrieve a posting by ID:
from canvas_sdk.v1.data.posting import BasePosting
posting = BasePosting.objects.get(dbid=1234)
To retrieve all active postings for a given claim:
from canvas_sdk.v1.data.claim import Claim
claim = Claim.objects.get(id="<uuid>")
claim_postings = claim.postings.active()
Attributes #
BasePosting #
Base model for aggregating multiple line item-level transactions (payments, adjustments, transfers) associated with a claim.
Field Name | Type |
---|---|
dbid | Integer |
corrected_posting | BasePosting |
claim | Claim |
payment_collection | PaymentCollection |
description | String |
entered_in_error | CanvasUser |
created | DateTime |
modified | DateTime |
Computed Properties:
paid_amount
: Total paidcontractual_adjusted_amount
: Adjustments marked as write-offsnon_write_off_adjusted_amount
: Non-write-off adjustmentstransferred_amount
: Total transferredtransferred_to_patient_amount
: Portion transferred to patienttransferred_to_coverage_amount
: Portion transferred to another coverageadjusted_and_transferred_amount
: Combined adjusted and transferred amountposted_amount
: Total of payments and write-offs
CoveragePosting #
Represents an insurance payment or adjustment associated with a claim’s coverage.
Field Name | Type |
---|---|
remittance | BaseRemittanceAdvice |
claim_coverage | ClaimCoverage |
crossover_carrier | String |
crossover_id | String |
payer_icn | String |
position_in_era | Integer |
PatientPosting #
Represents patient-side payments or adjustments, including links to copays or patient-level discounts.
Field Name | Type |
---|---|
claim_patient | ClaimPatient |
patient_payment | BulkPatientPosting |
copay | BulkPatientPosting |
Computed Properties:
discounted_amount
: Discount appliedcharges_amount
: Discount + paid amount
BulkPatientPosting #
Aggregates bulk patient payments on multiple claims.
Field Name | Type |
---|---|
id | UUID |
dbid | Integer |
payment_collection | PaymentCollection |
total_paid | Decimal |
created | DateTime |
modified | DateTime |
discount | Discount |
payer | Patient |
Computed Properties:
total_posted_amount
: Sum of all posted amountsdiscounted_amount
: Sum of discounted amounts
BaseRemittanceAdvice #
Represents shared data for both electronic and manual remittance advice.
Field Name | Type |
---|---|
id | UUID |
dbid | Integer |
payment_collection | PaymentCollection |
total_paid | Decimal |
created | DateTime |
modified | DateTime |
transactor | Transactor |
era_id | String |
Computed Properties:
total_posted_amount
: Sum of all posted amounts
PaymentCollection #
Captures metadata about the method and details of a collected payment.
Field Name | Type |
---|---|
id | UUID |
dbid | Integer |
total_collected | Decimal |
method | PostingMethods |
check_number | String |
check_date | Date |
deposit_date | Date |
description | String |
created | DateTime |
modified | DateTime |
NewLineItemPayment #
Represents a payment applied to a billing line item within a claim.
Field Name | Type |
---|---|
dbid | Integer |
posting | BasePosting |
billing_line_item | BillingLineItem |
amount | Decimal |
charged | Decimal |
created | DateTime |
modified | DateTime |
NewLineItemAdjustment #
Represents an adjustment applied to a billing line item.
Field Name | Type |
---|---|
dbid | Integer |
posting | BasePosting |
billing_line_item | BillingLineItem |
amount | Decimal |
code | String |
group | String |
deviated_from_posting_ruleset | Boolean |
write_off | Boolean |
created | DateTime |
modified | DateTime |
LineItemTransfer #
Represents a transfer of a line item balance to another coverage or patient.
Field Name | Type |
---|---|
dbid | Integer |
posting | BasePosting |
billing_line_item | BillingLineItem |
amount | Decimal |
code | String |
group | String |
deviated_from_posting_ruleset | Boolean |
transfer_to | ClaimCoverage |
transfer_to_patient | Boolean |
created | DateTime |
modified | DateTime |
Discount #
Represents a discount applied to a claim or patient posting, linked by adjustment group and code.
Field Name | Type |
---|---|
dbid | Integer |
name | String |
adjustment_group | String |
adjustment_code | String |
discount | Decimal |
created | DateTime |
modified | DateTime |
Enumeration types #
PostingMethods #
Value | Label |
---|---|
cash | Cash |
check | Check |
card | Card |
other | Other |