Share One Note Across Products

Problem: Ambient APIs, Mobile, and Web do not share the same clinical note for a visit. Solution: Pass a UUID emr_encounter_id on Create ambient session to make the note interoperable. You can also provide encounter_id. If you do, store and reuse that value for every re-ambient session on the note. In the Web SDK, encounter.identifier maps to emr_encounter_id.

This cookbook assumes you already have your Partner ID, authentication tokens, and the other prerequisites for Ambient APIs or the Web SDK.

CURL
Python
TypeScript

curl --request POST \
  --url https://sdp.suki.ai/api/v1/ambient/session/create \
  --header 'Content-Type: application/json' \
  --header 'sdp_suki_token: <sdp_suki_token>' \
  --header 'sdp_provider_id: <sdp_provider_id>' \
  --data '{
    "emr_encounter_id": "6ec3920f-b0b1-499d-a4e9-889bf788e5ab",
    "encounter_id": "visit-note-1"
  }'

import requests

response = requests.post(
    "https://sdp.suki.ai/api/v1/ambient/session/create",
    headers={
        "Content-Type": "application/json",
        "sdp_suki_token": sdp_suki_token,
        "sdp_provider_id": sdp_provider_id,
    },
    json={
        "emr_encounter_id": "6ec3920f-b0b1-499d-a4e9-889bf788e5ab",
        "encounter_id": "visit-note-1",
    },
)
response.raise_for_status()
data = response.json()

ambient_session_id = data["ambient_session_id"]
composition_id = data["composition_id"]

const response = await fetch("https://sdp.suki.ai/api/v1/ambient/session/create", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    sdp_suki_token: sdpSukiToken,
    sdp_provider_id: sdpProviderId,
  },
  body: JSON.stringify({
    emr_encounter_id: "6ec3920f-b0b1-499d-a4e9-889bf788e5ab",
    encounter_id: "visit-note-1",
  }),
});

if (!response.ok) {
  throw new Error(`Create ambient session failed: ${response.status}`);
}

const data = await response.json();
const ambientSessionId = data.ambient_session_id;
const compositionId = data.composition_id;

{
  "ambient_session_id": "<ambient_session_id>",
  "composition_id": "<composition_id>"
}

Common mistakes

Omit emr_encounter_id and the note is not interoperable.
Provide encounter_id, but do not store it. The create response does not return this value, and you must reuse it for every re-ambient session on the note.
emr_encounter_id must be a UUID. Wait at least 1 second between creates for the same encounter.

Other cookbooks

AmbientAPI

Clear a Remote Session Conflict

End remote session, then retry.

5 min

AmbientAPIWeb SDK

Seed Patient Context for the Web SDK

Seed patient context for Web SDK.

5 min

​Common mistakes

​Other cookbooks

​Clear a Remote Session Conflict

​Seed Patient Context for the Web SDK

Common mistakes

Other cookbooks

Clear a Remote Session Conflict

Seed Patient Context for the Web SDK