export_encounter

All data related to a single encounter. Payer Plan Group refers to Payer Plans.

Primary Key: encounter_id, claim_id

Identifiers

encounter_id
STRINGRequired

Unique ID associated with the encounter in the Candid system

external_id
STRING

Encounter External ID (originating from the EMR / EHR)

patient_external_id
STRING

Patient External ID

guarantor_external_id
STRING

Guarantor external ID

subscriber_primary_insurance_card_member_id
STRING

Primary subscriber / policyholder member ID

subscriber_secondary_insurance_card_member_id
STRING

Secondary subscriber / policyholder member ID

subscriber_tertiary_insurance_card_member_id
STRING

Tertiary subscriber / policyholder member ID

claim_id
STRINGRequired

Unique Claim ID

Timestamps

created_at
DATETIME

Time at which the encounter is first created in the database

updated_at
DATETIME

Time at which the encounter is updated in the database (note: the database tables overall are updated at 5 AM EST daily)

deleted_at
TIMESTAMP

When was the encounter soft-deleted from the Candid system?

Organization

organization_id
STRING

User’s unique organization ID in the Candid system

organization_name
STRING

User’s Organization / Company Name

external_organization_id
STRING

Organization’s External ID - the ID that the organization uses to map to their own upstream system

Patient Information

patient_authorized_release
BOOLEAN

Does the patient have an authorized release claim?

patient_first_name
STRING

Patient First Name

patient_last_name
STRING

Patient Last Name

patient_gender
STRING

Patient Gender

patient_date_of_birth
DATE

Patient Date of Birth

patient_address_address_1
STRING

Patient Address (first line)

patient_address_address_2
STRING

Patient Address (second line / additional info)

patient_address_city
STRING

Patient Address City

patient_address_state
STRING

Patient Address State

patient_address_zip_code
STRING

Patient Address Zip Code

patient_address_zip_plus_four_code
STRING

Patient Address Zip Code (plus four code)

patient_phone_numbers
ARRAY<STRING>

Patient phone number

patient_phone_consent
BOOLEAN

Patient provided consent by phone?

patient_email
STRING

Patient email

patient_email_consent
BOOLEAN

Patient provided consent by email?

patient_reason_for_visit_codes
STRING

Patient Reason for Visit Code (Institutional Claims only)

Billing Provider

billing_provider_id
STRING

Billing Provider ID

billing_provider_first_name
STRING

Billing Provider First Name

billing_provider_last_name
STRING

Billing Provider Last Name

billing_provider_organization_name
STRING

Billing Provider Organization Name

billing_provider_tax_id
STRING

Billing Provider Tax ID

billing_provider_npi
STRING

Billing Provider NPI

billing_provider_taxonomy_code
STRING

Billing Provider Taxonomy Code

billing_provider_qualifier
STRING

Specific code used on claim forms to identify the billing provider

billing_provider_address_address_1
STRING

Billing Provider Address Line

billing_provider_address_address_2
STRING

Billing Provider Additional Address Line

billing_provider_address_city
STRING

Billing Provider City

billing_provider_address_state
STRING

Billing Provider State

billing_provider_address_zip_code
STRING

Billing Provider Zip Code

billing_provider_address_zip_plus_four_code
STRING

Billing Provider Zip Code (Additional Numbers)

Rendering Provider

rendering_provider_first_name
STRING

Rendering Provider First Name

rendering_provider_last_name
STRING

Rendering Provider Last Name

rendering_provider_organization_name
STRING

Rendering Provider Organization Name

rendering_provider_tax_id
STRING

Rendering Provider Tax ID

rendering_provider_npi
STRING

Rendering Provider NPI Number

rendering_provider_taxonomy_code
STRING

Rendering Provider Taxonomy Code

rendering_provider_qualifier
STRING

Specific code used on claim forms to identify the rendering provider

rendering_provider_address_address_1
STRING

Rendering provider address

rendering_provider_address_address_2
STRING

Rendering provider address (second line / additional info)

rendering_provider_address_city
STRING

Rendering provider address city

rendering_provider_address_state
STRING

Rendering provider address state

rendering_provider_address_zip_code
STRING

Rendering provider address zip code

rendering_provider_address_zip_plus_four_code
STRING

Rendering provider address zip code (plus four code)

treating_provider_id
STRING

Treating Provider ID

treating_provider_first_name
STRING

Treating Provider First Name

treating_provider_last_name
STRING

Treating Provider Last Name

treating_provider_tax_id
STRING

Treating Provider Tax ID

treating_provider_npi
STRING

Treating Provider NPI Number

treating_provider_taxonomy_code
STRING

Treating Provider Taxonomy Code

treating_provider_license_type
STRING

Treating Provider License Type

treating_provider_address_address_1
STRING

Treating Provider Main Address

treating_provider_address_address_2
STRING

Treating Provider Secondary Address Field

treating_provider_address_city
STRING

Treating Provider City

treating_provider_address_state
STRING

Treating Provider State

treating_provider_address_zip_code
STRING

Treating Provider Zip Code

treating_provider_address_zip_plus_four_code
STRING

Treating Provider Zip Code (Plus Four code)

Referring Provider

referring_provider_first_name
STRING

Referring Provider First Name

referring_provider_last_name
STRING

Referring Provider Last Name

referring_provider_organization_name
STRING

Referring Provider Organization Name

referring_provider_tax_id
STRING

Referring Provider Tax ID

referring_provider_npi
STRING

Referring Provider NPI Number

referring_provider_taxonomy_code
STRING

Referring Provider Taxonomy Code

referring_provider_qualifier
STRING

Referring Provider Qualifier

referring_provider_address_address_1
STRING

Referring Provider Address

referring_provider_address_address_2
STRING

Referring Provider Address (Additional Information)

referring_provider_address_city
STRING

Referring Provider City

referring_provider_address_state
STRING

Referring Provider State

referring_provider_address_zip_code
STRING

Referring Provider Zip Code

referring_provider_address_zip_plus_four_code
STRING

Referring Provider Zip Code (Plus Four Code)

initial_referring_provider_first_name
STRING

Initial Referring Provider First Name

initial_referring_provider_last_name
STRING

Initial Referring Provider Last Name

initial_referring_provider_organization_name
STRING

Initial Referring Provider Organization

initial_referring_provider_tax_id
STRING

Initial Referring Provider Tax ID

initial_referring_provider_npi
STRING

Initial Referring Provider NPI

initial_referring_provider_taxonomy_code
STRING

Initial Referring Provider Taxonomy Code

initial_referring_provider_qualifier
STRING

Specific code used on claim forms to identify the initial referring provider

initial_referring_provider_address_address_1
STRING

Initial Referring Provider Address Line

initial_referring_provider_address_address_2
STRING

Initial Referring Provider Address (Second Line)

initial_referring_provider_address_city
STRING

Initial Referring Provider City

initial_referring_provider_address_state
STRING

Initial Referring Provider State

initial_referring_provider_address_zip_code
STRING

Initial Referring Provider Zip Code

initial_referring_provider_address_zip_plus_four_code
STRING

Initial Referring Provider Zip Code (Plus Four Code)

Attending Provider

attending_provider_first_name
STRING

Attending Provider First Name (Institutional Claims only)

attending_provider_last_name
STRING

Attending Provider Last Name (Institutional Claims only)

attending_provider_organization_name
STRING

Attending Provider Organization Name (Institutional Claims only)

attending_provider_tax_id
STRING

Attending Provider Tax ID (Institutional Claims only)

attending_provider_npi
STRING

Attending Provider NPI (Institutional Claims only)

attending_provider_taxonomy_code
STRING

Attending Provider Taxonomy Code (Institutional Claims only)

attending_provider_qualifier
STRING

Attending Provider Qualifier (Institutional Claims only)

attending_provider_address_address_1
STRING

Attending Provider Address (Institutional Claims only)

attending_provider_address_address_2
STRING

Attending Provider Address (additional information) (Institutional Claims only)

attending_provider_address_city
STRING

Attending Provider Address City (Institutional Claims only)

attending_provider_address_state
STRING

Attending Provider Address State (Institutional Claims only)

attending_provider_address_zip_code
STRING

Attending Provider Address Zip Code (Institutional Claims only)

attending_provider_address_zip_plus_four_code
STRING

Attending Provider Address Zip Code (Institutional Claims only)

Supervising Provider

supervising_provider_first_name
STRING

Supervising Provider First Name

supervising_provider_last_name
STRING

Supervising Provider Last Name

supervising_provider_organization_name
STRING

Supervising Provider Organization Name

supervising_provider_tax_id
STRING

Supervising Provider Tax ID

supervising_provider_npi
STRING

Supervising Provider NPI

supervising_provider_taxonomy_code
STRING

Supervising Provider Taxonomy Code

supervising_provider_qualifier
STRING

Specific code used on a claim form to identify the healthcare professional who was responsible for overseeing the services rendered to a patient

supervising_provider_address_address_1
STRING

Supervising Provider Address Line

supervising_provider_address_address_2
STRING

Supervising Provider Second Address

supervising_provider_address_city
STRING

Supervising Provider City

supervising_provider_address_state
STRING

Supervising Provider State

supervising_provider_address_zip_code
STRING

Supervising Provider Zip Code

supervising_provider_address_zip_plus_four_code
STRING

Supervising Provider Zip Code (Additional Numbers)

Ordering Provider

ordering_provider_first_name
STRING

Ordering Provider’s First Name

ordering_provider_last_name
STRING

Ordering Provider’s Last Name

ordering_provider_organization_name
STRING

Ordering Provider’s Organization Name

ordering_provider_tax_id
STRING

Ordering Provider’s Tax ID

ordering_provider_npi
STRING

Ordering Provider’s NPI number

ordering_provider_taxonomy_code
STRING

Ordering Provider’s Taxonomy Code

ordering_provider_qualifier
STRING

Specific code used in medical billing to identify the healthcare professional who ordered a particular service or item for a patient

ordering_provider_address_address_1
STRING

Ordering Provider’s Address Line 1

ordering_provider_address_address_2
STRING

Ordering Provider’s Address Line 2

ordering_provider_address_city
STRING

Ordering Provider’s City

ordering_provider_address_state
STRING

Ordering Provider’s State

ordering_provider_address_zip_code
STRING

Ordering Provider’s Zip Code

ordering_provider_address_zip_plus_four_code
STRING

Ordering Provider’s Zip Code (Additional Numbers)

Service Facility

service_facility_id
STRING

Service Facility ID

service_facility_organization_name
STRING

Service Facility Organization Name

service_facility_npi
STRING

Service Facility NPI

service_facility_address_address_1
STRING

Service Facility Address (first line)

service_facility_address_address_2
STRING

Service Facility Address (second line / additional information)

service_facility_address_city
STRING

Service Facility Address City

service_facility_address_state
STRING

Service Facility Address State

service_facility_address_zip_code
STRING

Service Facility Address Zip Code

service_facility_address_zip_plus_four_code
STRING

Service Facility address Zip Code (plus 4 code digits)

Subscriber - Primary

subscriber_primary_first_name
STRING

Primary subscriber / policyholder first name

subscriber_primary_last_name
STRING

Primary subscriber / policyholder last name

subscriber_primary_gender
STRING

Primary subscriber / policyholder gender

subscriber_primary_date_of_birth
DATE

Primary subscriber / policyholder date of birth

subscriber_primary_patient_relationship_to_subscriber_code
STRING

Primary subscriber / policyholder relationship to patient

subscriber_primary_address_address_1
STRING

Primary subscriber / policyholder address

subscriber_primary_address_address_2
STRING

Primary subscriber / policyholder address (second line / additional information)

subscriber_primary_address_city
STRING

Primary subscriber / policyholder city

subscriber_primary_address_state
STRING

Primary subscriber / policyholder state

subscriber_primary_address_zip_code
STRING

Primary subscriber / policyholder zip code

subscriber_primary_address_zip_plus_four_code
STRING

Primary subscriber / policyholder zip code (plus four code)

subscriber_primary_insurance_card_group_number
STRING

Primary subscriber / policyholder group number

subscriber_primary_payer_plan_group_id
STRING

Unique identifier for the primary subscriber / policyholder payer plan

subscriber_primary_payer_plan_group_name
STRING

Specific name for the primary subscriber / policyholder payer plan

subscriber_primary_insurance_card_plan_name
STRING

Primary subscriber / policyholder insurance card plan name

subscriber_primary_insurance_card_plan_type
STRING

Primary subscriber / policyholder insurance card plan type

subscriber_primary_insurance_card_insurance_type
STRING

Primary subscriber / policyholder insurance type

subscriber_primary_insurance_card_payer_name
STRING

Primary subscriber / policyholder payer name

subscriber_primary_insurance_card_payer_id
STRING

Primary subscriber / policyholder payer ID

subscriber_primary_insurance_card_rx_bin
STRING

Primary subscriber / policyholder prescription Bank Identification Number - a six-digit number found on your health insurance card that is used to process prescription drug claims

subscriber_primary_insurance_card_rx_pcn
STRING

Primary subscriber / policyholder Processor Control Number

subscriber_primary_insurance_card_payer_address_address_1
STRING

Primary subscriber / policyholder payer address

subscriber_primary_insurance_card_payer_address_address_2
STRING

Primary subscriber / policyholder payer address (second line / additional information)

subscriber_primary_insurance_card_payer_address_city
STRING

Primary subscriber / policyholder payer city

subscriber_primary_insurance_card_payer_address_state
STRING

Primary subscriber / policyholder payer state

subscriber_primary_insurance_card_payer_address_zip_code
STRING

Primary subscriber / policyholder payer zip code

subscriber_primary_insurance_card_payer_address_zip_plus_four_code
STRING

Primary subscriber / policyholder payer zip code (plus four code)

Subscriber - Secondary

subscriber_secondary_first_name
STRING

Secondary subscriber / policyholder first name

subscriber_secondary_last_name
STRING

Secondary subscriber / policyholder last name

subscriber_secondary_gender
STRING

Secondary subscriber / policyholder gender

subscriber_secondary_date_of_birth
DATE

Secondary subscriber / policyholder date of birth

subscriber_secondary_patient_relationship_to_subscriber_code
STRING

Secondary subscriber / policyholder relationship to patient

subscriber_secondary_address_address_1
STRING

Secondary subscriber / policyholder address

subscriber_secondary_address_address_2
STRING

Secondary subscriber / policyholder address (second line / additional information)

subscriber_secondary_address_city
STRING

Secondary subscriber / policyholder city

subscriber_secondary_address_state
STRING

Secondary subscriber / policyholder state

subscriber_secondary_address_zip_code
STRING

Secondary subscriber / policyholder zip code

subscriber_secondary_address_zip_plus_four_code
STRING

Secondary subscriber / policyholder zip code (plus four code)

subscriber_secondary_insurance_card_group_number
STRING

Secondary subscriber / policyholder group number

subscriber_secondary_payer_plan_group_id
STRING

Unique identifier for the specific plan associated with the subscriber / policyholder’s secondary payer

subscriber_secondary_payer_plan_group_name
STRING

Name of the specific plan associated with the secondary subscriber / policyholder

subscriber_secondary_insurance_card_plan_name
STRING

Secondary subscriber / policyholder insurance card plan name

subscriber_secondary_insurance_card_plan_type
STRING

Secondary subscriber / policyholder insurance card plan type

subscriber_secondary_insurance_card_insurance_type
STRING

Secondary subscriber / policyholder insurance type

subscriber_secondary_insurance_card_payer_name
STRING

Secondary subscriber / policyholder payer name

subscriber_secondary_insurance_card_payer_id
STRING

Secondary subscriber / policyholder payer ID

subscriber_secondary_insurance_card_rx_bin
STRING

Secondary subscriber / policyholder prescription Bank Identification Number - a six-digit number found on your health insurance card that is used to process prescription drug claims

subscriber_secondary_insurance_card_rx_pcn
STRING

Secondary subscriber / policyholder Processor Control Number

subscriber_secondary_insurance_card_payer_address_address_1
STRING

Secondary subscriber / policyholder payer address

subscriber_secondary_insurance_card_payer_address_address_2
STRING

Secondary subscriber / policyholder payer address (second line / additional information)

subscriber_secondary_insurance_card_payer_address_city
STRING

Secondary subscriber / policyholder payer city

subscriber_secondary_insurance_card_payer_address_state
STRING

Secondary subscriber / policyholder payer state

subscriber_secondary_insurance_card_payer_address_zip_code
STRING

Secondary subscriber / policyholder payer zip code

subscriber_secondary_insurance_card_payer_address_zip_plus_four_code
STRING

Secondary subscriber / policyholder payer zip code (plus four code)

Subscriber - Tertiary

subscriber_tertiary_first_name
STRING

Tertiary subscriber / policyholder first name

subscriber_tertiary_last_name
STRING

Tertiary subscriber / policyholder last name

subscriber_tertiary_gender
STRING

Tertiary subscriber / policyholder gender

subscriber_tertiary_date_of_birth
DATE

Tertiary subscriber / policyholder date of birth

subscriber_tertiary_patient_relationship_to_subscriber_code
STRING

Tertiary subscriber / policyholder relationship to patient

subscriber_tertiary_address_address_1
STRING

Tertiary subscriber / policyholder address

subscriber_tertiary_address_address_2
STRING

Tertiary subscriber / policyholder address (second line / additional information)

subscriber_tertiary_address_city
STRING

Tertiary subscriber / policyholder city

subscriber_tertiary_address_state
STRING

Tertiary subscriber / policyholder state

subscriber_tertiary_address_zip_code
STRING

Tertiary subscriber / policyholder zip code

subscriber_tertiary_address_zip_plus_four_code
STRING

Tertiary subscriber / policyholder zip code (plus four code)

subscriber_tertiary_insurance_card_group_number
STRING

Tertiary subscriber / policyholder group number

subscriber_tertiary_payer_plan_group_id
STRING

Unique identifier for the specific plan associated with the subscriber / policyholder’s tertiary payer

subscriber_tertiary_payer_plan_group_name
STRING

Name of the specific plan associated with the tertiary subscriber / policyholder

subscriber_tertiary_insurance_card_plan_name
STRING

Tertiary subscriber / policyholder insurance card plan name

subscriber_tertiary_insurance_card_plan_type
STRING

Tertiary subscriber / policyholder insurance card plan type

subscriber_tertiary_insurance_card_insurance_type
STRING

Tertiary subscriber / policyholder insurance type

subscriber_tertiary_insurance_card_payer_name
STRING

Tertiary subscriber / policyholder payer name

subscriber_tertiary_insurance_card_payer_id
STRING

Tertiary subscriber / policyholder payer ID

subscriber_tertiary_insurance_card_rx_bin
STRING

Tertiary subscriber / policyholder prescription Bank Identification Number - a six-digit number found on your health insurance card that is used to process prescription drug claims

subscriber_tertiary_insurance_card_rx_pcn
STRING

Tertiary subscriber / policyholder Processor Control Number

subscriber_tertiary_insurance_card_payer_address_address_1
STRING

Tertiary subscriber / policyholder payer address

subscriber_tertiary_insurance_card_payer_address_address_2
STRING

Tertiary subscriber / policyholder payer address (second line / additional information)

subscriber_tertiary_insurance_card_payer_address_city
STRING

Tertiary subscriber / policyholder payer city

subscriber_tertiary_insurance_card_payer_address_state
STRING

Tertiary subscriber / policyholder payer state

subscriber_tertiary_insurance_card_payer_address_zip_code
STRING

Tertiary subscriber / policyholder payer zip code

subscriber_tertiary_insurance_card_payer_address_zip_plus_four_code
STRING

Tertiary subscriber / policyholder payer zip code (plus four code)

Guarantor

guarantor_first_name
STRING

Guarantor first name

guarantor_last_name
STRING

Guarantor last name

guarantor_date_of_birth
DATE

Guarantor Date of Birth

guarantor_address_address_1
STRING

Guarantor Address

guarantor_address_address_2
STRING

Guarantor Address (second line / additional info)

guarantor_address_city
STRING

Guarantor address city

guarantor_address_state
STRING

Guarantor address state

guarantor_address_zip_code
STRING

Guarantor address zip code

guarantor_address_zip_plus_four_code
STRING

Guarantor address zip code (plus four code)

guarantor_phone_numbers
ARRAY<STRING>

Guarantor phone number

guarantor_phone_consent
BOOLEAN

Guarantor provided consent by phone?

guarantor_email
STRING

Guarantor email

guarantor_email_consent
BOOLEAN

Guarantor provided consent by email?

Claim Information

claim_form_type
STRING

Claim Form Type (professional or institutional)

claim_patient_control_number
STRING

Claim Patient Control Number

claim_externally_generated_patient_control_number
STRING

Claim Externally Generated Patient Control Number

claim_status
STRING

Claim Status

claim_adjudicated_network_status
STRING

Claim Adjudicated Network Status

claim_clia_number
STRING

Claim CLIA Number

external_cause_of_injury_codes
STRING

External Cause of Injury Code (Institutional Claims only)

condition_codes
STRING

Condition codes (Institutional Claims only)

Diagnosis

diagnosis_codes
STRING

Diagnosis Codes

diagnosis_related_group_code
STRING

Diagnosis related group code (Institutional Claims only)

Other

date_of_service
DATE

Encounter Date of Service

prior_authorization_number
STRING

Prior Authorization Number / unique code from payer confirming a procedure or service is approved

benefits_assigned_to_provider
BOOLEAN

Does provider have an authorized assignment of benefits form? (Are patients’ payers authorized to directly pay the provider for the services rendered?)

provider_accepts_assignment
BOOLEAN

Did the provider accept assignment?

appointment_type
STRING

Notes on the Appointment Type (follow-up, initial assessment, etc.)

place_of_service_code
STRING

Two-digit code indicating the setting where healthcare services were provided and / or rendered

place_of_service_code_as_submitted
STRING

Place of Service Code as it is submitted to the Payer (after it has been run through the Rules Engine / POS configurations)

delay_reason_code
STRING

Standard codes to communicate why a claim’s processing or payment has been delayed

coding_attribution
STRING

Assignment of a patient to a specific healthcare provider or group

synchronicity
STRING

Synchronous vs. Asynchronous

type_of_bill
STRING

A four-digit code that identifies the facility type, bill classification, and sequence of the bill (Institutional Claims only)

admission_source_code
STRING

Admission Source code that identifies where a patient originated before admission, essential for inpatient/outpatient institutional claims (Institutional Claims only)

admission_type_code
STRING

One-digit code indicating the priority of an inpatient admission (Institutional Claims only)

admission_date
DATE

Admission Date (Institutional Claims only)

admission_hour
INTEGER

Admission Hour (Institutional Claims only)

discharge_status
STRING

Two-digit codes indicating a patient’s destination or status upon leaving a facility (Institutional Claims only)

discharge_date
DATE

Discharge Date (Institutional Claims only)

discharge_hour
INTEGER

Discharge Hour (Institutional Claims only)

accident_state_or_province_code
STRING

Two-letter accident state abbreviation (or province code) (Institutional Claims only)

pay_to_address_address_1
STRING

Pay to address

pay_to_address_address_2
STRING

Pay to address (additional info)

pay_to_address_city
STRING

Pay to address city

pay_to_address_state
STRING

Pay to address state

pay_to_address_zip_code
STRING

Pay to address zip code

pay_to_address_zip_plus_four_code
STRING

Pay to address zip code (plus four code)

vitals_height_in
INTEGER

Height in inches

vitals_weight_lbs
INTEGER

Weight in Lbs

vitals_blood_pressure_systolic_mmhg
INTEGER

Systolic Blood Pressure (mmHg)

vitals_blood_pressure_diastolic_mmhg
INTEGER

Diastolic Blood Pressure (mmHg)

vitals_body_temperature_f
FLOAT

Body Temperature

vitals_hemoglobin_gdl
FLOAT

Hemoglobin (grams / deciliter)

vitals_hematocrit_pct
FLOAT

Hematocrit Value / Percentage

responsible_party
STRING

Billing type (Self Pay vs Insurance Pay)

next_responsible_party
STRING

Responsible Party on a Claim (Payer, Patient, Non-Insurance, None)

billable_status
STRING

Billable vs. Not Billable

admitting_diagnosis_code
STRING

The ICD-10-CM code provided by a physician at the time of patient admission (Institutional Claims only)

description
STRING

Two-digit codes to report financial or numerical data related to specific conditions, such as Medicare deductibles, no-fault payments, oxygen saturation levels, or insurance coordination (Institutional Claims only)” }

custom_metadata_key_value_pairs
JSON

Custom Metadata / KVPs - custom metadata created by the Customer

tags
STRING

Tags

date_first_submitted
DATE

Date First Submitted

date_last_submitted
DATE

Date Last Submitted

is_deleted
BOOLEAN

Has the encounter been soft deleted from the Candid system?