Class SyncIntegrationJobbable

Hourly per-integration orchestrator: facility refresh → census inline → fan out one SyncPatientAndCheckTriggers per active patient. Carries no per-patient logic of its own.

Hierarchy (View Summary)

Jobbable<SyncIntegrationJobParams, void>
- SyncIntegrationJobbable

Index

Constructors

constructor

new SyncIntegrationJobbable(): SyncIntegrationJobbable
Returns SyncIntegrationJobbable
Inherited from Jobbable.constructor

Properties

`Readonly`config

config: JobConfig = ...

`Readonly`serviceName

serviceName: "SyncIntegrationJobbable"

Stable, human-readable name for the service. Must be set explicitly on each subclass because this.constructor.name gets mangled by minification in production builds, which breaks tracing/observability span names.

Accessors

`Protected`logger

get logger(): ConsoleLogger
Returns ConsoleLogger
Inherited from Jobbable.logger
- Defined in packages/vqs/src/jobbable.ts:51

name

get name(): string
Returns string
Inherited from Jobbable.name
- Defined in packages/base-service/src/index.ts:83

Methods

defaultKey

defaultKey(
    params: {
        entityId: EntityId;
        fromDate?: string;
        integrationId: IntegrationId;
        toDate?: string;
    },
): string
Parameters
- params: {
      entityId: EntityId;
      fromDate?: string;
      integrationId: IntegrationId;
      toDate?: string;
  }
  - entityId: EntityId
  - OptionalfromDate?: string
    Explicit window for the manual "Fetch episodes" action. Threaded straight to the census, which enumerates every episode in the window and fans out per-episode document syncs (the backfill). Absent on the hourly cron — census then uses its default 7-day window with no per-episode fan-out.
  - integrationId: IntegrationId
  - OptionaltoDate?: string
Returns string
Inherited from Jobbable.defaultKey
- Defined in packages/vqs/src/jobbable.ts:64

entityId

entityId(
    params: {
        entityId: EntityId;
        fromDate?: string;
        integrationId: IntegrationId;
        toDate?: string;
    },
): EntityId
Extract an entityId from params for job_executions tracking. Override in subclasses when applicable.
Parameters
- params: {
      entityId: EntityId;
      fromDate?: string;
      integrationId: IntegrationId;
      toDate?: string;
  }
  - entityId: EntityId
  - OptionalfromDate?: string
    Explicit window for the manual "Fetch episodes" action. Threaded straight to the census, which enumerates every episode in the window and fans out per-episode document syncs (the backfill). Absent on the hourly cron — census then uses its default 7-day window with no per-episode fan-out.
  - integrationId: IntegrationId
  - OptionaltoDate?: string
Returns EntityId
Overrides Jobbable.entityId
- Defined in packages/services/src/integrations/syncIntegration.jobbable.ts:49

jobKey

jobKey(
    params: {
        entityId: EntityId;
        fromDate?: string;
        integrationId: IntegrationId;
        toDate?: string;
    },
): string
| null
Derive a deduplication key from the params. Return null to skip deduplication (every call enqueues).
Parameters
- params: {
      entityId: EntityId;
      fromDate?: string;
      integrationId: IntegrationId;
      toDate?: string;
  }
  - entityId: EntityId
  - OptionalfromDate?: string
    Explicit window for the manual "Fetch episodes" action. Threaded straight to the census, which enumerates every episode in the window and fans out per-episode document syncs (the backfill). Absent on the hourly cron — census then uses its default 7-day window with no per-episode fan-out.
  - integrationId: IntegrationId
  - OptionaltoDate?: string
Returns string | null
Overrides Jobbable.jobKey
- Defined in packages/services/src/integrations/syncIntegration.jobbable.ts:45

perform

perform(
    params: {
        entityId: EntityId;
        fromDate?: string;
        integrationId: IntegrationId;
        toDate?: string;
    },
): Promise<Safe<void>>
Parameters
- params: {
      entityId: EntityId;
      fromDate?: string;
      integrationId: IntegrationId;
      toDate?: string;
  }
  - entityId: EntityId
  - OptionalfromDate?: string
    Explicit window for the manual "Fetch episodes" action. Threaded straight to the census, which enumerates every episode in the window and fans out per-episode document syncs (the backfill). Absent on the hourly cron — census then uses its default 7-day window with no per-episode fan-out.
  - integrationId: IntegrationId
  - OptionaltoDate?: string
Returns Promise<Safe<void>>
Inherited from Jobbable.perform
- Defined in packages/base-service/src/index.ts:59

performLater

performLater(
    params: {
        entityId: EntityId;
        fromDate?: string;
        integrationId: IntegrationId;
        toDate?: string;
    },
    options?: PerformLaterOptions,
): Promise<SendResult>
Enqueue this job for async processing via Vercel Queues. Checks for deduplication via job_executions before sending.
Parameters
- params: {
      entityId: EntityId;
      fromDate?: string;
      integrationId: IntegrationId;
      toDate?: string;
  }
  - entityId: EntityId
  - OptionalfromDate?: string
    Explicit window for the manual "Fetch episodes" action. Threaded straight to the census, which enumerates every episode in the window and fans out per-episode document syncs (the backfill). Absent on the hourly cron — census then uses its default 7-day window with no per-episode fan-out.
  - integrationId: IntegrationId
  - OptionaltoDate?: string
- Optionaloptions: PerformLaterOptions
Returns Promise<SendResult>
Inherited from Jobbable.performLater
- Defined in packages/vqs/src/jobbable.ts:87

run

run(
    __namedParameters: {
        entityId: EntityId;
        fromDate?: string;
        integrationId: IntegrationId;
        toDate?: string;
    },
): Promise<void>
Parameters
- __namedParameters: {
      entityId: EntityId;
      fromDate?: string;
      integrationId: IntegrationId;
      toDate?: string;
  }
  - entityId: EntityId
  - OptionalfromDate?: string
    Explicit window for the manual "Fetch episodes" action. Threaded straight to the census, which enumerates every episode in the window and fans out per-episode document syncs (the backfill). Absent on the hourly cron — census then uses its default 7-day window with no per-episode fan-out.
  - integrationId: IntegrationId
  - OptionaltoDate?: string
Returns Promise<void>
Overrides Jobbable.run
- Defined in packages/services/src/integrations/syncIntegration.jobbable.ts:53

runTracked

runTracked(
    params: {
        entityId: EntityId;
        fromDate?: string;
        integrationId: IntegrationId;
        toDate?: string;
    },
    metadata: MessageMetadata,
): Promise<void>
Run the job with status tracking. Used by the queue handler. Errors propagate (not caught by safe()) so the RetryHandler can decide.
Parameters
- params: {
      entityId: EntityId;
      fromDate?: string;
      integrationId: IntegrationId;
      toDate?: string;
  }
  - entityId: EntityId
  - OptionalfromDate?: string
    Explicit window for the manual "Fetch episodes" action. Threaded straight to the census, which enumerates every episode in the window and fans out per-episode document syncs (the backfill). Absent on the hourly cron — census then uses its default 7-day window with no per-episode fan-out.
  - integrationId: IntegrationId
  - OptionaltoDate?: string
- metadata: MessageMetadata
Returns Promise<void>
Inherited from Jobbable.runTracked
- Defined in packages/vqs/src/jobbable.ts:150

`Protected`spanAttributes

spanAttributes(
    _params: {
        entityId: EntityId;
        fromDate?: string;
        integrationId: IntegrationId;
        toDate?: string;
    },
): Attributes
Optional hook for subclasses to attach extra non-PII span attributes derived from params. The returned attributes appear on the service.${serviceName} span (and, for jobs, on job.enqueue.* and job.run.* spans too).

Safe ID-like keys on params (e.g. patientId, templateIds, limit, cursor) are already auto-extracted via toSpanAttributes("service.input", params) — you don't need to enumerate them here. Use this hook for derived/computed attributes (counts, flags, computed names) or for fields you've explicitly verified safe but that aren't in the global allowlist. Hook output overrides auto-extracted attributes on key collision.

Safe by default: returns {} when not overridden. Only declare keys you've confirmed are non-PII. Never include emails, names, dob, free-text, etc.
Parameters
- _params: {
      entityId: EntityId;
      fromDate?: string;
      integrationId: IntegrationId;
      toDate?: string;
  }
  - entityId: EntityId
  - OptionalfromDate?: string
    Explicit window for the manual "Fetch episodes" action. Threaded straight to the census, which enumerates every episode in the window and fans out per-episode document syncs (the backfill). Absent on the hourly cron — census then uses its default 7-day window with no per-episode fan-out.
  - integrationId: IntegrationId
  - OptionaltoDate?: string
Returns Attributes
Inherited from Jobbable.spanAttributes
- Defined in packages/base-service/src/index.ts:42

`Protected`spanResultAttributes

spanResultAttributes(_result: void): Attributes
Optional hook for subclasses to attach extra non-PII span attributes derived from the successful service result. Only called when run resolves successfully; on error, the span is marked via markSpanError instead.

Safe by default: returns {} when not overridden. Only declare keys you've confirmed are non-PII (e.g. counts, status flags, computed summaries). Never include emails, names, dob, free-text, etc.
Parameters
- _result: void
Returns Attributes
Inherited from Jobbable.spanResultAttributes
- Defined in packages/base-service/src/index.ts:55

validate

validate(
    params: unknown,
): params is {
    entityId: EntityId;
    fromDate?: string;
    integrationId: IntegrationId;
    toDate?: string;
}
Parameters
- params: unknown
Returns params is {
    entityId: EntityId;
    fromDate?: string;
    integrationId: IntegrationId;
    toDate?: string;
}
Overrides Jobbable.validate
- Defined in packages/services/src/integrations/syncIntegration.jobbable.ts:41

Class SyncIntegrationJobbable

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns SyncIntegrationJobbable

Properties

Readonlyconfig

ReadonlyserviceName

Accessors

Protectedlogger

Returns ConsoleLogger

name

Returns string

Methods

defaultKey

Parameters

entityId: EntityId

OptionalfromDate?: string

integrationId: IntegrationId

OptionaltoDate?: string

Returns string

entityId

Parameters

entityId: EntityId

OptionalfromDate?: string

integrationId: IntegrationId

OptionaltoDate?: string

Returns EntityId

jobKey

Parameters

entityId: EntityId

OptionalfromDate?: string

integrationId: IntegrationId

OptionaltoDate?: string

Returns string | null

perform

Parameters

entityId: EntityId

OptionalfromDate?: string

integrationId: IntegrationId

OptionaltoDate?: string

Returns Promise<Safe<void>>

performLater

Parameters

entityId: EntityId

OptionalfromDate?: string

integrationId: IntegrationId

OptionaltoDate?: string

Returns Promise<SendResult>

run

Parameters

entityId: EntityId

OptionalfromDate?: string

integrationId: IntegrationId

OptionaltoDate?: string

Returns Promise<void>

runTracked

Parameters

entityId: EntityId

OptionalfromDate?: string

integrationId: IntegrationId

OptionaltoDate?: string

Returns Promise<void>

ProtectedspanAttributes

Parameters

entityId: EntityId

OptionalfromDate?: string

integrationId: IntegrationId

OptionaltoDate?: string

Returns Attributes

ProtectedspanResultAttributes

Parameters

Returns Attributes

validate

Parameters

`Readonly`config

`Readonly`serviceName

`Protected`logger

`Optional`fromDate?: string

`Optional`toDate?: string

`Optional`fromDate?: string

`Optional`toDate?: string

`Optional`fromDate?: string

`Optional`toDate?: string

`Optional`fromDate?: string

`Optional`toDate?: string

`Optional`fromDate?: string

`Optional`toDate?: string

`Optional`fromDate?: string

`Optional`toDate?: string

`Optional`fromDate?: string

`Optional`toDate?: string

`Protected`spanAttributes

`Optional`fromDate?: string

`Optional`toDate?: string

`Protected`spanResultAttributes

Returns params is {
entityId: EntityId;
fromDate?: string;
integrationId: IntegrationId;
toDate?: string;
}