Prerequisites
Before you begin, make sure you have:- Partner credentials from Partner onboarding.
- A working authentication path for Patient Summary APIs.
- Ability to generate and sign the SDP JWT required for CKG ingestion.
- FHIR R4 patient, encounter, practitioner, schedule, and history data for the appointments you want to summarize.
- Stable identifiers such as
fhir_encounter_idandfhir_practitioner_id.
What Patient Summary includes
A completed summary contains the following sections:- Patient Summaries are generated for patients with scheduled appointments on a provider’s schedule. Before generating a summary, you must ingest the patient’s FHIR data into CKG.
- The content, historical lookback period, and summary length depend on your implementation and configured requirements.
Why use Patient Summary
Use Patient Summary to:- Prepare clinicians before scheduled appointments.
- Display structured patient history in your schedule, chart, or patient profile.
- Generate summaries from FHIR data ingested into the Clinical Knowledge Graph (CKG).
- Reduce chart review time by providing a concise pre-visit overview.
Common use cases
Use Patient Summary to support pre-visit workflows in your application.Schedule preview
Generate summaries for scheduled appointments and display a pre-visit preview in your schedule or appointment list.
Patient chart review
Retrieve the full Patient Summary when a clinician opens a patient chart to review recent history before the encounter.
Scheduled generation
Generate summaries for an entire provider schedule ahead of the clinic day so they are ready when clinicians need them.
On-demand generation
Generate a summary for a single encounter when a patient is added to the schedule or when new clinical data becomes available.
Typical integration flow
A typical Patient Summary integration consists of these steps:1
Ingest FHIR Data
Ingest patient FHIR data into the Clinical Knowledge Graph (CKG).
2
Generate Summaries
Generate summaries for scheduled appointments or individual encounters.
3
Monitor the Job
Monitor the asynchronous generation job until it completes.
4
Retrieve the Summary
Retrieve the completed summary.
5
Present in Your App
Present the summary in your application’s pre-visit experience, such as a schedule view, patient chart, or appointment details page.
Your application determines when summaries are generated, how often generation is triggered, and how the retrieved summary is presented to clinicians.
High-level architecture
Patient Summary is generated using the clinical data available in the Clinical Knowledge Graph (CKG). The quality and completeness of the generated summary depend on the quality, completeness, and freshness of the data you ingest into CKG. To learn more about the generation workflow, lifecycle, and limitations, see How Patient Summary works.Related guides
Architecture
Lifecycle, data flow, background jobs, and summary section behavior.
Integrate CKG
Why CKG is required and how daily FHIR ingestion works.
Generate Summaries
Choose scheduled-appointment or single-encounter generation.
API Basic Usage
Step-by-step Partner API workflow from CKG upload to summary retrieval.
Resources
Refer to these references when you are ready to integrate:Patient Summary APIs Overview
REST endpoints for ingestion, generation, jobs, and retrieval.
Patient Summary API Quickstart
Staging scripts for one successful end-to-end Patient Summary path.