List a batch job's results

GET/fhir2omop/batch/{job_id}/results

A lighter status page. Returns the same per-item status entries as GET /fhir2omop/batch/{job_id}, but without the job record or counts, and the entries carry result_size rather than any result content. Use each entry's item_id to fetch that item's result from GET /fhir2omop/batch/{job_id}/results/{item_id}.

Entries are listed in a stable order that is not upload order and is the same across pages. Match each entry to your own records by its id (your correlation label) or item_id (from the upload response), never by position.

RequiresBearerauthentication

Path parameters

job_idstringrequired

Query parameters

cursorstringoptional

Opaque pagination cursor from a previous page's next_cursor.

limitintegeroptionaldefault 20

Page size. Defaults to 20; values above 100 are clamped to 100.

Returns

A page of per-item result statuses

Response fields

resultsobject[]required

item_idstringrequired

Server-assigned opaque item ID, used in result URLs.

idstringoptional

The caller's correlation label, echoed back; omitted when none was supplied.

statusstringrequired

Item status.

pendingprocessingsucceededfailed

attemptsintegerrequired

Number of processing attempts started so far. The service retries an item that was interrupted, or whose vocabulary lookups or concept inference were temporarily unavailable; any other mapping error fails the item without retry.

result_sizeinteger (int64)optional

Size in bytes of the item's stored result. Present once the item has succeeded.

errorobjectoptional

A job- or item-level failure. Never contains FHIR or patient content.

kindstringrequired

Short stable token to branch on. Item-level kinds: invalid_input (POST /fhir2omop/create would reject the item with a 400; the message is that response's message), processing_failed (the item could not be mapped; the message says why), result_too_large (the result exceeded 28 MiB), input_unavailable (the input could not be read), and retries_exhausted / attempts_exhausted (the item could not complete after repeated interruptions or after vocabulary lookups stayed unavailable; it may succeed if you upload it again in a new job). Job-level kinds: timeout (the job did not finish within 36 hours of creation).

messagestringrequired

Human-readable description of the failure.

completed_atstring (date-time)optional

When the item finished. Absent until then.

next_cursorstringoptional

Cursor for the next page, when has_more is true.

has_morebooleanrequired

Whether more results remain beyond this page.

GETRequest

# Get authentication token
PHENOML_TOKEN=$(curl -X POST "https://experiment.app.pheno.ml/v2/auth/token" \
  -u "$PHENOML_CLIENT_ID:$PHENOML_CLIENT_SECRET" \
  | jq -r '.access_token')

curl -X GET "https://experiment.app.pheno.ml/fhir2omop/batch/abc-123-def-456/results?cursor=example&limit=20" \
  -H "Authorization: Bearer $PHENOML_TOKEN"

200 OKExample Response

{
  "results": [
    {
      "item_id": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
      "id": "patient-000123",
      "status": "succeeded",
      "attempts": 1,
      "result_size": 20482,
      "error": {
        "kind": "invalid_input",
        "message": "no Patient resource found; OMOP requires at least one person"
      },
      "completed_at": "2024-01-15T09:30:00Z"
    }
  ],
  "next_cursor": "<cursor>",
  "has_more": false
}