Sign in

v1

latestOpenAPI 3.0.12026-07-2649123153.6 KB
/api/v1/form-filling/session

Create form-filling session

Creates a form-filling session for structured medical form capture. Returns a session ID in the ambient_session_id response field. That ID identifies the form-filling session for context, streaming, status, structured-data, and feedback APIs. It is not an ambient clinical documentation session ID.

post/api/v1/form-filling/session/create

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

ambient_session_idstring

Optional - Form-filling session ID in UUID format. Suki generates one when omitted and returns it in the ambient_session_id response field. Do not pass an ambient clinical documentation session ID.

correlation_idstring

Optional - Client-supplied identifier for tracing or correlating requests.

Example request

{
  "ambient_session_id": "123dfg-456dfg-789dfg-012dfg",
  "correlation_id": "123dfg-456dfg-789dfg-012dfg"
}

Response

Resource created successfully.

ambient_session_idstring

Form-filling session ID for subsequent form-filling API calls. Despite the field name, this is not an ambient clinical documentation session ID.

Example response

{
  "ambient_session_id": "123dfg-456dfg-789dfg-012dfg"
}