SUsuki
/api/v1/patient-summary

Generate patient summaries for scheduled appointments

Changed on

Trigger bulk asynchronous generation of patient summaries for all scheduled appointments on a provider's ingested schedule. Provide fhir_practitioner_id in the request body. This endpoint is optimized for pre-visit workflows where summaries need to be generated in advance before the provider's appointments begin. Returns 202 Accepted when the batch job is scheduled. Each appointment will have its own generation job that can be polled individually via the status endpoints. Use this to prepare summaries overnight or at the start of the day before the provider's appointments begin.

post/api/v1/patient-summary/generate/provider-schedule

Request

  • Base URL
    https://sdp.suki.ai
  • URL
    https://sdp.suki.ai/api/v1/patient-summary/generate/provider-schedule
  • 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_practitioner_idstring required

FHIR Practitioner resource identifier for whom to generate summaries.

Example request

{
  "fhir_practitioner_id": "Practitioner/practitioner-1"
}

Response

Accepted. Generation scheduled.

Changes