SUsuki
/api/v1/fhir-push

Get FHIR Push transaction status

Changed on

Poll the ingestion status for a FHIR bundle upload transaction. This is Step 3 of the CKG Data Ingestion workflow. Use the transaction_id returned from GET /api/v1/fhir-push/upload-url. Status values: CREATED (transaction created, awaiting upload), READY (bundle uploaded, queued for processing), RUNNING (actively ingesting), COMPLETED (successfully ingested into CKG), FAILED (processing error, see error field), ARCHIVED (upload not received within the allowed window). Poll at reasonable intervals (e.g., every 5 seconds) and stop once you receive a terminal status (COMPLETED, FAILED, or ARCHIVED). Transaction status is retained for 7 days after the last update.

get/api/v1/fhir-push/status/{transaction_id}

Request

  • Base URL
    https://sdp.suki.ai
  • URL
    https://sdp.suki.ai/api/v1/fhir-push/status/{transaction_id}
  • Auth
    API key in header sdp_suki_token

Path parameters

transaction_idstring required

Transaction identifier returned by GET /api/v1/fhir-push/upload-url.

Response

Transaction status returned successfully.

transaction_idstring required

Unique identifier for this ingestion transaction.

organization_idstring

Your partner organization ID for this organization. It can be a UUID or non-UUID string. But not a Suki UUID.

correlation_idstring

Client-supplied or server-generated correlation ID for tracing.

statusstring required

Current transaction status: CREATED | READY | RUNNING | COMPLETED | FAILED | ARCHIVED

created_atstring date-time required

RFC 3339 timestamp when the transaction was created.

updated_atstring date-time

RFC 3339 timestamp of the last status update.

completed_atstring date-time nullable

RFC 3339 timestamp when processing completed (present for terminal statuses).

errorstring nullable

Error details when the transaction status is FAILED; otherwise null.

Changes