v1

latestOpenAPI 3.0.1Public Domain2026-07-171996134.0 KB
job

Get job(s) by status

Returns the current statuses of all current and past export jobs, along with the original job request url. Supported status types are:

  • Completed

  • Archived

  • Expired

  • Failed

  • FailedExpired

  • In Progress

  • Pending

  • Cancelled

  • CancelledExpired

If no status(s) is provided, all jobs will be returned.

Note on job status to fhir task resource status mapping: Due to the fhir task status field having a smaller set of values, the following statuses will be set to different fhir values in the response

  • Archived, Expired -> Completed

  • FailedExpired -> Failed

  • Pending -> In Progress

  • CancelledExpired -> Cancelled

Though the status name has been remapped the response will still only contain jobs pertaining to the provided job status in the request.

get/api/v1/jobs

Query parameters

_statusJobStatus[]

Job statuses requested

Response

JSON object containing statuses of all current and previously requested jobs. The body will contain a FHIR Bundle resource in JSON format https://www.hl7.org/fhir/bundle.html and FHIR Task resources for the Bundle entries in JSON format https://www.hl7.org/fhir/task.html