Batch Job Reference

This page lists the Batch2 batch jobs registered in Smile CDR, the job ID used to invoke each one, and the parameters a caller typically supplies. When invoking a job from a custom scheduled job, the job ID is the value placed after the batch: prefix in the target field — for example batch:REINDEX.

The Scheduled job candidate column indicates how well-suited each job is to being run automatically on a recurring schedule:

• Yes — Routine, idempotent maintenance work that is commonly scheduled.
• Situational — Can be scheduled, but is more often triggered on demand. Schedule only when the inputs are stable and known ahead of time.
• No (destructive) — Permanently removes data and should be run deliberately, not automated.
• No (internal) — Triggered automatically by an operation or request. Its parameters (internal PIDs, Task IDs, request context) are not known ahead of time, so it cannot be driven by a scheduled job.

Job Catalog

Example Parameters

The examples below show the parameters object for each job that can be driven from a custom scheduled job. Each is the serialized form of the job's Batch2 parameters model, so the field names must match exactly. Two things to note:

• URL-based resource selection is expressed as partitionedUrl — a list of { "url": ... } objects — not a bare url field. Each entry may optionally carry a requestPartitionId (e.g. { "url": "Patient?", "requestPartitionId": { "allPartitions": true } }).
• These objects are shown pretty-printed for readability. When placing one in the parameters field of a scheduled job, it must be supplied as an escaped JSON string, as shown in that endpoint's examples.

The No (internal) jobs are omitted here: their parameters (internal PIDs, Task IDs, request context) are supplied by the platform and cannot be authored by hand.

{
  "partitionedUrl": [
    { "url": "Patient?" },
    { "url": "Observation?status=final" }
  ],
  "batchSize": 1000,
  "optimizeStorage": "CURRENT_VERSION",
  "reindexSearchParameters": "ALL"
}

{
  "partitionedUrl": [
    { "url": "Patient?" }
  ],
  "batchSize": 500
}

{
  "resourceTypes": ["Patient", "Observation"],
  "since": "2026-01-01T00:00:00.000Z",
  "exportStyle": "GROUP",
  "groupId": "Group/123",
  "expandMdm": true,
  "outputFormat": "application/fhir+ndjson"
}

{
  "ndJsonUrls": [
    "https://example.com/data/patients.ndjson",
    "https://example.com/data/observations.ndjson"
  ],
  "maxBatchResourceCount": 500
}

{
  "partitionedUrl": [
    { "url": "AuditEvent?date=lt2025-01-01" }
  ],
  "batchSize": 1000,
  "cascade": false
}

{
  "resourceType": ["Patient"],
  "batchSize": 500
}

Notes

• This list reflects the jobs registered in HAPI's JobDefinitionRegistry plus the CDR-specific jobs. The authoritative set of job IDs available at runtime can be queried through the batch job admin endpoint.
• Parameter names and the full set of options for the core jobs are documented on each feature page: Bulk Export, Bulk Import, Delete Expunge, and Search Parameter Reindexing.
• Jobs marked No (internal) are listed for completeness. They are invoked by the platform in response to an operation or request and are not intended to be started from a custom scheduled job.