/api/v1/patient-summary

Generate patient summary for an encounter

Changed on

Trigger asynchronous generation of a patient summary for a specific encounter and practitioner. The API returns 202 Accepted immediately when the job is scheduled. Generation typically completes within seconds to minutes depending on the volume of CKG data available. Poll GET /api/v1/patient-summary/encounter/{fhir_encounter_id}/practitioner/{fhir_practitioner_id}/status to check when generation completes, then retrieve the summary via the GET endpoint. Ensure FHIR data for the patient, encounter, and practitioner has been ingested via the CKG Data Ingestion API before triggering generation.

post/api/v1/patient-summary/generate/encounter

Request

  • Base URL
    https://sdp.suki.ai
  • URL
    https://sdp.suki.ai/api/v1/patient-summary/generate/encounter
  • Auth
    API key in header sdp_suki_token

Headers

sdp_provider_idstring
Example:provider-123

Optional for standard partners.

Required for:

  • Bearer authentication. Use the same provider_id returned by the Login or Register API.
  • Single Auth Token authentication. Include the same provider_id on every request as sdp_provider_id.

Request body

fhir_encounter_idstring required

FHIR encounter identifier (required).

fhir_practitioner_idstring required

FHIR practitioner identifier (required).

Response

Created. Summary generation request accepted and a patient summary resource was created.

patient_summary_idstring required

Patient summary job ID returned from generate APIs.

Changes