> 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. # Get Patient List GET https://pre-api.joincandidhealth.com/lists/v1/patient Gets patients with dependent objects for patients that match the query parameters. Reference: https://docs.joincandidhealth.com/api-reference/pre-encounter/lists/v-1/get-patient-list ## Authentication - OAuth2 — send the obtained token as `Authorization: Bearer ` ## Servers - `https://pre-api.joincandidhealth.com` (Production, default) - `https://pre-api-staging.joincandidhealth.com` (Staging) - `https://sandbox-pre-api.joincandidhealth.com` (CandidSandbox) - `https://staging-pre-api.joincandidhealth.com` (CandidStaging) - `http://localhost:4000` (Local) ## Request ### Query parameters - `page_token` (string, optional) — A token that can be used to retrieve the next or previous page of results - `limit` (integer, optional) - `sort_field` (string, optional) — Defaults to patient.updatedAt. - `sort_direction` (enum, optional) — Defaults to ascending. - Allowed values: `asc`, `desc` - `filters` (string, optional) — A serialized list of filters separated by commas indicating filters to apply. Each filter is of the form 'path:operator:value'. Example: 'patient.mrn|eq|12345'. Filters are separated by commas. Example: 'patient.mrn|eq|12345,appointment.startDate|gt|67890'. All filters are ANDed together. Valid operators are 'eq', 'gt', 'lt', 'contains', 'ieq', 'in'. ieq is a case-insensitive equality operator. in allows searching for values that match any item in a semicolon-separated list (e.g., 'patient.id|in|foo;bar;baz'). Path values are camelCase. - `include_deactivated` (boolean, optional) — If true, includes deactivated patients in the results. Defaults to false. - `redirect_to_primary` (boolean, optional) — If true, and filtering by mrn equals, then only return the primary version of the patient requested - `hide_alternatives` (boolean, optional) — If true, then do not show alternative patients ## Response ### 200 - `items` (list of PatientListItem, required) - `total` (integer, required) - `next_page_token` (string, optional) — A token that can be used to retrieve the next or previous page of results - `prev_page_token` (string, optional) — A token that can be used to retrieve the next or previous page of results ## Errors ### 400 Bad Request Error - `errorName` ("BadRequestError", required) - `content` (ErrorBase4xx, required) ## Types ### PatientListItem - `patient` (Patient, required) — A patient object with immutable server-owned properties. - `alternative_mrns` (list of string, required) - `primary_coverage` (MutableCoverage, optional) - `secondary_coverage` (MutableCoverage, optional) - `tertiary_coverage` (MutableCoverage, optional) - `next_appointment` (MutableAppointment, optional) — An object representing a appointment. - `primary_mrn` (string, optional) ### ErrorBase4xx - `message` (string, required) - `data` (any, optional) ### Patient A patient object with immutable server-owned properties. - `biological_sex` (enum, required) — The biological sex of the patient. This corresponds to the HL7 AdministrativeGender https://www.hl7.org/fhir/valueset-administrative-gender.html - Allowed values: `FEMALE`, `MALE`, `UNKNOWN`, `REFUSED` - `birth_date` (date, required) - `contacts` (list of Contact, required) — Contacts for the patient. - `deactivated` (boolean, required) — True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan. - `filing_order` (FilingOrder, required) — The patient's active coverages, in order of primary, secondary, etc. - `general_practitioners` (list of ExternalProvider, required) - `id` (string, required) — The unique UUID identifier for a Patient. Patient ID is used in machine contexts. - `mrn` (string, required) — The medical record number for the patient. Human-friendly Candid generated MRNs are of the form "YYMMDDXXXX", where "YYMMDD" is the date of patient creation and "XXXX" is a zero-padded incrementing integer. - `name` (HumanName, required) - `organization_id` (string, required) — The organization that owns this object. - `other_addresses` (list of Address, required) — Other addresses for the patient. - `other_names` (list of HumanName, required) — Other names for the patient. - `other_telecoms` (list of ContactPoint, required) — Other phone numbers for the patient. - `primary_address` (Address, required) — The primary address for the patient. - `updated_at` (datetime, required) - `updating_user_id` (string, required) — The user ID of the user who last updated the object. - `version` (integer, required) — The version of the object. Any update to any property of an object object will create a new version. - `advanced_directives` (list of enum, optional) - Allowed values: `NONE`, `DURABLE_POWER_OF_ATTORNEY`, `LIVING_WILL`, `DO_NOT_RESUSCITATE`, `STANDARD_PRECAUTIONS`, `FALL_RISK` - `authorizations` (list of Authorization, optional) - `coverages_for_related_causes` (CoveragesForRelatedCauses, optional) — Additional coverages for the patient applicable to related causes such as Auto or Workers Comp - `custom_metadata` (list of CustomMetadataEntry, optional) — Custom key/value metadata attached to this patient, grouped by the MetadataSchema that defines the keys' types. Configure schemas via the metadata-schemas API. Values are validated against the referenced schema on write. - `deceased` (datetime, optional) — Time of death for the patient. Leave unset if the patient is not deceased. - `disability_status` (enum, optional) - Allowed values: `DISABLED`, `NON_DISABLED` - `do_not_invoice_reason` (enum, optional) — If this value is defined, the customer will not be invoiced. - Allowed values: `BANKRUPTCY`, `DECEASED`, `HARDSHIP`, `OTHER`, `COLLECTIONS`, `BAD_ADDRESS`, `PROFESSIONAL_COURTESY` - `electronic_communication_consent` (ElectronicCommunicationConsent, optional) — Granular consent for electronic communication channels. - `email` (string, optional) - `ethnicity` (enum, optional) - Allowed values: `HISPANIC_OR_LATINO`, `NOT_HISPANIC_OR_LATINO`, `UNKNOWN`, `REFUSED` - `external_provenance` (ExternalProvenance, optional) — Information about the upstream system that owns this patient data. Leave unset if Candid owns patient data. - `gender` (enum, optional) - Allowed values: `MAN`, `WOMAN`, `NON_BINARY`, `TWO_SPIRIT`, `FEMALE_TO_MALE`, `MALE_TO_FEMALE`, `OTHER`, `UNKNOWN`, `REFUSED` - `guarantor` (Guarantor, optional) - `hipaa_code` (string, optional) - `inferred_patient_metadata` (InferredPatientMetadata, optional) — Metadata for the patient used for patient inference from encounters. - `language` (string, optional) - `marital_status` (enum, optional) - Allowed values: `ANNULLED`, `DIVORCED`, `INTERLOCUTORY`, `SEPARATED`, `MARRIED`, `COMMON_LAW`, `POLYGAMOUS`, `DOMESTIC_PARTNER`, `UNMARRIED`, `NEVER_MARRIED`, `WIDOWED`, `UNKNOWN` - `multiple_birth` (integer, optional) — The number of siblings the patient was born with. Leave unset if the patient was not part of a multiple birth. - `non_insurance_payer_associations` (list of CanonicalNonInsurancePayerAssociation, optional) - `note_ids` (list of string, optional) - `orcon` (boolean, optional) — ORCON (Originator Controlled) - When set to true, the Candid system will hide this patient from downstream integrations. Updates made in the Candid UI will unset this flag. Defaults to false. - `origination_detail` (OriginationDetail, optional) — Information about the patient source, if applicable. - `other_identifiers` (list of ExternalIdentifier, optional) — Other identifiers for the patient. - `photo` (string, optional) - `primary_service_facility_id` (string, optional) - `primary_telecom` (ContactPoint, optional) — The primary phone number for the patient. - `pronouns` (list of string, optional) — The pronouns of the patient. - `race` (enum, optional) - Allowed values: `AMERICAN_INDIAN_OR_ALASKA_NATIVE`, `WHITE`, `BLACK`, `ASIAN`, `NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER`, `MIDDLE_EASTERN_OR_NORTH_AFRICAN`, `OTHER`, `UNKNOWN`, `REFUSED` - `referrals` (list of Referral, optional) - `self_pay` (boolean, optional) - `service_facilities` (list of PatientServiceFacility, optional) — Associated service facilities for this patient. - `sexual_orientation` (enum, optional) — The sexual orientation of the patient. - Allowed values: `HETEROSEXUAL`, `HOMOSEXUAL`, `BISEXUAL`, `TWO_SPIRIT`, `OTHER`, `UNKNOWN`, `REFUSED` - `social_security_number` (string, optional) - `tag_ids` (list of string, optional) - `electronic_communication_opt_in` (boolean, optional, deprecated) — Use electronic_communication_consent for granular channel-level consent. This field is kept in sync automatically but should not be used for new integrations. - `non_insurance_payers` (list of string, optional, deprecated) ### MutableCoverage - `status` (enum, required) — The status indiciating if the coverage is active or not. - Allowed values: `ACTIVE`, `CANCELLED`, `DRAFT`, `ENTERED_IN_ERROR` - `subscriber` (Subscriber, required) — The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due. - `relationship` (enum, required) — The relationship of beneficiary (patient) to the subscriber. https://hl7.org/fhir/valueset-relationship.html - Allowed values: `SELF`, `SPOUSE`, `CHILD`, `COMMON_LAW_SPOUSE`, `OTHER` - `patient` (string, required) — The canonical Candid patient UUID corresponding with the patient who benefits from the insurance coverage - `insurance_plan` (InsurancePlan, required) - `verified` (boolean, required) — A boolean indicating if the coverage has been verified by a user. - `eligibility_checks` (list of EligibilityCheckMetadata, optional) — A list of eligibility check metadata that have been initiated on this coverage. - `latest_eligibility_check` (LatestEligibilityCheck, optional) — The latest eligibility check metadata that has been initiated on this coverage. - `benefits` (CoverageBenefits, optional) — The eligibility of the patient for the coverage, manually verified by users. - `orcon` (boolean, optional) — ORCON (Originator Controlled) - When set to true, the Candid system will hide this coverage from downstream integrations. Updates made in the Candid UI will unset this flag. Defaults to false. - `auto_update_enabled` (boolean, optional) — Default to true. When set to true, the Candid system will automatically update this coverage with the latest eligibility check benefits information. Auto update behavior is also set at the eligibilityConfig org level configuration. - `previous_appointment_copays` (map from enum to integer, optional) — A map of UniversalServiceIdentifier (MD_Visit, Treatment, Tests, Activity) to copay values in cents. This is used to track copay values for each service type to handle OOP max resets correctly. ### MutableAppointment An object representing a appointment. - `patient_id` (string, required) — The Candid-defined patient identifier. - `start_timestamp` (datetime, required) - `service_duration` (integer, required) — The requested length of time allotted for the appointment. The units are in minutes. - `services` (list of Service, required) - `status` (enum, optional) — Defaults to PENDING. If status is NOT_READY, work_queue must be set. If status is READY, CHECKED_OUT, or NO_SHOW, work_queue must be null. checked_in_timestamp must be set if and only if status is CHECKED_IN or CHECKED_OUT, and checked_out_timestamp must be set if and only if status is CHECKED_OUT. - Allowed values: `PENDING`, `NOT_READY`, `READY`, `CHECKED_IN`, `CHECKED_OUT`, `NO_SHOW` - `not_ready_reason` (enum, optional) — The reason the appointment is NOT_READY. Must only be set when status is NOT_READY; it is cleared otherwise. It is not recommended to change this value manually via API. - Allowed values: `INACTIVE_PRIMARY`, `INACTIVE_SECONDARY`, `MEDICARE_ADVANTAGE_CONVERSION`, `MEDICAID_MANAGED_CONVERSION`, `UNAVAILABLE_PRIMARY`, `UNAVAILABLE_SECONDARY`, `PENDING_PRIMARY`, `PENDING_SECONDARY`, `ELIGIBILITY_CHECK_FAILED_PRIMARY`, `ELIGIBILITY_CHECK_FAILED_SECONDARY`, `NEW_COMBO`, `NEW_INSURANCE`, `PRIOR_APPOINTMENT_NOT_READY`, `NO_COVERAGE`, `ERROR`, `MANUAL` - `ready_source` (enum, optional) — The method that set the appointment status to READY. It is not recommended to change this value manually via API. Must only be set when the status is READY, CHECKED_IN, CHECKED_OUT or NO_SHOW, it is cleared otherwise. - Allowed values: `MANUAL`, `MACHINE` - `placer_appointment_id` (string, optional) — ID for the appointment/order for the event. - `placer_system_name` (string, optional) — The name of the upstream system that placed this appointment. - `attending_doctor` (ExternalProvider, optional) — Attending physician information. The attending physician will be stored as the Current MD for the patient. - `estimated_copay_cents` (integer, optional) - `estimated_patient_responsibility_cents` (integer, optional) — The estimated amount the patient will be responsible for paying at the time of service. This does not include the copay. - `patient_deposit_cents` (integer, optional) - `appointment_details` (string, optional) - `checked_in_timestamp` (datetime, optional) — The timestamp when the patient checked in for their appointment. Must be set when status is CHECKED_IN or CHECKED_OUT, and must be unset otherwise. - `checked_out_timestamp` (datetime, optional) — The timestamp when the patient checked out of their appointment. Must be set when status is CHECKED_OUT, and must be unset otherwise. - `appointment_reason_detail` (AppointmentReasonDetail, optional) — The clinical context for the appointment. - `medical_necessity_verified` (boolean, optional) — True if medical necessity for this appointment has been verified. - `prior_authorization_status` (enum, optional) — The prior authorization status for this appointment. - Allowed values: `NOT_REQUIRED`, `REQUIRED`, `PENDING`, `APPROVED`, `PARTIALLY_APPROVED`, `DENIED`, `EXPIRED` - `notes` (string, optional) - `location_resource_id` (string, optional) — Contains the coded identification of the location being scheduled. Components: \^\ - `automated_eligibility_check_complete` (boolean, optional) — True if the automated eligibility check has been completed. It is not recommended to change this value manually via API. This refers explicitly to the automated eligibility check that occurs a specific number of days before the appointment. - `work_queue` (enum, optional) — The work queue that the appointment belongs to. It is not recommended to change this value manually via API. If status is NOT_READY, work_queue must be set. If status is READY, CHECKED_OUT or NO_SHOW, work_queue must be null. - Allowed values: `EMERGENT_ISSUE`, `NEW_PATIENT`, `RETURNING_PATIENT`, `MANUAL_ESCALATION` - `cancellation_reason` (string, optional) — The reason the appointment was cancelled. This value cannot be set on create or update; it is only set by the deactivate endpoint, and is cleared if the appointment is reactivated. ### Contact - `relationship` (list of enum, required) - Allowed values: `SELF`, `SPOUSE`, `CHILD`, `COMMON_LAW_SPOUSE`, `OTHER` - `name` (HumanName, required) - `telecoms` (list of ContactPoint, required) - `addresses` (list of Address, required) - `period` (Period, optional) - `hipaa_authorization` (boolean, optional) ### FilingOrder The patient's active coverages, in order of primary, secondary, etc. - `coverages` (list of UUID, required) ### ExternalProvider - `name` (HumanName, required) - `telecoms` (list of ContactPoint, required) - `type` (enum, optional) — Defaults to ATTENDING. - Allowed values: `PRIMARY`, `REFERRING`, `ATTENDING` - `npi` (string, optional) - `addresses` (list of Address, optional) - `period` (Period, optional) - `canonical_id` (string, optional) — The unique identifier for a provider configured in the Candid system - `fax` (string, optional) - `other_fax_numbers` (list of string, optional) - `emails` (list of string, optional) - `service_facilities` (list of PatientServiceFacility, optional) — Associated service facilities for this provider. ### HumanName - `family` (string, required) - `given` (list of string, required) - `use` (enum, required) - Allowed values: `USUAL`, `OFFICIAL`, `TEMP`, `NICKNAME`, `ANONYMOUS`, `OLD`, `MAIDEN` - `period` (Period, optional) - `suffix` (string, optional) ### Address - `use` (enum, required) - Allowed values: `HOME`, `WORK`, `TEMP`, `OLD`, `BILLING` - `line` (list of string, required) - `city` (string, required) - `state` (string, required) - `postal_code` (string, required) - `country` (string, required) - `administrative_area` (string, optional) — The top-level administrative subdivision of the country for addresses outside the US — for example a Canadian province, a UK county, or a Japanese prefecture. Only permitted on international addresses: `country` must be present and non-US, and `state` must be "FC" (the X12 foreign-country sentinel). For US addresses use `state` instead. - `county` (string, optional) - `period` (Period, optional) ### ContactPoint - `value` (string, required) - `use` (enum, required) - Allowed values: `HOME`, `WORK`, `TEMP`, `OLD`, `MOBILE` - `period` (Period, optional) ### Authorization - `payer_id` (string, required) — The unique identifier for a Payer in the database - `payer_name` (string, required) - `authorization_number` (string, required) - `cpt_code` (string, required) - `units` (enum, required) - Allowed values: `VISIT`, `UNIT` - `additional_payer_information` (AdditionalPayerInformation, optional) - `apply_for_all_cpt_codes` (boolean, optional) — If true, then the authorization will apply for all claims for the payer that fall in range the `period`. - `no_prior_authorization_required` (boolean, optional) — If true, indicates that prior authorization is not required and prior authorization number will not be set on the claim for this authorization. - `quantity` (integer, optional) - `period` (Period, optional) - `notes` (string, optional) - `billing_provider_npi` (string, optional) — The NPI of the billing provider for which this authorization applies. - `service_facility` (PatientServiceFacility, optional) — When set, specifies the service facility for which this authorization applies. - `dx_codes` (list of string, optional) — When set, the authorization will only apply when at least one of these diagnosis codes is found on the claim/service lines (in addition to other criteria). ### CoveragesForRelatedCauses Additional coverages for the patient applicable to related causes such as Auto or Workers Comp - `coverages` (list of UUID, required) ### CustomMetadataEntry A set of custom key/value pairs validated against a single MetadataSchema. - `metadata_schema_id` (UUID, required) — The unique identifier for a custom MetadataSchema. - `key_value_pairs` (map from string to any, required) — The custom values. Each key must be a field defined on the referenced MetadataSchema and each value must match that field's declared type. ### ElectronicCommunicationConsent Granular consent for electronic communication channels. - `text_communication_consent` (boolean, optional) — Consent for text/SMS communication. - `email_communication_consent` (boolean, optional) — Consent for email communication. ### ExternalProvenance Information about the upstream system that owns this patient data. - `external_id` (string, required) - `system_name` (string, required) ### Guarantor - `name` (HumanName, required) - `address` (Address, required) - `telecom` (ContactPoint, optional) - `email` (string, optional) - `birth_date` (date, optional) ### InferredPatientMetadata - `inferred_encounter_id` (string, required) - `inferred_encounter_latest_date_of_service` (date, required) ### CanonicalNonInsurancePayerAssociation - `id` (string, required) — The unique identifier for a non-insurance payer configured in the Candid system - `member_id` (string, optional) - `period` (Period, optional) - `clinical_trial_info` (list of CanonicalClinicalTrialAssociation, optional) — A patient cannot be associated with a given trial more than once ### OriginationDetail - `referral_source` (enum, required) - Allowed values: `HOSPITAL`, `REFERRING_MD`, `SELF`, `OTHER` - `referring_provider` (ExternalProvider, optional) - `specialization_categories` (list of enum, optional) - Allowed values: `BEHAVIORAL_HEALTH_THERAPY`, `CARDIOLOGY`, `DERMATOLOGY`, `ENDOCRINOLOGY`, `ENT`, `GASTROENTEROLOGY`, `GENERAL_SURGERY`, `GENETICS`, `HEMATOLOGY`, `INFECTIOUS_DISEASE`, `NEUROLOGY`, `NUTRITIONAL_THERAPY`, `OB_GYN`, `ONCOLOGY`, `OPHTHALMOLOGY`, `ORTHOPEDICS`, `PAIN_MANAGEMENT`, `PEDIATRICS`, `PHYSICAL_THERAPY`, `PODIATRY`, `PRIMARY_CARE`, `PSYCHIATRY`, `PULMONOLOGY`, `RADIOLOGY`, `RHEUMATOLOGY`, `SCREENING`, `UROLOGY`, `OTHER` - `referral_type` (enum, optional) - Allowed values: `DIRECTED`, `ROTATION`, `OVERNIGHT` ### ExternalIdentifier An external identifier for a patient - `value` (string, required) - `system` (string, required) - `period` (Period, optional) ### Referral - `provider` (ExternalProvider, required) - `referral_number` (string, required) - `period` (Period, optional) - `notes` (string, optional) - `serviceFacility` (PatientServiceFacility, optional) — Represents a canonical service facility attached to a patient or patient dependent object - `units` (enum, optional) - Allowed values: `VISIT`, `UNIT` - `quantity` (integer, optional) - `cptCodes` (list of string, optional) - `applyForAllCptCodes` (boolean, optional) ### PatientServiceFacility Represents a canonical service facility attached to a patient or patient dependent object - `service_facility_id` (string, required) — The unique identifier for a service facility configured in the Candid system ### Subscriber - `name` (HumanName, required) - `biological_sex` (enum, required) - Allowed values: `FEMALE`, `MALE`, `UNKNOWN`, `REFUSED` - `date_of_birth` (date, optional) - `address` (Address, optional) - `employer_name` (string, optional) ### InsurancePlan - `member_id` (string, required) - `payer_id` (string, required) — The unique identifier for a Payer in the database - `payer_name` (string, required) - `additional_payer_information` (AdditionalPayerInformation, optional) - `group_number` (string, optional) - `name` (string, optional) - `plan_type` (enum, optional) - Allowed values: `09`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, `AM`, `BL`, `CH`, `CI`, `DS`, `FI`, `HM`, `LM`, `MA`, `MB`, `MC`, `OF`, `TV`, `VA`, `WC`, `ZZ` - `type` (enum, optional) — Code identifying the type of insurance policy within a specific insurance program (X12 008020 Element 1336) - Allowed values: `01`, `12`, `13`, `14`, `15`, `16`, `17`, `18`, `19`, `41`, `42`, `43`, `47`, `AP`, `C1`, `CO`, `CP`, `D`, `DB`, `E`, `EP`, `FF`, `GP`, `HA`, `HB`, `HD`, `HG`, `HM`, `HN`, `HP`, `HS`, `IN`, `IP`, `LC`, `LD`, `LI`, `LT`, `M`, `MA`, `MB`, `MC`, `MD`, `ME`, `MF`, `MH`, `MI`, `MJ`, `MK`, `ML`, `MM`, `MN`, `MO`, `MP`, `MR`, `MT`, `MV`, `OA`, `OT`, `PE`, `PL`, `PP`, `PR`, `PS`, `QM`, `RP`, `SP`, `TF`, `U`, `WC`, `WU` - `period` (Period, optional) - `insurance_card_image_locator` (string, optional) - `address` (Address, optional) - `payer_plan_group_id` (UUID, optional) — The ID of the Candid configured payer plan group associated with this coverage - `carve_outs` (list of CoverageCarveOut, optional) ### EligibilityCheckMetadata - `check_id` (string, required) - `service_code` (enum, required) — Code identifying the type of service or benefit within a specific insurance policy (X12 008010 Element 1365) - Allowed values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, `18`, `19`, `20`, `21`, `22`, `23`, `24`, `25`, `26`, `27`, `28`, `30`, `32`, `33`, `34`, `35`, `36`, `37`, `38`, `39`, `40`, `41`, `42`, `43`, `44`, `45`, `46`, `47`, `48`, `49`, `50`, `51`, `52`, `53`, `54`, `55`, `56`, `57`, `58`, `59`, `60`, `61`, `62`, `63`, `64`, `65`, `66`, `67`, `68`, `69`, `70`, `71`, `72`, `73`, `74`, `75`, `76`, `77`, `78`, `79`, `80`, `81`, `82`, `83`, `84`, `85`, `86`, `87`, `88`, `89`, `90`, `91`, `92`, `93`, `94`, `95`, `96`, `97`, `98`, `99`, `A0`, `A1`, `A2`, `A3`, `A4`, `A5`, `A6`, `A7`, `A8`, `A9`, `AA`, `AB`, `AC`, `AD`, `AE`, `AF`, `AG`, `AH`, `AI`, `AJ`, `AK`, `AL`, `AM`, `AN`, `AO`, `AQ`, `AR`, `B1`, `B2`, `B3`, `BA`, `BB`, `BC`, `BD`, `BE`, `BF`, `BG`, `BH`, `BI`, `BJ`, `BK`, `BL`, `BM`, `BN`, `BP`, `BQ`, `BR`, `BS`, `BT`, `BU`, `BV`, `BW`, `BX`, `BY`, `BZ`, `C1`, `CA`, `CB`, `CC`, `CD`, `CE`, `CF`, `CG`, `CH`, `CI`, `CJ`, `CK`, `CL`, `CM`, `CN`, `CO`, `CP`, `CQ`, `DG`, `DM`, `DS`, `GF`, `GN`, `GY`, `IC`, `MH`, `NI`, `ON`, `PT`, `PU`, `RN`, `RT`, `TC`, `TN`, `UC` - `status` (enum, required) — enum to represent the status of an eligibility checks - Allowed values: `COMPLETED`, `FAILED`, `PENDING` - `initiated_by` (string, required) — The unique identifier for a User in the database - `initiated_at` (datetime, required) ### LatestEligibilityCheck A type to represent the latest eligibility check status of a coverage. - `check_id` (string, required) - `status` (enum, required) — enum to represent the status of a patient's coverage - Allowed values: `ACTIVE`, `INACTIVE`, `UNKNOWN` - `initiated_at` (datetime, required) - `errors` (list of EligibilityCheckErrorDetails, optional) - `request_corrections` (list of RequestCorrection, optional) — Fields where the payer's 271 response disagreed with what we sent on the request, surfaced from the check so consumers can detect that the eligibility response contradicted the coverage on file. Empty when the payer echoed everything we sent. - `trading_partner` (string, optional) — The payer's own identifier as returned on the Stedi eligibility response (271) `tradingPartnerServiceId`, surfaced from the latest check's plan metadata so it is readable off the coverage. Can differ from the ID we submitted. ### CoverageBenefits - `plan_coverage` (PlanCoverage, optional) - `service_specific_coverage` (list of ServiceCoverage, optional) - `benefits_related_entities` (list of BenefitsRelatedEntity, optional) - `non_covered_details` (list of NonCoveredDetail, optional) - `notes` (string, optional) - `autoUpdatedEligibilityCheckId` (string, optional) ### Service - `universal_service_identifier` (enum, optional) — Contains the code describing the activity type that is being scheduled. - Allowed values: `MD_Visit`, `Treatment`, `Tests`, `Activity` - `start_timestamp` (datetime, optional) ### AppointmentReasonDetail The clinical context for the appointment. - `diagnosis_codes` (list of string, optional) - `procedure_codes` (list of string, optional) ### Period - `start` (date, optional) - `end` (date, optional) ### AdditionalPayerInformation - `availity_eligibility_id` (string, optional) - `availity_payer_id` (string, optional) - `availity_payer_name` (string, optional) - `availity_remittance_payer_id` (string, optional) ### CanonicalClinicalTrialAssociation - `id` (string, required) — The unique identifier for a clinical trial configured in the Candid system - `clinical_trial_arm` (string, optional) - `period` (Period, optional) ### CoverageCarveOut - `carve_out` (enum, required) - Allowed values: `BEHAVIORAL`, `MEDICAL`, `THERAPY`, `OTHER` - `member_id` (string, required) - `payer_id` (string, required) — The unique identifier for a Payer in the database - `payer_name` (string, required) - `group_number` (string, optional) - `plan_type` (enum, optional) - Allowed values: `09`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, `AM`, `BL`, `CH`, `CI`, `DS`, `FI`, `HM`, `LM`, `MA`, `MB`, `MC`, `OF`, `TV`, `VA`, `WC`, `ZZ` - `type` (enum, optional) — Code identifying the type of insurance policy within a specific insurance program (X12 008020 Element 1336) - Allowed values: `01`, `12`, `13`, `14`, `15`, `16`, `17`, `18`, `19`, `41`, `42`, `43`, `47`, `AP`, `C1`, `CO`, `CP`, `D`, `DB`, `E`, `EP`, `FF`, `GP`, `HA`, `HB`, `HD`, `HG`, `HM`, `HN`, `HP`, `HS`, `IN`, `IP`, `LC`, `LD`, `LI`, `LT`, `M`, `MA`, `MB`, `MC`, `MD`, `ME`, `MF`, `MH`, `MI`, `MJ`, `MK`, `ML`, `MM`, `MN`, `MO`, `MP`, `MR`, `MT`, `MV`, `OA`, `OT`, `PE`, `PL`, `PP`, `PR`, `PS`, `QM`, `RP`, `SP`, `TF`, `U`, `WC`, `WU` - `payer_plan_group_id` (UUID, optional) — The ID of the Candid configured payer plan group associated with this coverage ### EligibilityCheckErrorDetails This object is our fern representation of Stedi's EligbilityCheckError object from their API. - `field?` (string, optional) - `description?` (string, optional) - `location?` (string, optional) - `possibleResolutions?` (string, optional) - `code?` (string, optional) - `followupAction?` (string, optional) ### RequestCorrection - `property` (string, required) - `request_value` (string, required) - `corrected_value` (string, required) ### PlanCoverage - `in_network` (PlanCoverageDetails, optional) - `in_network_flat` (list of CoverageDetails, optional) - `out_of_network` (PlanCoverageDetails, optional) - `out_of_network_flat` (list of CoverageDetails, optional) ### ServiceCoverage - `service_code` (enum, required) — Code identifying the type of service or benefit within a specific insurance policy (X12 008010 Element 1365) - Allowed values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, `18`, `19`, `20`, `21`, `22`, `23`, `24`, `25`, `26`, `27`, `28`, `30`, `32`, `33`, `34`, `35`, `36`, `37`, `38`, `39`, `40`, `41`, `42`, `43`, `44`, `45`, `46`, `47`, `48`, `49`, `50`, `51`, `52`, `53`, `54`, `55`, `56`, `57`, `58`, `59`, `60`, `61`, `62`, `63`, `64`, `65`, `66`, `67`, `68`, `69`, `70`, `71`, `72`, `73`, `74`, `75`, `76`, `77`, `78`, `79`, `80`, `81`, `82`, `83`, `84`, `85`, `86`, `87`, `88`, `89`, `90`, `91`, `92`, `93`, `94`, `95`, `96`, `97`, `98`, `99`, `A0`, `A1`, `A2`, `A3`, `A4`, `A5`, `A6`, `A7`, `A8`, `A9`, `AA`, `AB`, `AC`, `AD`, `AE`, `AF`, `AG`, `AH`, `AI`, `AJ`, `AK`, `AL`, `AM`, `AN`, `AO`, `AQ`, `AR`, `B1`, `B2`, `B3`, `BA`, `BB`, `BC`, `BD`, `BE`, `BF`, `BG`, `BH`, `BI`, `BJ`, `BK`, `BL`, `BM`, `BN`, `BP`, `BQ`, `BR`, `BS`, `BT`, `BU`, `BV`, `BW`, `BX`, `BY`, `BZ`, `C1`, `CA`, `CB`, `CC`, `CD`, `CE`, `CF`, `CG`, `CH`, `CI`, `CJ`, `CK`, `CL`, `CM`, `CN`, `CO`, `CP`, `CQ`, `DG`, `DM`, `DS`, `GF`, `GN`, `GY`, `IC`, `MH`, `NI`, `ON`, `PT`, `PU`, `RN`, `RT`, `TC`, `TN`, `UC` - `in_network` (ServiceCoverageDetails, optional) - `in_network_flat` (list of CoverageDetails, optional) - `out_of_network` (ServiceCoverageDetails, optional) - `out_of_network_flat` (list of CoverageDetails, optional) ### BenefitsRelatedEntity - `entityIdentifier` (string, optional) - `entityType` (string, optional) - `entityName` (string, optional) - `contactInformation` (list of RelatedEntityContact, optional) - `serviceTypeCodes` (list of enum, optional) - Allowed values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, `18`, `19`, `20`, `21`, `22`, `23`, `24`, `25`, `26`, `27`, `28`, `30`, `32`, `33`, `34`, `35`, `36`, `37`, `38`, `39`, `40`, `41`, `42`, `43`, `44`, `45`, `46`, `47`, `48`, `49`, `50`, `51`, `52`, `53`, `54`, `55`, `56`, `57`, `58`, `59`, `60`, `61`, `62`, `63`, `64`, `65`, `66`, `67`, `68`, `69`, `70`, `71`, `72`, `73`, `74`, `75`, `76`, `77`, `78`, `79`, `80`, `81`, `82`, `83`, `84`, `85`, `86`, `87`, `88`, `89`, `90`, `91`, `92`, `93`, `94`, `95`, `96`, `97`, `98`, `99`, `A0`, `A1`, `A2`, `A3`, `A4`, `A5`, `A6`, `A7`, `A8`, `A9`, `AA`, `AB`, `AC`, `AD`, `AE`, `AF`, `AG`, `AH`, `AI`, `AJ`, `AK`, `AL`, `AM`, `AN`, `AO`, `AQ`, `AR`, `B1`, `B2`, `B3`, `BA`, `BB`, `BC`, `BD`, `BE`, `BF`, `BG`, `BH`, `BI`, `BJ`, `BK`, `BL`, `BM`, `BN`, `BP`, `BQ`, `BR`, `BS`, `BT`, `BU`, `BV`, `BW`, `BX`, `BY`, `BZ`, `C1`, `CA`, `CB`, `CC`, `CD`, `CE`, `CF`, `CG`, `CH`, `CI`, `CJ`, `CK`, `CL`, `CM`, `CN`, `CO`, `CP`, `CQ`, `DG`, `DM`, `DS`, `GF`, `GN`, `GY`, `IC`, `MH`, `NI`, `ON`, `PT`, `PU`, `RN`, `RT`, `TC`, `TN`, `UC` ### NonCoveredDetail - `type` (enum, required) - Allowed values: `DEDUCTIBLE`, `DEDUCTIBLE_CONTRACT`, `DEDUCTIBLE_REMAINING`, `DEDUCTIBLE_YEAR_TO_DATE`, `OOP_MAX`, `OOP_MAX_CONTRACT`, `OOP_MAX_REMAINING`, `OOP_MAX_YEAR_TO_DATE`, `COPAY`, `COINSURANCE`, `NON_COVERED`, `LIMITATION` - `coverageLevel` (enum, required) - Allowed values: `EMPLOYEE_AND_CHILDREN`, `EMPLOYEE_ONLY`, `EMPLOYEE_AND_SPOUSE`, `FAMILY`, `INDIVIDUAL` - `unit` (enum, required) - Allowed values: `PERCENT`, `CURRENCY`, `COUNT` - `value` (double, required) - `additional_notes` (string, optional) - `service_type_codes` (list of enum, optional) - Allowed values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, `18`, `19`, `20`, `21`, `22`, `23`, `24`, `25`, `26`, `27`, `28`, `30`, `32`, `33`, `34`, `35`, `36`, `37`, `38`, `39`, `40`, `41`, `42`, `43`, `44`, `45`, `46`, `47`, `48`, `49`, `50`, `51`, `52`, `53`, `54`, `55`, `56`, `57`, `58`, `59`, `60`, `61`, `62`, `63`, `64`, `65`, `66`, `67`, `68`, `69`, `70`, `71`, `72`, `73`, `74`, `75`, `76`, `77`, `78`, `79`, `80`, `81`, `82`, `83`, `84`, `85`, `86`, `87`, `88`, `89`, `90`, `91`, `92`, `93`, `94`, `95`, `96`, `97`, `98`, `99`, `A0`, `A1`, `A2`, `A3`, `A4`, `A5`, `A6`, `A7`, `A8`, `A9`, `AA`, `AB`, `AC`, `AD`, `AE`, `AF`, `AG`, `AH`, `AI`, `AJ`, `AK`, `AL`, `AM`, `AN`, `AO`, `AQ`, `AR`, `B1`, `B2`, `B3`, `BA`, `BB`, `BC`, `BD`, `BE`, `BF`, `BG`, `BH`, `BI`, `BJ`, `BK`, `BL`, `BM`, `BN`, `BP`, `BQ`, `BR`, `BS`, `BT`, `BU`, `BV`, `BW`, `BX`, `BY`, `BZ`, `C1`, `CA`, `CB`, `CC`, `CD`, `CE`, `CF`, `CG`, `CH`, `CI`, `CJ`, `CK`, `CL`, `CM`, `CN`, `CO`, `CP`, `CQ`, `DG`, `DM`, `DS`, `GF`, `GN`, `GY`, `IC`, `MH`, `NI`, `ON`, `PT`, `PU`, `RN`, `RT`, `TC`, `TN`, `UC` ### PlanCoverageDetails - `deductible` (CoverageValue, optional) - `deductible_contract` (CoverageValue, optional) - `deductible_remaining` (CoverageValue, optional) - `deductible_year_to_date` (CoverageValue, optional) - `oop_max` (CoverageValue, optional) - `oop_max_contract` (CoverageValue, optional) - `oop_max_remaining` (CoverageValue, optional) - `oop_max_year_to_date` (CoverageValue, optional) - `additional_notes` (string, optional) ### CoverageDetails - `type` (enum, required) - Allowed values: `DEDUCTIBLE`, `DEDUCTIBLE_CONTRACT`, `DEDUCTIBLE_REMAINING`, `DEDUCTIBLE_YEAR_TO_DATE`, `OOP_MAX`, `OOP_MAX_CONTRACT`, `OOP_MAX_REMAINING`, `OOP_MAX_YEAR_TO_DATE`, `COPAY`, `COINSURANCE`, `NON_COVERED`, `LIMITATION` - `coverageLevel` (enum, required) - Allowed values: `EMPLOYEE_AND_CHILDREN`, `EMPLOYEE_ONLY`, `EMPLOYEE_AND_SPOUSE`, `FAMILY`, `INDIVIDUAL` - `unit` (enum, required) - Allowed values: `PERCENT`, `CURRENCY`, `COUNT` - `value` (double, required) - `additional_notes` (string, optional) ### ServiceCoverageDetails - `copay` (CoverageValue, optional) - `coinsurance` (CoverageValue, optional) - `visits` (CoverageValue, optional) - `visits_remaining` (CoverageValue, optional) - `additional_notes` (string, optional) ### RelatedEntityContact - `mode` (string, optional) - `value` (string, optional) ### CoverageValue - `family` (double, optional) - `individual` (double, optional) - `employeeAndSpouse` (double, optional) - `employeeAndChildren` (double, optional) ## Examples **Response** ```json { "items": [ { "patient": { "biological_sex": "FEMALE", "birth_date": "2023-01-15", "contacts": [ { "relationship": [ "SELF", "SELF" ], "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, "telecoms": [ { "value": "value", "use": "HOME", "period": {} }, { "value": "value", "use": "HOME", "period": {} } ], "addresses": [ { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} } ], "period": { "start": "2023-01-15", "end": "2023-01-15" }, "hipaa_authorization": true }, { "relationship": [ "SELF", "SELF" ], "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, "telecoms": [ { "value": "value", "use": "HOME", "period": {} }, { "value": "value", "use": "HOME", "period": {} } ], "addresses": [ { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} } ], "period": { "start": "2023-01-15", "end": "2023-01-15" }, "hipaa_authorization": true } ], "deactivated": true, "filing_order": { "coverages": [ "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" ] }, "general_practitioners": [ { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, "telecoms": [ { "value": "value", "use": "HOME", "period": {} }, { "value": "value", "use": "HOME", "period": {} } ], "type": "PRIMARY", "npi": "npi", "addresses": [ { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} } ], "period": { "start": "2023-01-15", "end": "2023-01-15" }, "canonical_id": "canonical_id", "fax": "fax", "other_fax_numbers": [ "other_fax_numbers", "other_fax_numbers" ], "emails": [ "emails", "emails" ], "service_facilities": [ { "service_facility_id": "service_facility_id" }, { "service_facility_id": "service_facility_id" } ] }, { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, "telecoms": [ { "value": "value", "use": "HOME", "period": {} }, { "value": "value", "use": "HOME", "period": {} } ], "type": "PRIMARY", "npi": "npi", "addresses": [ { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} } ], "period": { "start": "2023-01-15", "end": "2023-01-15" }, "canonical_id": "canonical_id", "fax": "fax", "other_fax_numbers": [ "other_fax_numbers", "other_fax_numbers" ], "emails": [ "emails", "emails" ], "service_facilities": [ { "service_facility_id": "service_facility_id" }, { "service_facility_id": "service_facility_id" } ] } ], "id": "id", "mrn": "mrn", "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, "organization_id": "organization_id", "other_addresses": [ { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": { "start": "2023-01-15", "end": "2023-01-15" } }, { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": { "start": "2023-01-15", "end": "2023-01-15" } } ], "other_names": [ { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" } ], "other_telecoms": [ { "value": "value", "use": "HOME", "period": { "start": "2023-01-15", "end": "2023-01-15" } }, { "value": "value", "use": "HOME", "period": { "start": "2023-01-15", "end": "2023-01-15" } } ], "primary_address": { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": { "start": "2023-01-15", "end": "2023-01-15" } }, "updated_at": "2024-01-15T09:30:00Z", "updating_user_id": "updating_user_id", "version": 1, "advanced_directives": [ "NONE", "NONE" ], "authorizations": [ { "payer_id": "payer_id", "payer_name": "payer_name", "authorization_number": "authorization_number", "cpt_code": "cpt_code", "units": "VISIT", "additional_payer_information": { "availity_eligibility_id": "availity_eligibility_id", "availity_payer_id": "availity_payer_id", "availity_payer_name": "availity_payer_name", "availity_remittance_payer_id": "availity_remittance_payer_id" }, "apply_for_all_cpt_codes": true, "no_prior_authorization_required": true, "quantity": 1, "period": { "start": "2023-01-15", "end": "2023-01-15" }, "notes": "notes", "billing_provider_npi": "billing_provider_npi", "service_facility": { "service_facility_id": "service_facility_id" }, "dx_codes": [ "dx_codes", "dx_codes" ] }, { "payer_id": "payer_id", "payer_name": "payer_name", "authorization_number": "authorization_number", "cpt_code": "cpt_code", "units": "VISIT", "additional_payer_information": { "availity_eligibility_id": "availity_eligibility_id", "availity_payer_id": "availity_payer_id", "availity_payer_name": "availity_payer_name", "availity_remittance_payer_id": "availity_remittance_payer_id" }, "apply_for_all_cpt_codes": true, "no_prior_authorization_required": true, "quantity": 1, "period": { "start": "2023-01-15", "end": "2023-01-15" }, "notes": "notes", "billing_provider_npi": "billing_provider_npi", "service_facility": { "service_facility_id": "service_facility_id" }, "dx_codes": [ "dx_codes", "dx_codes" ] } ], "coverages_for_related_causes": { "coverages": [ "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" ] }, "custom_metadata": [ { "metadata_schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "key_value_pairs": { "key_value_pairs": { "key": "value" } } }, { "metadata_schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "key_value_pairs": { "key_value_pairs": { "key": "value" } } } ], "deceased": "2024-01-15T09:30:00Z", "disability_status": "DISABLED", "do_not_invoice_reason": "BANKRUPTCY", "electronic_communication_consent": { "text_communication_consent": true, "email_communication_consent": true }, "email": "email", "ethnicity": "HISPANIC_OR_LATINO", "external_provenance": { "external_id": "external_id", "system_name": "system_name" }, "gender": "MAN", "guarantor": { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, "address": { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": { "start": "2023-01-15", "end": "2023-01-15" } }, "telecom": { "value": "value", "use": "HOME", "period": {} }, "email": "email", "birth_date": "2023-01-15" }, "hipaa_code": "hipaa_code", "inferred_patient_metadata": { "inferred_encounter_id": "inferred_encounter_id", "inferred_encounter_latest_date_of_service": "2023-01-15" }, "language": "language", "marital_status": "ANNULLED", "multiple_birth": 1, "non_insurance_payer_associations": [ { "id": "id", "member_id": "member_id", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "clinical_trial_info": [ { "id": "id" }, { "id": "id" } ] }, { "id": "id", "member_id": "member_id", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "clinical_trial_info": [ { "id": "id" }, { "id": "id" } ] } ], "note_ids": [ "note_ids", "note_ids" ], "orcon": true, "origination_detail": { "referral_source": "HOSPITAL", "referring_provider": { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": {}, "suffix": "suffix" }, "telecoms": [ { "value": "value", "use": "HOME" }, { "value": "value", "use": "HOME" } ], "type": "PRIMARY", "npi": "npi", "addresses": [], "period": {}, "canonical_id": "canonical_id", "fax": "fax", "other_fax_numbers": [ "other_fax_numbers", "other_fax_numbers" ], "emails": [ "emails", "emails" ], "service_facilities": [] }, "specialization_categories": [ "BEHAVIORAL_HEALTH_THERAPY", "BEHAVIORAL_HEALTH_THERAPY" ], "referral_type": "DIRECTED" }, "other_identifiers": [ { "value": "value", "system": "system", "period": { "start": "2023-01-15", "end": "2023-01-15" } }, { "value": "value", "system": "system", "period": { "start": "2023-01-15", "end": "2023-01-15" } } ], "photo": "photo", "primary_service_facility_id": "primary_service_facility_id", "primary_telecom": { "value": "value", "use": "HOME", "period": { "start": "2023-01-15", "end": "2023-01-15" } }, "pronouns": [ "pronouns", "pronouns" ], "race": "AMERICAN_INDIAN_OR_ALASKA_NATIVE", "referrals": [ { "provider": { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": {}, "suffix": "suffix" }, "telecoms": [ { "value": "value", "use": "HOME" }, { "value": "value", "use": "HOME" } ], "type": "PRIMARY", "npi": "npi", "addresses": [], "period": {}, "canonical_id": "canonical_id", "fax": "fax", "other_fax_numbers": [ "other_fax_numbers", "other_fax_numbers" ], "emails": [ "emails", "emails" ], "service_facilities": [] }, "referral_number": "referral_number", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "notes": "notes", "serviceFacility": { "service_facility_id": "service_facility_id" }, "units": "VISIT", "quantity": 1, "cptCodes": [ "cptCodes", "cptCodes" ], "applyForAllCptCodes": true }, { "provider": { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": {}, "suffix": "suffix" }, "telecoms": [ { "value": "value", "use": "HOME" }, { "value": "value", "use": "HOME" } ], "type": "PRIMARY", "npi": "npi", "addresses": [], "period": {}, "canonical_id": "canonical_id", "fax": "fax", "other_fax_numbers": [ "other_fax_numbers", "other_fax_numbers" ], "emails": [ "emails", "emails" ], "service_facilities": [] }, "referral_number": "referral_number", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "notes": "notes", "serviceFacility": { "service_facility_id": "service_facility_id" }, "units": "VISIT", "quantity": 1, "cptCodes": [ "cptCodes", "cptCodes" ], "applyForAllCptCodes": true } ], "self_pay": true, "service_facilities": [ { "service_facility_id": "service_facility_id" }, { "service_facility_id": "service_facility_id" } ], "sexual_orientation": "HETEROSEXUAL", "social_security_number": "social_security_number", "tag_ids": [ "tag_ids", "tag_ids" ], "electronic_communication_opt_in": true, "non_insurance_payers": [ "non_insurance_payers", "non_insurance_payers" ] }, "alternative_mrns": [ "alternative_mrns", "alternative_mrns" ], "primary_coverage": { "status": "ACTIVE", "subscriber": { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, "biological_sex": "FEMALE", "date_of_birth": "2023-01-15", "address": { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, "employer_name": "employer_name" }, "relationship": "SELF", "patient": "patient", "insurance_plan": { "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "additional_payer_information": { "availity_eligibility_id": "availity_eligibility_id", "availity_payer_id": "availity_payer_id", "availity_payer_name": "availity_payer_name", "availity_remittance_payer_id": "availity_remittance_payer_id" }, "group_number": "group_number", "name": "name", "plan_type": "09", "type": "01", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "insurance_card_image_locator": "insurance_card_image_locator", "address": { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "carve_outs": [ { "carve_out": "BEHAVIORAL", "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "group_number": "group_number", "plan_type": "09", "type": "01", "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, { "carve_out": "BEHAVIORAL", "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "group_number": "group_number", "plan_type": "09", "type": "01", "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" } ] }, "verified": true, "eligibility_checks": [ { "check_id": "check_id", "service_code": "1", "status": "COMPLETED", "initiated_by": "initiated_by", "initiated_at": "2024-01-15T09:30:00Z" }, { "check_id": "check_id", "service_code": "1", "status": "COMPLETED", "initiated_by": "initiated_by", "initiated_at": "2024-01-15T09:30:00Z" } ], "latest_eligibility_check": { "check_id": "check_id", "status": "ACTIVE", "initiated_at": "2024-01-15T09:30:00Z", "errors": [ {}, {} ], "request_corrections": [ { "property": "property", "request_value": "request_value", "corrected_value": "corrected_value" }, { "property": "property", "request_value": "request_value", "corrected_value": "corrected_value" } ], "trading_partner": "trading_partner" }, "benefits": { "plan_coverage": { "in_network": {}, "in_network_flat": [], "out_of_network": {}, "out_of_network_flat": [] }, "service_specific_coverage": [ { "service_code": "1" }, { "service_code": "1" } ], "benefits_related_entities": [ {}, {} ], "non_covered_details": [ { "type": "DEDUCTIBLE", "coverageLevel": "EMPLOYEE_AND_CHILDREN", "unit": "PERCENT", "value": 1.1 }, { "type": "DEDUCTIBLE", "coverageLevel": "EMPLOYEE_AND_CHILDREN", "unit": "PERCENT", "value": 1.1 } ], "notes": "notes", "autoUpdatedEligibilityCheckId": "autoUpdatedEligibilityCheckId" }, "orcon": true, "auto_update_enabled": true, "previous_appointment_copays": { "MD_Visit": 1 } }, "secondary_coverage": { "status": "ACTIVE", "subscriber": { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, "biological_sex": "FEMALE", "date_of_birth": "2023-01-15", "address": { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, "employer_name": "employer_name" }, "relationship": "SELF", "patient": "patient", "insurance_plan": { "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "additional_payer_information": { "availity_eligibility_id": "availity_eligibility_id", "availity_payer_id": "availity_payer_id", "availity_payer_name": "availity_payer_name", "availity_remittance_payer_id": "availity_remittance_payer_id" }, "group_number": "group_number", "name": "name", "plan_type": "09", "type": "01", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "insurance_card_image_locator": "insurance_card_image_locator", "address": { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "carve_outs": [ { "carve_out": "BEHAVIORAL", "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "group_number": "group_number", "plan_type": "09", "type": "01", "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, { "carve_out": "BEHAVIORAL", "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "group_number": "group_number", "plan_type": "09", "type": "01", "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" } ] }, "verified": true, "eligibility_checks": [ { "check_id": "check_id", "service_code": "1", "status": "COMPLETED", "initiated_by": "initiated_by", "initiated_at": "2024-01-15T09:30:00Z" }, { "check_id": "check_id", "service_code": "1", "status": "COMPLETED", "initiated_by": "initiated_by", "initiated_at": "2024-01-15T09:30:00Z" } ], "latest_eligibility_check": { "check_id": "check_id", "status": "ACTIVE", "initiated_at": "2024-01-15T09:30:00Z", "errors": [ {}, {} ], "request_corrections": [ { "property": "property", "request_value": "request_value", "corrected_value": "corrected_value" }, { "property": "property", "request_value": "request_value", "corrected_value": "corrected_value" } ], "trading_partner": "trading_partner" }, "benefits": { "plan_coverage": { "in_network": {}, "in_network_flat": [], "out_of_network": {}, "out_of_network_flat": [] }, "service_specific_coverage": [ { "service_code": "1" }, { "service_code": "1" } ], "benefits_related_entities": [ {}, {} ], "non_covered_details": [ { "type": "DEDUCTIBLE", "coverageLevel": "EMPLOYEE_AND_CHILDREN", "unit": "PERCENT", "value": 1.1 }, { "type": "DEDUCTIBLE", "coverageLevel": "EMPLOYEE_AND_CHILDREN", "unit": "PERCENT", "value": 1.1 } ], "notes": "notes", "autoUpdatedEligibilityCheckId": "autoUpdatedEligibilityCheckId" }, "orcon": true, "auto_update_enabled": true, "previous_appointment_copays": { "MD_Visit": 1 } }, "tertiary_coverage": { "status": "ACTIVE", "subscriber": { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, "biological_sex": "FEMALE", "date_of_birth": "2023-01-15", "address": { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, "employer_name": "employer_name" }, "relationship": "SELF", "patient": "patient", "insurance_plan": { "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "additional_payer_information": { "availity_eligibility_id": "availity_eligibility_id", "availity_payer_id": "availity_payer_id", "availity_payer_name": "availity_payer_name", "availity_remittance_payer_id": "availity_remittance_payer_id" }, "group_number": "group_number", "name": "name", "plan_type": "09", "type": "01", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "insurance_card_image_locator": "insurance_card_image_locator", "address": { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "carve_outs": [ { "carve_out": "BEHAVIORAL", "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "group_number": "group_number", "plan_type": "09", "type": "01", "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, { "carve_out": "BEHAVIORAL", "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "group_number": "group_number", "plan_type": "09", "type": "01", "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" } ] }, "verified": true, "eligibility_checks": [ { "check_id": "check_id", "service_code": "1", "status": "COMPLETED", "initiated_by": "initiated_by", "initiated_at": "2024-01-15T09:30:00Z" }, { "check_id": "check_id", "service_code": "1", "status": "COMPLETED", "initiated_by": "initiated_by", "initiated_at": "2024-01-15T09:30:00Z" } ], "latest_eligibility_check": { "check_id": "check_id", "status": "ACTIVE", "initiated_at": "2024-01-15T09:30:00Z", "errors": [ {}, {} ], "request_corrections": [ { "property": "property", "request_value": "request_value", "corrected_value": "corrected_value" }, { "property": "property", "request_value": "request_value", "corrected_value": "corrected_value" } ], "trading_partner": "trading_partner" }, "benefits": { "plan_coverage": { "in_network": {}, "in_network_flat": [], "out_of_network": {}, "out_of_network_flat": [] }, "service_specific_coverage": [ { "service_code": "1" }, { "service_code": "1" } ], "benefits_related_entities": [ {}, {} ], "non_covered_details": [ { "type": "DEDUCTIBLE", "coverageLevel": "EMPLOYEE_AND_CHILDREN", "unit": "PERCENT", "value": 1.1 }, { "type": "DEDUCTIBLE", "coverageLevel": "EMPLOYEE_AND_CHILDREN", "unit": "PERCENT", "value": 1.1 } ], "notes": "notes", "autoUpdatedEligibilityCheckId": "autoUpdatedEligibilityCheckId" }, "orcon": true, "auto_update_enabled": true, "previous_appointment_copays": { "MD_Visit": 1 } }, "next_appointment": { "patient_id": "patient_id", "start_timestamp": "2024-01-15T09:30:00Z", "service_duration": 1, "services": [ { "universal_service_identifier": "MD_Visit", "start_timestamp": "2024-01-15T09:30:00Z" }, { "universal_service_identifier": "MD_Visit", "start_timestamp": "2024-01-15T09:30:00Z" } ], "status": "PENDING", "not_ready_reason": "INACTIVE_PRIMARY", "ready_source": "MANUAL", "placer_appointment_id": "placer_appointment_id", "placer_system_name": "placer_system_name", "attending_doctor": { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": {}, "suffix": "suffix" }, "telecoms": [ { "value": "value", "use": "HOME", "period": {} }, { "value": "value", "use": "HOME", "period": {} } ], "type": "PRIMARY", "npi": "npi", "addresses": [ { "use": "HOME", "line": [], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country" }, { "use": "HOME", "line": [], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country" } ], "period": { "start": "2023-01-15", "end": "2023-01-15" }, "canonical_id": "canonical_id", "fax": "fax", "other_fax_numbers": [ "other_fax_numbers", "other_fax_numbers" ], "emails": [ "emails", "emails" ], "service_facilities": [ { "service_facility_id": "service_facility_id" }, { "service_facility_id": "service_facility_id" } ] }, "estimated_copay_cents": 1, "estimated_patient_responsibility_cents": 1, "patient_deposit_cents": 1, "appointment_details": "appointment_details", "checked_in_timestamp": "2024-01-15T09:30:00Z", "checked_out_timestamp": "2024-01-15T09:30:00Z", "appointment_reason_detail": { "diagnosis_codes": [ "diagnosis_codes", "diagnosis_codes" ], "procedure_codes": [ "procedure_codes", "procedure_codes" ] }, "medical_necessity_verified": true, "prior_authorization_status": "NOT_REQUIRED", "notes": "notes", "location_resource_id": "location_resource_id", "automated_eligibility_check_complete": true, "work_queue": "EMERGENT_ISSUE", "cancellation_reason": "cancellation_reason" }, "primary_mrn": "primary_mrn" }, { "patient": { "biological_sex": "FEMALE", "birth_date": "2023-01-15", "contacts": [ { "relationship": [ "SELF", "SELF" ], "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, "telecoms": [ { "value": "value", "use": "HOME", "period": {} }, { "value": "value", "use": "HOME", "period": {} } ], "addresses": [ { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} } ], "period": { "start": "2023-01-15", "end": "2023-01-15" }, "hipaa_authorization": true }, { "relationship": [ "SELF", "SELF" ], "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, "telecoms": [ { "value": "value", "use": "HOME", "period": {} }, { "value": "value", "use": "HOME", "period": {} } ], "addresses": [ { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} } ], "period": { "start": "2023-01-15", "end": "2023-01-15" }, "hipaa_authorization": true } ], "deactivated": true, "filing_order": { "coverages": [ "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" ] }, "general_practitioners": [ { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, "telecoms": [ { "value": "value", "use": "HOME", "period": {} }, { "value": "value", "use": "HOME", "period": {} } ], "type": "PRIMARY", "npi": "npi", "addresses": [ { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} } ], "period": { "start": "2023-01-15", "end": "2023-01-15" }, "canonical_id": "canonical_id", "fax": "fax", "other_fax_numbers": [ "other_fax_numbers", "other_fax_numbers" ], "emails": [ "emails", "emails" ], "service_facilities": [ { "service_facility_id": "service_facility_id" }, { "service_facility_id": "service_facility_id" } ] }, { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, "telecoms": [ { "value": "value", "use": "HOME", "period": {} }, { "value": "value", "use": "HOME", "period": {} } ], "type": "PRIMARY", "npi": "npi", "addresses": [ { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} } ], "period": { "start": "2023-01-15", "end": "2023-01-15" }, "canonical_id": "canonical_id", "fax": "fax", "other_fax_numbers": [ "other_fax_numbers", "other_fax_numbers" ], "emails": [ "emails", "emails" ], "service_facilities": [ { "service_facility_id": "service_facility_id" }, { "service_facility_id": "service_facility_id" } ] } ], "id": "id", "mrn": "mrn", "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, "organization_id": "organization_id", "other_addresses": [ { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": { "start": "2023-01-15", "end": "2023-01-15" } }, { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": { "start": "2023-01-15", "end": "2023-01-15" } } ], "other_names": [ { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" } ], "other_telecoms": [ { "value": "value", "use": "HOME", "period": { "start": "2023-01-15", "end": "2023-01-15" } }, { "value": "value", "use": "HOME", "period": { "start": "2023-01-15", "end": "2023-01-15" } } ], "primary_address": { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": { "start": "2023-01-15", "end": "2023-01-15" } }, "updated_at": "2024-01-15T09:30:00Z", "updating_user_id": "updating_user_id", "version": 1, "advanced_directives": [ "NONE", "NONE" ], "authorizations": [ { "payer_id": "payer_id", "payer_name": "payer_name", "authorization_number": "authorization_number", "cpt_code": "cpt_code", "units": "VISIT", "additional_payer_information": { "availity_eligibility_id": "availity_eligibility_id", "availity_payer_id": "availity_payer_id", "availity_payer_name": "availity_payer_name", "availity_remittance_payer_id": "availity_remittance_payer_id" }, "apply_for_all_cpt_codes": true, "no_prior_authorization_required": true, "quantity": 1, "period": { "start": "2023-01-15", "end": "2023-01-15" }, "notes": "notes", "billing_provider_npi": "billing_provider_npi", "service_facility": { "service_facility_id": "service_facility_id" }, "dx_codes": [ "dx_codes", "dx_codes" ] }, { "payer_id": "payer_id", "payer_name": "payer_name", "authorization_number": "authorization_number", "cpt_code": "cpt_code", "units": "VISIT", "additional_payer_information": { "availity_eligibility_id": "availity_eligibility_id", "availity_payer_id": "availity_payer_id", "availity_payer_name": "availity_payer_name", "availity_remittance_payer_id": "availity_remittance_payer_id" }, "apply_for_all_cpt_codes": true, "no_prior_authorization_required": true, "quantity": 1, "period": { "start": "2023-01-15", "end": "2023-01-15" }, "notes": "notes", "billing_provider_npi": "billing_provider_npi", "service_facility": { "service_facility_id": "service_facility_id" }, "dx_codes": [ "dx_codes", "dx_codes" ] } ], "coverages_for_related_causes": { "coverages": [ "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" ] }, "custom_metadata": [ { "metadata_schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "key_value_pairs": { "key_value_pairs": { "key": "value" } } }, { "metadata_schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "key_value_pairs": { "key_value_pairs": { "key": "value" } } } ], "deceased": "2024-01-15T09:30:00Z", "disability_status": "DISABLED", "do_not_invoice_reason": "BANKRUPTCY", "electronic_communication_consent": { "text_communication_consent": true, "email_communication_consent": true }, "email": "email", "ethnicity": "HISPANIC_OR_LATINO", "external_provenance": { "external_id": "external_id", "system_name": "system_name" }, "gender": "MAN", "guarantor": { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, "address": { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": { "start": "2023-01-15", "end": "2023-01-15" } }, "telecom": { "value": "value", "use": "HOME", "period": {} }, "email": "email", "birth_date": "2023-01-15" }, "hipaa_code": "hipaa_code", "inferred_patient_metadata": { "inferred_encounter_id": "inferred_encounter_id", "inferred_encounter_latest_date_of_service": "2023-01-15" }, "language": "language", "marital_status": "ANNULLED", "multiple_birth": 1, "non_insurance_payer_associations": [ { "id": "id", "member_id": "member_id", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "clinical_trial_info": [ { "id": "id" }, { "id": "id" } ] }, { "id": "id", "member_id": "member_id", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "clinical_trial_info": [ { "id": "id" }, { "id": "id" } ] } ], "note_ids": [ "note_ids", "note_ids" ], "orcon": true, "origination_detail": { "referral_source": "HOSPITAL", "referring_provider": { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": {}, "suffix": "suffix" }, "telecoms": [ { "value": "value", "use": "HOME" }, { "value": "value", "use": "HOME" } ], "type": "PRIMARY", "npi": "npi", "addresses": [], "period": {}, "canonical_id": "canonical_id", "fax": "fax", "other_fax_numbers": [ "other_fax_numbers", "other_fax_numbers" ], "emails": [ "emails", "emails" ], "service_facilities": [] }, "specialization_categories": [ "BEHAVIORAL_HEALTH_THERAPY", "BEHAVIORAL_HEALTH_THERAPY" ], "referral_type": "DIRECTED" }, "other_identifiers": [ { "value": "value", "system": "system", "period": { "start": "2023-01-15", "end": "2023-01-15" } }, { "value": "value", "system": "system", "period": { "start": "2023-01-15", "end": "2023-01-15" } } ], "photo": "photo", "primary_service_facility_id": "primary_service_facility_id", "primary_telecom": { "value": "value", "use": "HOME", "period": { "start": "2023-01-15", "end": "2023-01-15" } }, "pronouns": [ "pronouns", "pronouns" ], "race": "AMERICAN_INDIAN_OR_ALASKA_NATIVE", "referrals": [ { "provider": { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": {}, "suffix": "suffix" }, "telecoms": [ { "value": "value", "use": "HOME" }, { "value": "value", "use": "HOME" } ], "type": "PRIMARY", "npi": "npi", "addresses": [], "period": {}, "canonical_id": "canonical_id", "fax": "fax", "other_fax_numbers": [ "other_fax_numbers", "other_fax_numbers" ], "emails": [ "emails", "emails" ], "service_facilities": [] }, "referral_number": "referral_number", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "notes": "notes", "serviceFacility": { "service_facility_id": "service_facility_id" }, "units": "VISIT", "quantity": 1, "cptCodes": [ "cptCodes", "cptCodes" ], "applyForAllCptCodes": true }, { "provider": { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": {}, "suffix": "suffix" }, "telecoms": [ { "value": "value", "use": "HOME" }, { "value": "value", "use": "HOME" } ], "type": "PRIMARY", "npi": "npi", "addresses": [], "period": {}, "canonical_id": "canonical_id", "fax": "fax", "other_fax_numbers": [ "other_fax_numbers", "other_fax_numbers" ], "emails": [ "emails", "emails" ], "service_facilities": [] }, "referral_number": "referral_number", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "notes": "notes", "serviceFacility": { "service_facility_id": "service_facility_id" }, "units": "VISIT", "quantity": 1, "cptCodes": [ "cptCodes", "cptCodes" ], "applyForAllCptCodes": true } ], "self_pay": true, "service_facilities": [ { "service_facility_id": "service_facility_id" }, { "service_facility_id": "service_facility_id" } ], "sexual_orientation": "HETEROSEXUAL", "social_security_number": "social_security_number", "tag_ids": [ "tag_ids", "tag_ids" ], "electronic_communication_opt_in": true, "non_insurance_payers": [ "non_insurance_payers", "non_insurance_payers" ] }, "alternative_mrns": [ "alternative_mrns", "alternative_mrns" ], "primary_coverage": { "status": "ACTIVE", "subscriber": { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, "biological_sex": "FEMALE", "date_of_birth": "2023-01-15", "address": { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, "employer_name": "employer_name" }, "relationship": "SELF", "patient": "patient", "insurance_plan": { "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "additional_payer_information": { "availity_eligibility_id": "availity_eligibility_id", "availity_payer_id": "availity_payer_id", "availity_payer_name": "availity_payer_name", "availity_remittance_payer_id": "availity_remittance_payer_id" }, "group_number": "group_number", "name": "name", "plan_type": "09", "type": "01", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "insurance_card_image_locator": "insurance_card_image_locator", "address": { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "carve_outs": [ { "carve_out": "BEHAVIORAL", "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "group_number": "group_number", "plan_type": "09", "type": "01", "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, { "carve_out": "BEHAVIORAL", "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "group_number": "group_number", "plan_type": "09", "type": "01", "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" } ] }, "verified": true, "eligibility_checks": [ { "check_id": "check_id", "service_code": "1", "status": "COMPLETED", "initiated_by": "initiated_by", "initiated_at": "2024-01-15T09:30:00Z" }, { "check_id": "check_id", "service_code": "1", "status": "COMPLETED", "initiated_by": "initiated_by", "initiated_at": "2024-01-15T09:30:00Z" } ], "latest_eligibility_check": { "check_id": "check_id", "status": "ACTIVE", "initiated_at": "2024-01-15T09:30:00Z", "errors": [ {}, {} ], "request_corrections": [ { "property": "property", "request_value": "request_value", "corrected_value": "corrected_value" }, { "property": "property", "request_value": "request_value", "corrected_value": "corrected_value" } ], "trading_partner": "trading_partner" }, "benefits": { "plan_coverage": { "in_network": {}, "in_network_flat": [], "out_of_network": {}, "out_of_network_flat": [] }, "service_specific_coverage": [ { "service_code": "1" }, { "service_code": "1" } ], "benefits_related_entities": [ {}, {} ], "non_covered_details": [ { "type": "DEDUCTIBLE", "coverageLevel": "EMPLOYEE_AND_CHILDREN", "unit": "PERCENT", "value": 1.1 }, { "type": "DEDUCTIBLE", "coverageLevel": "EMPLOYEE_AND_CHILDREN", "unit": "PERCENT", "value": 1.1 } ], "notes": "notes", "autoUpdatedEligibilityCheckId": "autoUpdatedEligibilityCheckId" }, "orcon": true, "auto_update_enabled": true, "previous_appointment_copays": { "MD_Visit": 1 } }, "secondary_coverage": { "status": "ACTIVE", "subscriber": { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, "biological_sex": "FEMALE", "date_of_birth": "2023-01-15", "address": { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, "employer_name": "employer_name" }, "relationship": "SELF", "patient": "patient", "insurance_plan": { "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "additional_payer_information": { "availity_eligibility_id": "availity_eligibility_id", "availity_payer_id": "availity_payer_id", "availity_payer_name": "availity_payer_name", "availity_remittance_payer_id": "availity_remittance_payer_id" }, "group_number": "group_number", "name": "name", "plan_type": "09", "type": "01", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "insurance_card_image_locator": "insurance_card_image_locator", "address": { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "carve_outs": [ { "carve_out": "BEHAVIORAL", "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "group_number": "group_number", "plan_type": "09", "type": "01", "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, { "carve_out": "BEHAVIORAL", "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "group_number": "group_number", "plan_type": "09", "type": "01", "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" } ] }, "verified": true, "eligibility_checks": [ { "check_id": "check_id", "service_code": "1", "status": "COMPLETED", "initiated_by": "initiated_by", "initiated_at": "2024-01-15T09:30:00Z" }, { "check_id": "check_id", "service_code": "1", "status": "COMPLETED", "initiated_by": "initiated_by", "initiated_at": "2024-01-15T09:30:00Z" } ], "latest_eligibility_check": { "check_id": "check_id", "status": "ACTIVE", "initiated_at": "2024-01-15T09:30:00Z", "errors": [ {}, {} ], "request_corrections": [ { "property": "property", "request_value": "request_value", "corrected_value": "corrected_value" }, { "property": "property", "request_value": "request_value", "corrected_value": "corrected_value" } ], "trading_partner": "trading_partner" }, "benefits": { "plan_coverage": { "in_network": {}, "in_network_flat": [], "out_of_network": {}, "out_of_network_flat": [] }, "service_specific_coverage": [ { "service_code": "1" }, { "service_code": "1" } ], "benefits_related_entities": [ {}, {} ], "non_covered_details": [ { "type": "DEDUCTIBLE", "coverageLevel": "EMPLOYEE_AND_CHILDREN", "unit": "PERCENT", "value": 1.1 }, { "type": "DEDUCTIBLE", "coverageLevel": "EMPLOYEE_AND_CHILDREN", "unit": "PERCENT", "value": 1.1 } ], "notes": "notes", "autoUpdatedEligibilityCheckId": "autoUpdatedEligibilityCheckId" }, "orcon": true, "auto_update_enabled": true, "previous_appointment_copays": { "MD_Visit": 1 } }, "tertiary_coverage": { "status": "ACTIVE", "subscriber": { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "suffix": "suffix" }, "biological_sex": "FEMALE", "date_of_birth": "2023-01-15", "address": { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, "employer_name": "employer_name" }, "relationship": "SELF", "patient": "patient", "insurance_plan": { "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "additional_payer_information": { "availity_eligibility_id": "availity_eligibility_id", "availity_payer_id": "availity_payer_id", "availity_payer_name": "availity_payer_name", "availity_remittance_payer_id": "availity_remittance_payer_id" }, "group_number": "group_number", "name": "name", "plan_type": "09", "type": "01", "period": { "start": "2023-01-15", "end": "2023-01-15" }, "insurance_card_image_locator": "insurance_card_image_locator", "address": { "use": "HOME", "line": [ "line", "line" ], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country", "administrative_area": "administrative_area", "county": "county", "period": {} }, "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "carve_outs": [ { "carve_out": "BEHAVIORAL", "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "group_number": "group_number", "plan_type": "09", "type": "01", "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, { "carve_out": "BEHAVIORAL", "member_id": "member_id", "payer_id": "payer_id", "payer_name": "payer_name", "group_number": "group_number", "plan_type": "09", "type": "01", "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" } ] }, "verified": true, "eligibility_checks": [ { "check_id": "check_id", "service_code": "1", "status": "COMPLETED", "initiated_by": "initiated_by", "initiated_at": "2024-01-15T09:30:00Z" }, { "check_id": "check_id", "service_code": "1", "status": "COMPLETED", "initiated_by": "initiated_by", "initiated_at": "2024-01-15T09:30:00Z" } ], "latest_eligibility_check": { "check_id": "check_id", "status": "ACTIVE", "initiated_at": "2024-01-15T09:30:00Z", "errors": [ {}, {} ], "request_corrections": [ { "property": "property", "request_value": "request_value", "corrected_value": "corrected_value" }, { "property": "property", "request_value": "request_value", "corrected_value": "corrected_value" } ], "trading_partner": "trading_partner" }, "benefits": { "plan_coverage": { "in_network": {}, "in_network_flat": [], "out_of_network": {}, "out_of_network_flat": [] }, "service_specific_coverage": [ { "service_code": "1" }, { "service_code": "1" } ], "benefits_related_entities": [ {}, {} ], "non_covered_details": [ { "type": "DEDUCTIBLE", "coverageLevel": "EMPLOYEE_AND_CHILDREN", "unit": "PERCENT", "value": 1.1 }, { "type": "DEDUCTIBLE", "coverageLevel": "EMPLOYEE_AND_CHILDREN", "unit": "PERCENT", "value": 1.1 } ], "notes": "notes", "autoUpdatedEligibilityCheckId": "autoUpdatedEligibilityCheckId" }, "orcon": true, "auto_update_enabled": true, "previous_appointment_copays": { "MD_Visit": 1 } }, "next_appointment": { "patient_id": "patient_id", "start_timestamp": "2024-01-15T09:30:00Z", "service_duration": 1, "services": [ { "universal_service_identifier": "MD_Visit", "start_timestamp": "2024-01-15T09:30:00Z" }, { "universal_service_identifier": "MD_Visit", "start_timestamp": "2024-01-15T09:30:00Z" } ], "status": "PENDING", "not_ready_reason": "INACTIVE_PRIMARY", "ready_source": "MANUAL", "placer_appointment_id": "placer_appointment_id", "placer_system_name": "placer_system_name", "attending_doctor": { "name": { "family": "family", "given": [ "given", "given" ], "use": "USUAL", "period": {}, "suffix": "suffix" }, "telecoms": [ { "value": "value", "use": "HOME", "period": {} }, { "value": "value", "use": "HOME", "period": {} } ], "type": "PRIMARY", "npi": "npi", "addresses": [ { "use": "HOME", "line": [], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country" }, { "use": "HOME", "line": [], "city": "city", "state": "state", "postal_code": "postal_code", "country": "country" } ], "period": { "start": "2023-01-15", "end": "2023-01-15" }, "canonical_id": "canonical_id", "fax": "fax", "other_fax_numbers": [ "other_fax_numbers", "other_fax_numbers" ], "emails": [ "emails", "emails" ], "service_facilities": [ { "service_facility_id": "service_facility_id" }, { "service_facility_id": "service_facility_id" } ] }, "estimated_copay_cents": 1, "estimated_patient_responsibility_cents": 1, "patient_deposit_cents": 1, "appointment_details": "appointment_details", "checked_in_timestamp": "2024-01-15T09:30:00Z", "checked_out_timestamp": "2024-01-15T09:30:00Z", "appointment_reason_detail": { "diagnosis_codes": [ "diagnosis_codes", "diagnosis_codes" ], "procedure_codes": [ "procedure_codes", "procedure_codes" ] }, "medical_necessity_verified": true, "prior_authorization_status": "NOT_REQUIRED", "notes": "notes", "location_resource_id": "location_resource_id", "automated_eligibility_check_complete": true, "work_queue": "EMERGENT_ISSUE", "cancellation_reason": "cancellation_reason" }, "primary_mrn": "primary_mrn" } ], "total": 1, "next_page_token": "next_page_token", "prev_page_token": "prev_page_token" } ``` **SDK Code** ```python import requests url = "https://pre-api.joincandidhealth.com/lists/v1/patient" headers = {"Authorization": "."} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://pre-api.joincandidhealth.com/lists/v1/patient'; const options = {method: 'GET', headers: {Authorization: '.'}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://pre-api.joincandidhealth.com/lists/v1/patient" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", ".") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://pre-api.joincandidhealth.com/lists/v1/patient") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = '.' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://pre-api.joincandidhealth.com/lists/v1/patient") .header("Authorization", ".") .asString(); ``` ```php request('GET', 'https://pre-api.joincandidhealth.com/lists/v1/patient', [ 'headers' => [ 'Authorization' => '.', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://pre-api.joincandidhealth.com/lists/v1/patient"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "."); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "."] let request = NSMutableURLRequest(url: NSURL(string: "https://pre-api.joincandidhealth.com/lists/v1/patient")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```