Are you a Suki partner?To use any Suki API or SDK, you must be a Suki partner. Contact the partnership team to begin the onboarding process. They help you set up your authentication system and get started with the Suki APIs and SDKs.
Patient Summaries are generated from data available in Suki’s Clinical Knowledge Graph (CKG). Summary quality depends on the completeness, accuracy, and freshness of the ingested clinical data.
Available APIs
The following set of APIs are available for the Patient Summary generation workflow. View each card below to learn about the endpoints and how to use them.Authentication
Endpoints to authenticate and obtain tokens used to authorize Patient Summary API requests.
CKG Data Ingestion
Endpoints to upload FHIR bundles into CKG so summaries can be generated.
Summary Generation
Endpoints to trigger asynchronous summary generation jobs.
Patient Summaries
Endpoints to retrieve full summaries and pre-visit summaries.
Summary Jobs
Endpoints to poll generation status and track job progress.
Authentication
For an overview of Suki’s supported authentication mechanisms refer to Authentication mechanisms. We recommend using OAuth 2.0 with JWT tokens for your authentication system. If you know what your authentication model is, refer to the following guides to get started:Single Auth Token Authentication
Standard Provider Authentication
Bearer Partner Authentication
- Use same
sdp_suki_tokenby calling the Authentication endpoints. - Obtain
organization_idduring the Partner onboarding process. - Must be a RS256 signed JWT token with the
sdp_partner_idclaim. - The token must be valid (not expired) and include required method scopes for the endpoint being called.
Key capabilities
The Patient Summary APIs provide the following capabilities, so you can upload clinical data, generate AI-powered Patient Summaries, and retrieve structured insights for pre-visit preparation and clinical workflows.FHIR Data Ingestion
Upload FHIR bundles to Suki’s Clinical Knowledge Graph (CKG) using pre-signed upload URLs, then poll ingestion status until processing completes.
AI-Generated Patient Summaries
Trigger asynchronous summary generation for encounters or scheduled appointments, then retrieve comprehensive Patient Summaries with clinical history, medications, and diagnoses.
Pre-Visit Summaries
Retrieve the pre-visit section of a Patient Summary using a dedicated endpoint, created specifically for the user interface (UI) to display a preview to the provider.
Encounter and Practitioner Scoping
Retrieve summaries scoped to specific encounter and practitioner identifiers, so each clinician sees summaries relevant to their scheduled patients.
Asynchronous Processing
Trigger summary generation jobs and poll job status until completion, allowing your application to handle long-running summary generation without blocking.
Structured Clinical Data
Retrieve Patient Summaries with four specific sections: About Visit, Patient Summary, Previous Visit, and Problems, for EHR integration and review workflows.
Requirements
Before you can use the Patient Summary APIs, you need to meet the following requirements:- You must be a Suki partner. Learn more about how to become a Suki partner in the Partner onboarding documentation.
- A standards-based authentication system (for example OAuth 2.0 or OpenID Connect with JWTs) for Patient Summary authentication.
- Ability to generate and sign SDP JWT bearer tokens for CKG Data Ingestion endpoints.
- FHIR R4 bundles containing patient clinical data (for example conditions, medications, encounters, observations).
- Patient, encounter, and practitioner identifiers that remain consistent across FHIR uploads and summary retrieval requests.
What you can build
Use the Patient Summary APIs to build custom workflows for generating and displaying AI-powered Patient Summaries. Control when summaries are generated, how FHIR data is uploaded, and how summaries are presented or integrated into your product. You can align Patient Summary workflows with:- Pre-visit preparation and appointment scheduling.
- Clinical decision support and care coordination.
- Patient chart review and encounter preparation.
- EHR integration and clinical workflow optimization.
Common use cases
Pre-Visit Patient Summaries
Upload FHIR data before scheduled appointments, generate summaries for upcoming encounters, then display the retrieved pre-visit section as a preview in the provider’s schedule interface.
Encounter-Based Summary Generation
Trigger summary generation for active encounters, poll job status until completion, then retrieve comprehensive Patient Summaries for clinical review before or during the visit.
EHR-Integrated Patient Summaries
Map FHIR clinical data from your EHR, generate summaries through the API, then integrate retrieved summaries back into your EHR review workflows or clinician dashboards.
API versioning
All endpoints use the/api/v1/ prefix. v1 is the stable version. Non-breaking changes may ship without a major version jump. For policies and migration, refer to API guidelines.
These APIs may include Early Access features. If you are unsure what is enabled for your account, contact your Suki representative.
Suki Patient Summary APIs workflow
To integrate with the Patient Summary APIs, you follow a CKG ingestion and summary generation workflow.Developer workflow
Authenticate and Obtain Tokens
Authenticate using Login or Register to obtain your
sdp_suki_token for Patient Summary endpoints. Generate your SDP JWT bearer token for CKG Data Ingestion endpoints.Upload FHIR Data to CKG
Request a pre-signed upload URL from the CKG Data Ingestion API, upload your FHIR bundle JSON to the returned
upload_url, and poll ingestion status until processing completes.Trigger Patient Summary Generation
Trigger asynchronous summary generation for an encounter or a provider’s scheduled appointments using the Summary Generation endpoints.
Poll Summary Job Status
Poll the Summary Jobs endpoints to track generation progress until the job reaches a terminal status (completed, failed, or archived).
Retrieve Patient Summaries
Retrieve the full Patient Summary or the pre-visit section through the Patient Summaries endpoints when generation completes.