Class SunwaveApiClient

Constructors

constructor

new SunwaveApiClient(
    credentials:
        | {
            access_id: string;
            app_id: string;
            location_id: number;
            location_name?: string;
            secret_key: string;
        }
        | { bearer_token: string; location_ids: number[]; location_name?: string }
        | {
            api_id: string;
            api_secret: string;
            location_name?: string;
            realm_id: string;
            service_facility_id: number;
            sunwave_email: string;
        }
        | {
            base_url: string;
            client_id: string;
            rpa_vault_user_id: string;
            rpa_workflow_id: string;
            secret_key: string;
        },
    options?: SunwaveApiClientOptions,
): SunwaveApiClient
Parameters
- credentials:
      | {
          access_id: string;
          app_id: string;
          location_id: number;
          location_name?: string;
          secret_key: string;
      }
      | { bearer_token: string; location_ids: number[]; location_name?: string }
      | {
          api_id: string;
          api_secret: string;
          location_name?: string;
          realm_id: string;
          service_facility_id: number;
          sunwave_email: string;
      }
      | {
          base_url: string;
          client_id: string;
          rpa_vault_user_id: string;
          rpa_workflow_id: string;
          secret_key: string;
      }
  - {
        access_id: string;
        app_id: string;
        location_id: number;
        location_name?: string;
        secret_key: string;
    }
  - { bearer_token: string; location_ids: number[]; location_name?: string }
  - {
        api_id: string;
        api_secret: string;
        location_name?: string;
        realm_id: string;
        service_facility_id: number;
        sunwave_email: string;
    }
  - {
        base_url: string;
        client_id: string;
        rpa_vault_user_id: string;
        rpa_workflow_id: string;
        secret_key: string;
    }
    base_url: string
    client_id: string
    rpa_vault_user_id: string
    RPA vault user id — passed as the workflow's USER input (the portal login identity).
    
    rpa_workflow_id: string
    RPA workflow id the bot runs; the workflow branches on the sync_type input.
    
    secret_key: string
- Optionaloptions: SunwaveApiClientOptions
Returns SunwaveApiClient
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:66

Methods

fetchActiveCensus

fetchActiveCensus(from: string, until: string): Promise<CensusRecord[]>
Fetch active census data within a date range.
Parameters
- from: string
- until: string
Returns Promise<CensusRecord[]>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:106

fetchAdmissionForm

fetchAdmissionForm(
    formId: string,
    admissionId: string,
    patientId: string,
): Promise<FormInstanceResponse>
Fetch a specific admission form (populated fields)
Parameters
- formId: string
- admissionId: string
- patientId: string
Returns Promise<FormInstanceResponse>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:138

fetchAdmittedCensus

fetchAdmittedCensus(from: string, until: string): Promise<CensusRecord[]>
Fetch admitted census data within a date range.
Parameters
- from: string
- until: string
Returns Promise<CensusRecord[]>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:93

fetchAssessmentScores

fetchAssessmentScores(
    from: string,
    until: string,
    assessmentName: string,
): Promise<AssessmentScoreRecord[]>
Fetch assessment scores report for a date range and assessment type
Parameters
- from: string
- until: string
- assessmentName: string
Returns Promise<AssessmentScoreRecord[]>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:256

fetchDiagnosisChanges

fetchDiagnosisChanges(from: string): Promise<DiagnosisRecord[]>
Fetch diagnosis changes report
Parameters
- from: string
Returns Promise<DiagnosisRecord[]>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:283

fetchDischargedCensus

fetchDischargedCensus(from: string, until: string): Promise<CensusRecord[]>
Fetch discharged census data within a date range.
Parameters
- from: string
- until: string
Returns Promise<CensusRecord[]>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:119

fetchFormDataActive

fetchFormDataActive(
    formId: string,
    from: string,
    until: string,
): Promise<FormDataRecord[]>
Fetch form data for active patients in date range
Parameters
- formId: string
- from: string
- until: string
Returns Promise<FormDataRecord[]>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:163

fetchFormDataAdmitted

fetchFormDataAdmitted(
    formId: string,
    from: string,
    until: string,
): Promise<FormDataRecord[]>
Fetch form data for admitted patients in date range
Parameters
- formId: string
- from: string
- until: string
Returns Promise<FormDataRecord[]>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:175

fetchFormDataDischarged

fetchFormDataDischarged(
    formId: string,
    from: string,
    until: string,
): Promise<FormDataRecord[]>
Fetch form data for discharged patients in date range
Parameters
- formId: string
- from: string
- until: string
Returns Promise<FormDataRecord[]>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:187

fetchFormInstance

fetchFormInstance(
    formId: string,
    instanceId: string,
    admissionId: string,
    patientId: string,
): Promise<FormInstanceResponse>
Fetch form instance detail
Parameters
- formId: string
- instanceId: string
- admissionId: string
- patientId: string
Returns Promise<FormInstanceResponse>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:150

fetchForms

fetchForms(): Promise<FormListItem[]>
List all form definitions for the clinic

Returns Promise<FormListItem[]>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:132

fetchGroupNotes

fetchGroupNotes(date: string): Promise<GroupNote[]>
Fetch group notes for a specific date
Parameters
- date: string
Returns Promise<GroupNote[]>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:275

fetchLabResult

fetchLabResult(
    patientId: string,
    admissionId: string,
    formId: string,
    resultId: string,
): Promise<LabResult>
Fetch a single lab result by ID (HL7 format)
Parameters
- patientId: string
- admissionId: string
- formId: string
- resultId: string
Returns Promise<LabResult>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:217

fetchLabResults

fetchLabResults(
    patientId: string,
    admissionId: string,
    formId: string,
): Promise<LabResultSummary[]>
Fetch patient lab results list (HL7 format)
Parameters
- patientId: string
- admissionId: string
- formId: string
Returns Promise<LabResultSummary[]>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:205

fetchPatientDiagnosis

fetchPatientDiagnosis(
patientId: string,
admissionId: string,
): Promise<DiagnosisRecord[]>
Fetch diagnostic codes for a patient admission
Parameters
- patientId: string
- admissionId: string
Returns Promise<DiagnosisRecord[]>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:232

fetchPatientPrograms

fetchPatientPrograms(
patientId: string,
admissionId: string,
): Promise<PatientProgram[]>
Fetch patient programs for an admission
Parameters
- patientId: string
- admissionId: string
Returns Promise<PatientProgram[]>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:243

fetchProgramChanges

fetchProgramChanges(from: string): Promise<PatientProgram[]>
Fetch program changes report
Parameters
- from: string
Returns Promise<PatientProgram[]>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:293

fetchRealms

fetchRealms(): Promise<RealmsResponse>
Fetch all realms and their service facilities. Used for the location selector in the integration wizard.

Returns Promise<RealmsResponse>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:85

fetchURReport

fetchURReport(from: string, until: string): Promise<UtilizationReviewRecord[]>
Fetch utilization review report
Parameters
- from: string
- until: string
Returns Promise<UtilizationReviewRecord[]>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:303

fetchUsers

fetchUsers(): Promise<User[]>
Fetch all staff users for the clinic

Returns Promise<User[]>
- Defined in packages/legacy/src/integrations/sunwave/sunwave-api.ts:316

Class SunwaveApiClient

Index

Constructors

Methods

Constructors

constructor

Parameters

base_url: string

client_id: string

rpa_vault_user_id: string

rpa_workflow_id: string

secret_key: string

Returns SunwaveApiClient

Methods

fetchActiveCensus

Parameters

Returns Promise<CensusRecord[]>

fetchAdmissionForm

Parameters

Returns Promise<FormInstanceResponse>

fetchAdmittedCensus

Parameters

Returns Promise<CensusRecord[]>

fetchAssessmentScores

Parameters

Returns Promise<AssessmentScoreRecord[]>

fetchDiagnosisChanges

Parameters

Returns Promise<DiagnosisRecord[]>

fetchDischargedCensus

Parameters

Returns Promise<CensusRecord[]>

fetchFormDataActive

Parameters

Returns Promise<FormDataRecord[]>

fetchFormDataAdmitted

Parameters

Returns Promise<FormDataRecord[]>

fetchFormDataDischarged

Parameters

Returns Promise<FormDataRecord[]>

fetchFormInstance

Parameters

Returns Promise<FormInstanceResponse>

fetchForms

Returns Promise<FormListItem[]>

fetchGroupNotes

Parameters

Returns Promise<GroupNote[]>

fetchLabResult

Parameters

Returns Promise<LabResult>

fetchLabResults

Parameters

Returns Promise<LabResultSummary[]>

fetchPatientDiagnosis

Parameters

Returns Promise<DiagnosisRecord[]>

fetchPatientPrograms

Parameters

Returns Promise<PatientProgram[]>

fetchProgramChanges

Parameters

Returns Promise<PatientProgram[]>

fetchRealms

Returns Promise<RealmsResponse>

fetchURReport

Parameters

Returns Promise<UtilizationReviewRecord[]>

fetchUsers

Returns Promise<User[]>

Settings

On This Page