Skip to main content

ClaimSchema

all_tenants_claim_medical_readundefined[]
amount_allowednumbernullable

Use computed_amount_allowed in case this field is missing.

amount_billednumbernullable

Use computed_amount_billed in case this field is missing.

amount_not_coverednumbernullable
amount_paidnumbernullable

Use computed_amount_paid in case this field is missing.

amount_paid_othernumbernullable
check_datedatenullable
check_numberstringnullable
claim_approvalundefined[]
claim_medical_idinteger
claim_membersundefined[]
claim_statusnullable
claim_status_idintegerrequired
claim_tenantsundefined[]
claim_tpafileundefined[]
coinsurance_patientnumbernullable

Use computed_coinsurance_patient in case this field is missing.

computed_amount_allowednumber
computed_amount_billednumber
computed_amount_paidnumber
computed_coinsurance_patientnumber
computed_copaymentnumber
computed_discountnumbernullable
computed_interop_diagnosis_stringstringnullable
computed_patient_responsibilitynumber
computed_reductionnumber
copaymentnumbernullable

Use computed_copayment in case this field is missing.

createddatedate-timenullable
dataobjectnullable
dataobject_idintegernullable
date_columndate-time
discountnumbernullable

Use computed_discount in case this field is missing.

employersundefined[]
eob_datedatenullable
group_namestringnullable
group_numberstringnullable
idinteger
incurred_valuenumber
is_exportedboolean
is_incompletebooleannullable

This claim may have incomplete data. If a claim is marked as incomplete, we typically will not send it until it gets marked as complete. Reasons for an incomplete claim include (1) documentation that isn't yet available but we expect it to be in the near future, and (2) if we notice the claim has data redacted for privacy (example: a dependent over 16 years old), but we expect to get this data when a dependent links their account.

last_updated_statusdate-timenullable

Used as an indicator of when the last substantial change happened to this claim. If this date gets updated, we consider it necessary to re-send the claim for processing (in data exports) / flag it as "unread" in TPA Stream / etc. Typically this date gets updated when the patient_responsibility or status changes, or otherwise when is_incomplete changes to True.

modifiedbynullable
modifiedby_idintegernullable
modifieddatedate-timenullable
networkstring

Possible values: [IN, OUT, TIER1, TIER2]

patient_account_numberstringnullable

Patient Account Number for Service Provider (used for payments)

patient_date_of_birthdatenullable
patient_namestringnullable
patient_payer_numberstringnullable

Patient Account Number for Carrier

patient_responsibilitynumbernullable

Use computed_patient_responsibility in case this field is missing.

patient_ssnstringnullable
payernullable
payer_group_idintegernullable
policy_holder_fullnamestring
policy_holder_idintegerrequired
polymorphic__amount_allowed
polymorphic__amount_billed
polymorphic__amount_paid
polymorphic__coinsurance_patient
polymorphic__copayment
polymorphic__patient_responsibility
polymorphic__reduction
processed_ondatenullable
read
read_all
recrawl_requestedboolean

Attempt to recrawl when True

reductionnumbernullable

This is the amount the deductible was reduced by. Most systems refer to this as 'deductible'. Use computed_reduction in case this field is empty.

remarksstringnullable

These are the notes for the Claim.

service_providerstringnullable

Service Provider Name. This is the physical name, and is provided by the Payer.

service_provider_addressstringnullable

Physical address of Service Provider

service_provider_billing_addressstringnullable
service_provider_billing_namestringnullable

This is the service_provider's Billing name, which is often different from their physical address name.

service_provider_billing_npi_numberintegernullable

NPI Number of Billing Service Provider

service_provider_billing_numberstringnullable

Federal Tax ID of Billing Service Provider

service_provider_billing_phonestringnullable
service_provider_napb_numberstringnullable

NAPB Number of Pharmacy

service_provider_npi_numberintegernullable

NPI Number of Service Provider

service_provider_numberstringnullable

Federal Tax ID of Service Provider

statusstring

Possible values: [In Process, Processed, Rejected, Adjusted, Partially Approved]

tenantsundefined[]
total_amount_allowednumber
total_amount_billednumber
total_amount_paidnumber
total_coinsurance_patientnumber
total_copaymentnumber
total_patient_responsibilitynumber
total_reductionnumber
type_idintegernullable
user_membersundefined[]
uuiduuid
vendor_system_idstringrequired

This field is unique for each Payer. Occasionally TPA Stream may append data to the end of this key to enforce uniqueness, such as the date_of_service, patient_responsibility, etc.

ClaimSchema
{
"all_tenants_claim_medical_read": [
null
],
"amount_allowed": 0,
"amount_billed": 0,
"amount_not_covered": 0,
"amount_paid": 0,
"amount_paid_other": 0,
"check_date": "2024-07-29",
"check_number": "string",
"claim_approval": [
null
],
"claim_medical_id": 0,
"claim_members": [
null
],
"claim_status_id": 0,
"claim_tenants": [
null
],
"claim_tpafile": [
null
],
"coinsurance_patient": 0,
"computed_amount_allowed": 0,
"computed_amount_billed": 0,
"computed_amount_paid": 0,
"computed_coinsurance_patient": 0,
"computed_copayment": 0,
"computed_discount": 0,
"computed_interop_diagnosis_string": "string",
"computed_patient_responsibility": 0,
"computed_reduction": 0,
"copayment": 0,
"createddate": "2024-07-29T15:51:28.071Z",
"dataobject_id": 0,
"date_column": "2024-07-29T15:51:28.071Z",
"discount": 0,
"employers": [
null
],
"eob_date": "2024-07-29",
"group_name": "string",
"group_number": "string",
"id": 0,
"incurred_value": 0,
"is_exported": true,
"is_incomplete": true,
"last_updated_status": "2024-07-29T15:51:28.071Z",
"modifiedby_id": 0,
"modifieddate": "2024-07-29T15:51:28.071Z",
"network": "IN",
"patient_account_number": "string",
"patient_date_of_birth": "2024-07-29",
"patient_name": "string",
"patient_payer_number": "string",
"patient_responsibility": 0,
"patient_ssn": "string",
"payer_group_id": 0,
"policy_holder_fullname": "string",
"policy_holder_id": 0,
"processed_on": "2024-07-29",
"recrawl_requested": true,
"reduction": 0,
"remarks": "string",
"service_provider": "string",
"service_provider_address": "string",
"service_provider_billing_address": "string",
"service_provider_billing_name": "string",
"service_provider_billing_npi_number": 0,
"service_provider_billing_number": "string",
"service_provider_billing_phone": "string",
"service_provider_napb_number": "string",
"service_provider_npi_number": 0,
"service_provider_number": "string",
"status": "In Process",
"tenants": [
null
],
"total_amount_allowed": 0,
"total_amount_billed": 0,
"total_amount_paid": 0,
"total_coinsurance_patient": 0,
"total_copayment": 0,
"total_patient_responsibility": 0,
"total_reduction": 0,
"type_id": 0,
"user_members": [
null
],
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"vendor_system_id": "string"
}