Create Form Filling Session
Create a Form filling session and obtain an Ambient session identifier for subsequent calls
ambient_session_id. However, these are two different identifiers and should not be treated as the same value.Code examples
sdp.suki-stage.com only as examples.
For credentials, base URLs, where to run Python or TypeScript, CORS, and cURL, refer to Using code examples in your integration in the API Reference Guidelines.- Python
- TypeScript
Authorizations
Suki access token (suki_token) from Login or Register. Expires after one hour.
Headers
Optional for standard partners.
Required for:
- Bearer authentication. Use the same
provider_idreturned by the Login or Register API. - Single Auth Token authentication. Include the same
provider_idon every request assdp_provider_id.
"provider-123"
Body
Optional form-filling session ID and correlation metadata. Suki generates a form-filling session ID when omitted.
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.
"123dfg-456dfg-789dfg-012dfg"
Optional - Client-supplied identifier for tracing or correlating requests.
"123dfg-456dfg-789dfg-012dfg"
Response
Resource created successfully.
New form-filling session ID returned after create.
Form-filling session ID for subsequent form-filling API calls. Despite the field name, this is not an ambient clinical documentation session ID.
"123dfg-456dfg-789dfg-012dfg"