Which organization ID should I use when requesting an upload URL?
Which organization ID should I use when requesting an upload URL?
Use your partner organization ID from your external registration with Suki. It can be a UUID or non-UUID string. But not a Suki UUID. Do not use an internal Suki organization ID. Suki maps your partner organization ID to the correct internal organization and Clinical Knowledge Graph (CKG).
How do I authenticate with the CKG Data Ingestion APIs?
How do I authenticate with the CKG Data Ingestion APIs?
Use the same Suki Token (
sdp_suki_token) returned by the Login API.How long is the upload URL valid?
How long is the upload URL valid?
The pre-signed Google Cloud Storage (GCS) upload URL expires after 15 minutes. If the URL expires before you upload, request a new upload URL.
What is the maximum upload size?
What is the maximum upload size?
Each FHIR bundle can be up to 500 MB.
What format should the uploaded file use?
What format should the uploaded file use?
Upload a raw JSON file containing a FHIR Bundle of type
transaction. Each entry should use a PUT request so CKG can create or update resources by id. The bundle must follow the FHIR R4 specification and include only supported resource types. For a complete sample, refer to Example FHIR R4 bundle.Can a bundle contain data from multiple organizations?
Can a bundle contain data from multiple organizations?
No. All resources in a bundle must belong to the same organization.
Does Suki validate resource references during ingestion?
Does Suki validate resource references during ingestion?
No. Suki does not enforce referential integrity during ingestion. Ingestion can succeed even if a resource references another resource that has not been ingested yet.
When should I use a correlation ID?
When should I use a correlation ID?
Set the correlation ID to the original tracking identifier when uploading updates for a previous ingestion. This ensures Suki processes related updates in order and helps avoid conflicting changes.
Is the data available immediately after the upload succeeds?
Is the data available immediately after the upload succeeds?
No. A successful
PUT confirms the file was stored. Suki processes the file asynchronously after upload completes. Poll the ingestion status endpoint or configure webhooks to learn when processing finishes.Why does generate fail even when ingestion is COMPLETED?
Why does generate fail even when ingestion is COMPLETED?
In such scenarios, the encounter date is the cause. Patient Summary expects the encounter start date to be for the current day. If you call generate with an older encounter, the API can return code
5 with failed to generate patient summary for fhir encounter, even when CKG ingestion is COMPLETED and your fhir_encounter_id and fhir_practitioner_id match the bundle.This is not always an ingestion or ID problem. Update the encounter start date to today in your FHIR data, ingest again if you changed the bundle, then call generate again.