Skip to main content
PATCH
/
api
/
v1
/
ambient
/
session
/
{ambient_session_id}
/
context
Updates context for the ambient session.
curl --request PATCH \
  --url https://sdp.suki-stage.com/api/v1/ambient/session/{ambient_session_id}/context \
  --header 'Content-Type: application/json' \
  --header 'sdp_suki_token: <sdp_suki_token>' \
  --data '{
  "diagnoses": {
    "values": [
      {
        "codes": [
          {
            "code": "30422",
            "description": "Essential hypertension",
            "type": "IMO"
          }
        ],
        "diagnosis_note": "Hypertension"
      }
    ]
  },
  "patient": {
    "dob": "2000-01-01",
    "sex": "male"
  },
  "provider": {
    "specialty": "CARDIOLOGY"
  },
  "sections": [
    {
      "loinc": "10164-2"
    }
  ]
}'
{
  "context": {
    "diagnoses": {
      "values": [
        {
          "codes": [
            {
              "code": "30422",
              "description": "Essential hypertension",
              "type": "IMO"
            }
          ],
          "diagnosis_note": "Hypertension"
        }
      ]
    },
    "patient": {
      "dob": "2000-01-01",
      "sex": "male"
    },
    "provider": {
      "specialty": "CARDIOLOGY"
    },
    "sections": [
      {
        "loinc": "10164-2"
      }
    ]
  }
}

​
Comparison with POST Context

FeaturePOST (Seed)PATCH (Update)
PurposeSet entire context all at once when availableIncrementally build context as information becomes available
Data ApproachComplete context payloadPartial context updates
TimingBefore EndSession. When you have all context information together.Before EndSession. As information becomes available progressively
BehaviorReplaces entire contextUpdates only specified fields

Headers

​
sdp_suki_token
string
required

sdp_suki_token

Path Parameters

​
ambient_session_id
string
required

ambient_session_id

Body

application/json

UpdateContextRequest

Request body for the /session/{ambient_session_id}/context PATCH endpoint

​
diagnoses
object

Optional - Information about the diagnoses

​
patient
object

Optional - Information about the patient

​
provider
object

Optional - Information about the provider

​
sections
object[]

Optional - Information about the sections to be generated. If not provided, all supported sections (https://developer.suki.ai/ambient-api#note_sections) will be generated.

Response

Success Response

Response body for the /session/{ambient_session_id}/context PATCH endpoint

​
context
object

Updated context for the session

⌘I