Bridge SDK - v2.12.0
    Preparing search index...

    Type Alias Patient

    The patient object is delivered to a bridge app via the sdk when a user navigates to a patient page within the EHR

    type Patient = {
        altIds?: string[];
        dob?: string;
        first?: string;
        id: string;
        last?: string;
        sex?: "F" | "M" | "O";
        xdata?: {
            address?: {
                city?: string;
                line1?: string;
                line2?: string;
                state?: string;
                zip?: string;
            };
            dept?: string;
            email?: string;
            lastDateOfService?: string;
            pcpIds?: { id: string; type: string }[];
            phoneCell?: string;
            phoneHome?: string;
            primaryInsurance?: string;
            primaryInsuranceGroupNum?: string;
            primaryInsurancePolicyNum?: string;
            problems?: string[];
            provider?: string;
            referringProvider?: string;
            secondaryInsurance?: string;
            secondaryInsuranceGroupNum?: string;
            secondaryInsurancePolicyNum?: string;
        };
    }
    Index
    altIds?: string[]

    EHR Alternative Patient IDs

    dob?: string

    ISO 8601 format date string representing the date of birth from the EHR. YYYY-MM-DD

    first?: string

    The given name for the patient

    id: string

    The external facing patient identifier as displayed in the EHR

    last?: string

    The family name for the patient

    sex?: "F" | "M" | "O"

    The patient sex as reported by the EHR.

    F: female, M: male, O: other (any other defined value outside of female/male)

    xdata?: {
        address?: {
            city?: string;
            line1?: string;
            line2?: string;
            state?: string;
            zip?: string;
        };
        dept?: string;
        email?: string;
        lastDateOfService?: string;
        pcpIds?: { id: string; type: string }[];
        phoneCell?: string;
        phoneHome?: string;
        primaryInsurance?: string;
        primaryInsuranceGroupNum?: string;
        primaryInsurancePolicyNum?: string;
        problems?: string[];
        provider?: string;
        referringProvider?: string;
        secondaryInsurance?: string;
        secondaryInsuranceGroupNum?: string;
        secondaryInsurancePolicyNum?: string;
    }

    Additional patient data

    Type Declaration

    • Optionaladdress?: { city?: string; line1?: string; line2?: string; state?: string; zip?: string }

      {line1: String, line2: String, city: String, state: String, zip: String} as reported by the EHR

    • Optionaldept?: string

      The name of the physical location associated with the patient in the EHR. This is not standardized and may even be an internal nickname for the practice. Bridge reports what is in the EHR

    • Optionalemail?: string

      Primary contact email identified for the patient

    • OptionallastDateOfService?: string

      The ISO 8601 date of the last date of service as identified in the EHR.

      Prompt: Most recent visit's (across all cases) date of service. undefined if no visits.

    • OptionalpcpIds?: { id: string; type: string }[]
    • OptionalphoneCell?: string

      Cell phone in the format provided by the EHR

    • OptionalphoneHome?: string

      Home phone or Primary Phone in the format provided by the EHR

    • OptionalprimaryInsurance?: string

      Name of Payer and name of Plan identified as the primary insurance or the first insurance in the list of patient insurances as reported by the EHR. Insurance must be effective.

      Prompt: This is the first listed active insurance. undefined if no active insurances. Format: "[ ]"

    • OptionalprimaryInsuranceGroupNum?: string

      The primary insurance group number as provided by the EHR.

    • OptionalprimaryInsurancePolicyNum?: string

      Member id associated with the primary insurance as reported by the EHR

    • Optionalproblems?: string[]

      A list of strings representing current problems as reported by the EHR. Elements typically include a combination of a code and a description as reported by the EHR.

      Prompt: List of active cases' visits' services' diagnoses. Sorted alphabetically. Empty array if no active cases. OncoEMR: Combined problem list (oncology diagnoses + non-oncology diagnoses). gGastro: Combined problems/diagnoses list + conditions list.

    • Optionalprovider?: string

      Name of provider associated with the patient if any, in the format provided by the EHR.

      Prompt: The provider on the most recent active case. undefined if no active cases, or no provider on the most recent active case. Format: ", [ ][, ]"

    • OptionalreferringProvider?: string

      Name of provider identified by the EHR as the primary referring provider associated with the patient if any, in the format provided by the EHR.

      Prompt: The referring provider on the most recent active case. undefined if no active cases, or no referring provider on the most recent active case. Format: ", [ ][, ]"

    • OptionalsecondaryInsurance?: string

      Name of Payer and name of Plan identified as the secondary insurance or the second insurance in the list of patient insurances as reported by the EHR. Insurance must be effective.

      Prompt: This is the second listed active insurance. undefined if fewer than 2 insurances. Format: "[ ]"

    • OptionalsecondaryInsuranceGroupNum?: string

      Group ID associated with the secondary insurance as reported by the EHR.

    • OptionalsecondaryInsurancePolicyNum?: string

      Member id associated with the secondary insurance as reported by the EHR.