SUsuki
/api/v1/fhir-push

GET /api/v1/fhir-push/upload-url?organization_id={uuid}&correlation_id={optional}

Changed on

Request a pre-signed upload URL for uploading a FHIR bundle to Suki's Clinical Knowledge Graph (CKG) ingestion pipeline. This is Step 1 of the three-step CKG Data Ingestion workflow. The returned upload_url is valid for 15 minutes and accepts a PUT request with your FHIR bundle JSON (max 500 MB). Use the transaction_id from the response to poll processing status via GET /api/v1/fhir-push/status/{transaction_id}. FHIR data ingested through this API powers Patient Summary generation. Include consistent patient, encounter, and practitioner identifiers in your FHIR resources so they match the fhir_encounter_id and fhir_practitioner_id values used for generation and retrieval.

get/api/v1/fhir-push/upload-url

Request

  • Base URL
    https://sdp.suki.ai
  • URL
    https://sdp.suki.ai/api/v1/fhir-push/upload-url
  • Auth
    API key in header sdp_suki_token

Query parameters

organization_idstring required

Your partner organization ID for this organization, chosen at provisioning (required). It can be a UUID or non-UUID string. But not a Suki UUID.

correlation_idstring

Optional client-defined identifier for ordering or correlating uploads (max 128 chars). If omitted the server generates one.

Response

Upload URL returned successfully.

transaction_idstring required

Unique identifier for this upload transaction.

upload_urlstring required

Pre-signed URL to PUT your FHIR bundle to (expires in ~15 minutes).

expires_atstring date-time required

RFC 3339 timestamp when the upload_url expires.

correlation_idstring

Echo of client-supplied correlation_id or server-generated value.

Changes