> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.joincandidhealth.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.joincandidhealth.com/_mcp/server. # export_patient > Patient demographic and identification data Patient demographic and identification data. One row per patient, reflecting the patient's current state. Deactivated patients are included with `deactivated = TRUE`. `mrn` matches `patient_external_id` on encounter-level tables (`export_encounter`, `export_patient_monetary_transaction`) within the same `organization_id`. **Primary Key:** `patient_id` ## Identifiers **`patient_id`** `STRING` — required Unique ID associated with the patient in the Candid system --- **`mrn`** `STRING` Medical Record Number - the foreign key to map patient to user's own system --- ## Timestamps **`updated_at`** `TIMESTAMP` Time at which the patient record was last updated in the database --- **`created_at`** `TIMESTAMP` Time at which the patient record was created in the database --- **`deceased_at`** `TIMESTAMP` Timestamp at which the patient was recorded as deceased, if applicable --- ## 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 **`deactivated`** `BOOLEAN` Whether the patient record has been deactivated --- **`birth_date`** `DATE` Patient's date of birth --- **`last_name`** `STRING` Patient's last name (uppercase) --- **`first_name`** `STRING` Patient's first name (uppercase) --- **`social_security_number`** `STRING` Patient's Social Security Number --- **`address_line_1`** `STRING` Patient's primary address line 1 --- **`address_line_2`** `STRING` Patient's primary address line 2 --- **`city`** `STRING` Patient's city of residence --- **`state`** `STRING` Patient's state of residence --- **`zip_code`** `STRING` Patient's ZIP code --- **`country`** `STRING` Patient's country of residence --- **`county`** `STRING` County of the patient's primary address --- **`phone`** `STRING` Patient's phone number --- **`phone_type`** `STRING` Type of phone number (e.g., HOME, CELL, WORK) --- **`email`** `STRING` Patient's email address --- **`gender`** `STRING` Patient's gender identity --- **`biological_sex`** `STRING` Patient's biological sex --- **`race`** `STRING` Patient's race --- **`ethnicity`** `STRING` Patient's ethnicity --- **`marital_status`** `STRING` Patient's marital status --- **`language`** `STRING` Patient's preferred language --- **`is_deceased`** `BOOLEAN` Whether the patient is recorded as deceased --- **`advanced_directives`** `ARRAY` Array of the patient's advanced directives (e.g., LIVING_WILL, DO_NOT_RESUSCITATE, DURABLE_POWER_OF_ATTORNEY) --- **`hipaa_code`** `STRING` Patient's HIPAA code --- **`tags`** `STRING` Tags associated with the patient record --- **`custom_metadata`** `ARRAY>` Array of customer-defined metadata schema instances, each with a schema id and its arbitrary key/value pairs; shape varies by metadata schema --- **`created_by`** `STRING` Name of the user who created the patient record --- ## Billing **`do_not_invoice`** `BOOLEAN` Flag indicating if the patient should not be invoiced --- **`do_not_invoice_reason`** `STRING` Reason why the patient should not be invoiced --- **`self_pay`** `BOOLEAN` Whether the patient is self-pay (no active insurance or non-insurance payer coverage) --- **`subscriber_employer_name`** `STRING` Employer name of the primary coverage's subscriber --- ## Attending Provider **`attending_provider_data`** `ARRAY>` Array of attending provider information including NPI and name --- **`first_attending_provider_first_name`** `STRING` First name of the first attending provider (alphabetical by NPI) --- **`first_attending_provider_last_name`** `STRING` Last name of the first attending provider (alphabetical by NPI) --- **`first_attending_provider_name`** `STRING` Full name of the first attending provider in title case --- **`first_attending_provider_npi`** `STRING` NPI of the first attending provider (alphabetical by NPI) --- ## Referring Provider **`referring_provider_data`** `ARRAY>` Array of referring provider information including NPI and name --- **`first_referring_provider_first_name`** `STRING` First name of the first referring provider (alphabetical by NPI) --- **`first_referring_provider_last_name`** `STRING` Last name of the first referring provider (alphabetical by NPI) --- **`first_referring_provider_name`** `STRING` Full name of the first referring provider in title case --- **`first_referring_provider_npi`** `STRING` NPI of the first referring provider (alphabetical by NPI) --- ## Service Facility **`primary_service_facility_id`** `STRING` ID of the patient's primary service facility --- **`primary_service_facility_name`** `STRING` Name of the patient's primary service facility --- ## Non-Insurance Payers & Clinical Trials **`non_insurance_payer_association_count`** `INTEGER` Number of non-insurance payer associations linked to the patient --- **`non_insurance_payer_associations`** `ARRAY>` Array of non-insurance payer associations with details --- **`clinical_trial_count`** `INTEGER` Number of clinical trials the patient is associated with --- **`clinical_trials`** `ARRAY>` Array of clinical trial details associated with the patient (non_insurance_payer_id, clinical_trial_id, clinical_trial_arm, clinical_trial_start_date, clinical_trial_end_date, clinical_trial_number, clinical_trial_name). Join on non_insurance_payer_id and clinical_trial_id to export_non_insurance_payer.clinical_trials. --- ## Emergency Contact **`emergency_contact_data`** `ARRAY>` Array of the patient's emergency contacts, each including name, relationship, and phone --- **`first_emergency_contact_first_name`** `STRING` First name of the patient's first listed emergency contact (uppercase) --- **`first_emergency_contact_last_name`** `STRING` Last name of the patient's first listed emergency contact (uppercase) --- **`first_emergency_contact_name`** `STRING` Full name of the patient's first listed emergency contact in title case --- **`first_emergency_contact_relationship`** `STRING` Relationship of the patient's first listed emergency contact to the patient --- **`first_emergency_contact_phone`** `STRING` Phone number of the patient's first listed emergency contact ---