Circle V2 API Docs
    Preparing search index...

    Class SunwaveApiClient

    Index

    Constructors

    • Parameters

      • credentials:
            | {
                api_id: string;
                api_secret: string;
                extend_workflow_id?: string;
                location_name?: string;
                realm_id: string;
                service_facility_id: number;
                sunwave_email: string;
            }
            | {
                access_id: string;
                app_id: string;
                extend_workflow_id?: string;
                location_id: number;
                location_name?: string;
                secret_key: string;
            }
            | {
                bearer_token: string;
                extend_workflow_id?: string;
                location_ids: number[];
                location_name?: string;
            }
            | {
                api_id: string;
                api_secret: string;
                extend_workflow_id?: string;
                location_name?: string;
                realm_id: string;
                service_facility_id: number;
                sunwave_email: string;
            }
            | {
                base_url: string;
                client_id: string;
                extend_workflow_id?: string;
                rpa_vault_user_id: string;
                rpa_workflow_id: string;
                secret_key: string;
            }
            | {
                as_of_date?: string;
                extend_workflow_id?: string;
                location_id: "2"
                | "1";
                location_name?: string;
                seed: string;
            }
            | {
                api_key: string;
                connector: string;
                connector_label: string;
                extend_workflow_id?: string;
                org_id: string;
                program_map: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
                sync_from: string;
            }
      • Optionaloptions: SunwaveApiClientOptions

      Returns SunwaveApiClient

    Methods

    • Fetch active census data within a date range.

      Parameters

      • from: string
      • until: string

      Returns Promise<CensusRecord[]>

    • Fetch a specific admission form (populated fields)

      Parameters

      • formId: string
      • admissionId: string
      • patientId: string

      Returns Promise<FormInstanceResponse>

    • Fetch admitted census data within a date range.

      Parameters

      • from: string
      • until: string

      Returns Promise<CensusRecord[]>

    • Fetch assessment scores report for a date range and assessment type

      Parameters

      • from: string
      • until: string
      • assessmentName: string

      Returns Promise<AssessmentScoreRecord[]>

    • Fetch diagnosis changes report

      Parameters

      • from: string

      Returns Promise<DiagnosisRecord[]>

    • Fetch discharged census data within a date range.

      Parameters

      • from: string
      • until: string

      Returns Promise<CensusRecord[]>

    • Fetch form data for active patients in date range

      Parameters

      • formId: string
      • from: string
      • until: string

      Returns Promise<FormDataRecord[]>

    • Fetch form data for admitted patients in date range

      Parameters

      • formId: string
      • from: string
      • until: string

      Returns Promise<FormDataRecord[]>

    • Fetch form data for discharged patients in date range

      Parameters

      • formId: string
      • from: string
      • until: string

      Returns Promise<FormDataRecord[]>

    • Fetch form instance detail

      Parameters

      • formId: string
      • instanceId: string
      • admissionId: string
      • patientId: string

      Returns Promise<FormInstanceResponse>

    • List all form definitions for the clinic

      Returns Promise<FormListItem[]>

    • Fetch group notes for a specific date

      Parameters

      • date: string

      Returns Promise<GroupNote[]>

    • Fetch a single lab result by ID (HL7 format)

      Parameters

      • patientId: string
      • admissionId: string
      • formId: string
      • resultId: string

      Returns Promise<LabResult>

    • Fetch patient lab results list (HL7 format)

      Parameters

      • patientId: string
      • admissionId: string
      • formId: string

      Returns Promise<LabResultSummary[]>

    • Fetch diagnostic codes for a patient admission

      Parameters

      • patientId: string
      • admissionId: string

      Returns Promise<DiagnosisRecord[]>

    • Fetch patient programs for an admission

      Parameters

      • patientId: string
      • admissionId: string

      Returns Promise<PatientProgram[]>

    • Fetch program changes report

      Parameters

      • from: string

      Returns Promise<PatientProgram[]>

    • Fetch all realms and their service facilities. Used for the location selector in the integration wizard.

      Returns Promise<RealmsResponse>

    • Fetch utilization review report

      Parameters

      • from: string
      • until: string

      Returns Promise<UtilizationReviewRecord[]>

    • Fetch all staff users for the clinic

      Returns Promise<User[]>