export_claim_submission_history

Claim submission history: one row per claim submission, distinguishing automated Candid submissions, Medicare crossovers, and external submissions, to insurance payers or non-insurance payers, with the essential clearinghouse and payer acknowledgement signals.

Primary Key: claim_submission_id

Identifiers

claim_submission_id
STRINGRequired

Unique ID associated with the claim submission in the Candid system

claim_id
STRING

Unique Claim ID

encounter_id
STRING

Unique ID associated with the encounter in the Candid system

Organization

organization_id
STRING

User’s unique organization ID in the Candid system

organization_name
STRING

Organization Name

Timestamps

created_at
TIMESTAMP

Time when the claim submission was created (i.e. when the claim was submitted)

updated_at
TIMESTAMP

Time when the claim submission or any of its related records (claim, payer, or acknowledgements) was last updated. Use this for incremental ingestion.

submission_status_updated_at
TIMESTAMP

Time when the submission status last changed

Submission

submission_status
STRING

Status of the submission: PASS, FAIL, or AWAITING_RESPONSE

submission_channel
STRING

How the claim was submitted: ‘Candid Automated’ (generated and transmitted by Candid), ‘External’ (submitted outside Candid and marked as externally submitted), or ‘Medicare Crossover’ (automatically forwarded by Medicare to a secondary payer)

is_automated_submission
BOOLEAN

True when Candid generated and transmitted the submission

is_external_submission
BOOLEAN

True when the claim was submitted outside Candid and marked as externally submitted

is_medicare_crossover
BOOLEAN

True when the submission was automatically forwarded by Medicare to a secondary payer

submitted_by_user_id
STRING

Unique ID of the user who submitted the claim, when applicable (null for automated submissions)

submitted_by_name
STRING

Name of the user who submitted the claim, when applicable (null for automated submissions)

pipeline_id
STRING

Identifier of the pipeline that submitted the claim, when applicable

intended_submission_medium
STRING

The medium the claim was submitted on: electronic or paper

submission_destination
STRING

The clearinghouse or destination the claim was submitted to (e.g. Availity, Change Healthcare, Waystar)

payer_responsibility
STRING

The payer responsibility level for this submission: primary, secondary, or tertiary

Payer

payer_type
STRING

Whether the submission was sent to an ‘Insurance’ payer or a ‘Non-Insurance Payer’

payer_uuid
STRING

Unique ID of the insurance payer the claim was submitted to, when applicable

payer_name
STRING

Name of the insurance payer the claim was submitted to, when applicable

non_insurance_payer_uuid
STRING

Unique ID of the non-insurance payer the claim was submitted to, when applicable

non_insurance_payer_name
STRING

Name of the non-insurance payer the claim was submitted to, when applicable

Submission Type & History

claim_frequency_code
STRING

Claim frequency (type of bill) code: 1 = original, 7 = corrected/replacement, 8 = void

submission_type
STRING

Derived submission type: Original, Resubmission, Corrected/Replacement, or Void

submission_number
INTEGER

Ordinal position of this submission within the claim’s submission history (1 = first)

is_first_submission
BOOLEAN

True for the earliest submission of the claim

is_latest_submission
BOOLEAN

True for the most recent submission of the claim

Acknowledgements

has_impl_999
BOOLEAN

True when a 999 implementation acknowledgement has been received for this submission

ack_code_999
STRING

The 999 transaction set acknowledgement code (e.g. A = accepted, R/E = rejected)

implementation_999_received_at
TIMESTAMP

Time the latest 999 implementation acknowledgement was received, when available

has_clearinghouse_277
BOOLEAN

True when a clearinghouse 277 acknowledgement has been received for this submission

clearinghouse_trace_number
STRING

The clearinghouse-assigned trace number from the clearinghouse 277 acknowledgement, when available

clearinghouse_277_received_at
TIMESTAMP

Time the latest clearinghouse 277 acknowledgement was received, when available

has_payer_277_ack
BOOLEAN

True when a payer 277 claim acknowledgement has been received for this submission

claim_status_category_code
STRING

Health care claim status category code from the latest payer 277 acknowledgement

claim_status_code
STRING

Health care claim status code from the latest payer 277 acknowledgement

payer_claim_control_number
STRING

The payer-assigned claim control number (ICN) from the payer 277 acknowledgement, when available

payer_277_received_at
TIMESTAMP

Time the latest payer 277 claim acknowledgement was received, when available

failure_stage
STRING

Computed acknowledgement stage classification: which gate (999 / clearinghouse 277 / payer 277) the submission last cleared or failed at, or ‘Healthy’

Additional Context

payer_generated_control_number
STRING

Payer-generated control number associated with the submission, when available

force_submission_reason
STRING

Reason provided when a force submission was used, when applicable