Circle V2 API Docs
    Preparing search index...

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    supabase: SupabaseClient<Database>

    Methods

    • Parameters

      • patientId: number

      Returns Promise<
          {
              address_city: string
              | null;
              address_state: string | null;
              address_street1: string | null;
              address_street2: string | null;
              address_zipcode: string | null;
              created_at: string;
              created_by: string | null;
              dob: string | null;
              email: string | null;
              entity_id: number | null;
              external_patient_id: string | null;
              external_source:
                  | "kipu"
                  | "lightningstep"
                  | "sunwave"
                  | "qualifacts_insync"
                  | null;
              facility_id: string
              | null;
              first_name: string | null;
              gender: string | null;
              intake_notes: string | null;
              last_name: string | null;
              last_updated_summary: string | null;
              patient_id: number;
              phone_mobile: string | null;
              primary_provider_id: number | null;
              status: number | null;
              summary: Json;
          },
      >

    • Get patients for organization page. Always filters by entityId. Optionally filters by createdByUserIds and other criteria.

      Parameters

      • options: {
            createdByUserIds?: string[];
            entityId: number;
            filters?: OrganizationPatientsFilters;
        }

      Returns Promise<OrganizationPatient[]>

    • Parameters

      • patientId: number
      • params: {
            address_city?: string | null;
            address_state?: string | null;
            address_street1?: string | null;
            address_street2?: string | null;
            address_zipcode?: string | null;
            created_at?: string;
            created_by?: string | null;
            dob?: string | null;
            email?: string | null;
            entity_id?: number | null;
            external_patient_id?: string | null;
            external_source?:
                | "kipu"
                | "lightningstep"
                | "sunwave"
                | "qualifacts_insync"
                | null;
            facility_id?: string
            | null;
            first_name?: string | null;
            gender?: string | null;
            intake_notes?: string | null;
            last_name?: string | null;
            last_updated_summary?: string | null;
            patient_id?: number;
            phone_mobile?: string | null;
            primary_provider_id?: number | null;
            status?: number | null;
            summary?: Json;
        }

      Returns Promise<
          {
              address_city: string
              | null;
              address_state: string | null;
              address_street1: string | null;
              address_street2: string | null;
              address_zipcode: string | null;
              created_at: string;
              created_by: string | null;
              dob: string | null;
              email: string | null;
              entity_id: number | null;
              external_patient_id: string | null;
              external_source:
                  | "kipu"
                  | "lightningstep"
                  | "sunwave"
                  | "qualifacts_insync"
                  | null;
              facility_id: string
              | null;
              first_name: string | null;
              gender: string | null;
              intake_notes: string | null;
              last_name: string | null;
              last_updated_summary: string | null;
              patient_id: number;
              phone_mobile: string | null;
              primary_provider_id: number | null;
              status: number | null;
              summary: Json;
          },
      >

    • Parameters

      • params: {
            address_city?: string | null;
            address_state?: string | null;
            address_street1?: string | null;
            address_street2?: string | null;
            address_zipcode?: string | null;
            created_at?: string;
            created_by?: string | null;
            dob?: string | null;
            email?: string | null;
            entity_id?: number | null;
            external_patient_id?: string | null;
            external_source?:
                | "kipu"
                | "lightningstep"
                | "sunwave"
                | "qualifacts_insync"
                | null;
            facility_id?: string
            | null;
            first_name?: string | null;
            gender?: string | null;
            intake_notes?: string | null;
            last_name?: string | null;
            last_updated_summary?: string | null;
            patient_id?: number;
            phone_mobile?: string | null;
            primary_provider_id?: number | null;
            status?: number | null;
            summary?: Json;
        }

      Returns Promise<
          {
              address_city: string
              | null;
              address_state: string | null;
              address_street1: string | null;
              address_street2: string | null;
              address_zipcode: string | null;
              created_at: string;
              created_by: string | null;
              dob: string | null;
              email: string | null;
              entity_id: number | null;
              external_patient_id: string | null;
              external_source:
                  | "kipu"
                  | "lightningstep"
                  | "sunwave"
                  | "qualifacts_insync"
                  | null;
              facility_id: string
              | null;
              first_name: string | null;
              gender: string | null;
              intake_notes: string | null;
              last_name: string | null;
              last_updated_summary: string | null;
              patient_id: number;
              phone_mobile: string | null;
              primary_provider_id: number | null;
              status: number | null;
              summary: Json;
          },
      >

    • Parameters

      • params: {
            address_city?: string | null;
            address_state?: string | null;
            address_street1?: string | null;
            address_street2?: string | null;
            address_zipcode?: string | null;
            created_at?: string;
            created_by?: string | null;
            dob?: string | null;
            email?: string | null;
            entity_id?: number | null;
            external_patient_id?: string | null;
            external_source?:
                | "kipu"
                | "lightningstep"
                | "sunwave"
                | "qualifacts_insync"
                | null;
            facility_id?: string
            | null;
            first_name?: string | null;
            gender?: string | null;
            intake_notes?: string | null;
            last_name?: string | null;
            last_updated_summary?: string | null;
            patient_id?: number;
            phone_mobile?: string | null;
            primary_provider_id?: number | null;
            status?: number | null;
            summary?: Json;
        }[]

      Returns Promise<
          {
              address_city: string
              | null;
              address_state: string | null;
              address_street1: string | null;
              address_street2: string | null;
              address_zipcode: string | null;
              created_at: string;
              created_by: string | null;
              dob: string | null;
              email: string | null;
              entity_id: number | null;
              external_patient_id: string | null;
              external_source:
                  | "kipu"
                  | "lightningstep"
                  | "sunwave"
                  | "qualifacts_insync"
                  | null;
              facility_id: string
              | null;
              first_name: string | null;
              gender: string | null;
              intake_notes: string | null;
              last_name: string | null;
              last_updated_summary: string | null;
              patient_id: number;
              phone_mobile: string | null;
              primary_provider_id: number | null;
              status: number | null;
              summary: Json;
          }[],
      >

    • Parameters

      • options: { supabase: SupabaseClient<Database> }

      Returns this