Claim Last updated: 28 Jan 2026
Introduction # This module defines the data models used to manage healthcare claim workflows.
Basic usage # To retrieve a claim by its identifier:
from canvas_sdk.v1.data.claim import Claim
claim = Claim . objects . get ( id = "9d2e0f58-338b-11ec-8d3d-0242ac130003" )
To access diagnosis codes for a claim:
from canvas_sdk.v1.data.claim import Claim
claim = Claim . objects . get ( id = "9d2e0f58-338b-11ec-8d3d-0242ac130003" )
diagnosis_codes = claim . diagnosis_codes . all (). order_by ( "rank" )
for diagnosis in diagnosis_codes :
print ( f "Rank { diagnosis . rank } : { diagnosis . code } - { diagnosis . display } " )
Filtering # from canvas_sdk.v1.data.claim import Claim
# Active claims only
active_claims = Claim . objects . active ()
Attributes # Claim # Represents a complete healthcare claim. Claim belongs to a Note and has a one-to-one relationship with a ClaimPatient.
Field Name Type id UUID dbid Integer note Note installment_plan InstallmentPlan current_queue ClaimQueue current_coverage ClaimCoverage accept_assign Boolean auto_accident Boolean auto_accident_state String employment_related Boolean other_accident Boolean accident_code String illness_date Date remote_batch_id String remote_file_id String prior_auth String narrative String account_number String snoozed_until Date patient_balance Decimal aggregate_coverage_balance Decimal created DateTime modified DateTime diagnosis_codes ClaimDiagnosisCode []comments ClaimComment []line_items ClaimLineItem []labels TaskLabel []provider ClaimProvider
Computed Properties :
total_charges: Total charges for active line itemstotal_paid: Sum of paid amounts from postingstotal_adjusted: Sum of adjustments and transfersbalance: Remaining balance (coverage + patient)total_patient_paid: Paid amount by the patienttotal_payer_paid: Paid amount by coveragesHelpful Methods :
get_coverage_by_payer_id(payer_id: str, subscriber_number: str | None = None): Finds the active coverage associated with a payer_id. Optionally checks if the subscriber_number matches, which will choose the correct coverage in the case where a patient has two coverages with the same payer_id. ClaimLineItem # Represents individual billed procedures or services tied to a claim.
ClaimLineItemDiagnosisCode # Represents a diagnosis code for a given ClaimLineItem. There exists one ClaimLineItemDiagnosisCode for each ClaimDiagnosisCode, and the “linked” attribute indicates whether or not the diagnosis code is linked to the line item.
ClaimCoverage # Links a claim to a specific insurance coverage.
Field Name Type id UUID dbid Integer claim Claim coverage Coverage active Boolean payer_name String payer_id String payer_typecode String payer_order ClaimPayerOrder payer_addr1 String payer_addr2 String payer_city String payer_state String payer_zip String payer_plan_type ClaimTypeCode coverage_type CoverageType subscriber_employer String subscriber_group String subscriber_number String subscriber_plan String subscriber_dob String subscriber_first_name String subscriber_last_name String subscriber_middle_name String subscriber_phone String subscriber_sex PersonSex subscriber_addr1 String subscriber_addr2 String subscriber_city String subscriber_state String subscriber_zip String subscriber_country String patient_relationship_to_subscriber CoverageRelationshipCode pay_to_addr1 String pay_to_addr2 String pay_to_city String pay_to_state String pay_to_zip String resubmission_code String payer_icn String created DateTime modified DateTime
ClaimComment # Represents a free-text comment made on a Claim.
Field Name Type id UUID dbid Integer claim Claim created DateTime modified DateTime deleted Boolean entered_in_error CanvasUser committer CanvasUser comment String
ClaimDiagnosisCode # Represents diagnosis codes associated with a claim, ordered by rank.
Field Name Type id UUID dbid Integer claim Claim line_item_diagnosis_codes ClaimLineItemDiagnosisCode []rank Integer code String display String created DateTime modified DateTime
ClaimQueue # Defines the metadata for claim queues used in revenue workflows.
Field Name Type dbid Integer queue_sort_ordering Integer name String display_name String description String show_in_revenue Boolean visible_columns Array[ClaimQueueColumns ] created DateTime modified DateTime
ClaimPatient # Captures patient-level data related to a specific claim.
Field Name Type dbid Integer claim Claim photo String dob String first_name String last_name String middle_name String phone String sex PersonSex ssn String addr1 String addr2 String city String state String zip String country String created DateTime modified DateTime
ClaimLabel # Represents labels assigned to the claim.
ClaimProvider # Captures provider-level data related to a specific claim.
Field Name Type id UUID dbid Integer claim Claim clia_number String billing_provider_name String billing_provider_phone String billing_provider_addr1 String billing_provider_addr2 String billing_provider_city String billing_provider_state String billing_provider_zip String billing_provider_id String billing_provider_npi String billing_provider_tax_id String billing_provider_tax_id_type String billing_provider_taxonomy String provider_id String provider_first_name String provider_last_name String provider_middle_name String provider_npi String provider_tax_id String provider_tax_id_type String provider_taxonomy String provider_ptan_identifier String referring_provider_id String referring_provider_first_name String referring_provider_last_name String referring_provider_middle_name String referring_provider_npi String referring_provider_ptan_identifier String ordering_provider_first_name String ordering_provider_last_name String ordering_provider_middle_name String ordering_provider_npi String facility_id String facility_name String facility_npi String facility_addr1 String facility_addr2 String facility_city String facility_state String facility_zip String hosp_from_date String hosp_to_date String created DateTime modified DateTime
ClaimSubmission # Captures clearinghouse submission details about a claim.
Field Name Type id UUID dbid Integer claim Claim coverage ClaimCoverage clearinghouse_claim_id String claim_index Integer
InstallmentPlan # Represents a payment plan between a patient and provider.
Enumeration types # ClaimLineItemStatus # Value Label active Active removed Removed
LineItemCodes # FamilyPlanningOptions # ClaimLineItemStatus # Value Label active Active removed Removed
LineItemCodes # FamilyPlanningOptions # ClaimPayerOrder # Value Label Primary Primary Secondary Secondary Tertiary Tertiary Quaternary Quaternary Quinary Quinary
ClaimTypeCode # Code Description 12 Working Aged (Age 65 or older) 13 End-Stage Renal Disease 14 No-fault 15 Workers Compensation 41 Black Lung 42 Veterans Administration 43 Disabled (Under Age 65) 47 Other Liability Insurance is primary ”” No Typecode necessary
ClaimQueueColumns # Value Label NoteType Note type ClaimID Claim ID DateOfService Date of service Patient Patient ActiveInsurance Active insurance InsuranceBalance Insurance balance PatientBalance Patient balance DaysInQueue Days in queue Provider Provider Guarantor Guarantor LatestRemit Latest remit LastInvoiced Last invoiced SnoozedUntil Snoozed until Labels Labels
ClaimQueues # Value Label 1 Appointment 2 NeedsClinicianReview 3 NeedsCodingReview 4 QueuedForSubmission 5 FiledAwaitingResponse 6 RejectedNeedsReview 7 AdjudicatedOpenBalance 8 PatientBalance 9 ZeroBalance 10 Trash
InstallmentPlanStatus # Value Label active Active completed Completed cancelled Cancelled
Questions? Create an issue.