Update Session 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 @- <<EOF
{
  "diagnoses": {
    "values": [
      {
        "codes": [
          {
            "code": "30422",
            "description": "Essential hypertension",
            "type": "IMO"
          }
        ],
        "diagnosis_note": "Hypertension"
      }
    ]
  },
  "patient": {
    "dob": "2000-01-01",
    "sex": "male"
  },
  "provider": {
    "provider_role": "ATTENDING",
    "specialty": "CARDIOLOGY"
  },
  "sections": [
    {
      "loinc": "10164-2"
    }
  ],
  "visit": {
    "chief_complaint": "Headache (Patient's primary symptom or problem stated in their own words)",
    "encounter_type": "AMBULATORY",
    "reason_for_visit": "Follow-up for migraines",
    "visit_type": "ESTABLISHED_PATIENT"
  }
}
EOF

{
  "context": {
    "diagnoses": {
      "values": [
        {
          "codes": [
            {
              "code": "30422",
              "description": "Essential hypertension",
              "type": "IMO"
            }
          ],
          "diagnosis_note": "Hypertension"
        }
      ]
    },
    "patient": {
      "dob": "2000-01-01",
      "sex": "male"
    },
    "provider": {
      "provider_role": "ATTENDING",
      "specialty": "CARDIOLOGY"
    },
    "sections": [
      {
        "loinc": "10164-2"
      }
    ],
    "visit": {
      "chief_complaint": "Headache (Patient's primary symptom or problem stated in their own words)",
      "encounter_type": "AMBULATORY",
      "reason_for_visit": "Follow-up for migraines",
      "visit_type": "ESTABLISHED_PATIENT"
    }
  }
}

PATCH

api

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 @- <<EOF
{
  "diagnoses": {
    "values": [
      {
        "codes": [
          {
            "code": "30422",
            "description": "Essential hypertension",
            "type": "IMO"
          }
        ],
        "diagnosis_note": "Hypertension"
      }
    ]
  },
  "patient": {
    "dob": "2000-01-01",
    "sex": "male"
  },
  "provider": {
    "provider_role": "ATTENDING",
    "specialty": "CARDIOLOGY"
  },
  "sections": [
    {
      "loinc": "10164-2"
    }
  ],
  "visit": {
    "chief_complaint": "Headache (Patient's primary symptom or problem stated in their own words)",
    "encounter_type": "AMBULATORY",
    "reason_for_visit": "Follow-up for migraines",
    "visit_type": "ESTABLISHED_PATIENT"
  }
}
EOF

{
  "context": {
    "diagnoses": {
      "values": [
        {
          "codes": [
            {
              "code": "30422",
              "description": "Essential hypertension",
              "type": "IMO"
            }
          ],
          "diagnosis_note": "Hypertension"
        }
      ]
    },
    "patient": {
      "dob": "2000-01-01",
      "sex": "male"
    },
    "provider": {
      "provider_role": "ATTENDING",
      "specialty": "CARDIOLOGY"
    },
    "sections": [
      {
        "loinc": "10164-2"
      }
    ],
    "visit": {
      "chief_complaint": "Headache (Patient's primary symptom or problem stated in their own words)",
      "encounter_type": "AMBULATORY",
      "reason_for_visit": "Follow-up for migraines",
      "visit_type": "ESTABLISHED_PATIENT"
    }
  }
}

Use this endpoint to update the context for a session. You can update specific fields of the context for an ambient session. This is a PATCH operation that allows partial updates to the session context.

Updated:

The request body for this endpoint now supports the new visit and provider_role fields.
The response will now include the new visit field within the payload. The visit field contains information about the visit such as chief complaint, encounter type, reason for visit, and visit type.
The response will now include the new provider_role field within the payload. The provider_role field contains information about the provider.

Comparison with POST Context

Feature	POST (Seed)	PATCH (Update)
Purpose	Set entire context all at once when available	Incrementally build context as information becomes available
Data Approach	Complete context payload	Partial context updates
Timing	Before EndSession. When you have all context information together.	Before EndSession. As information becomes available progressively
Behavior	Replaces entire context	Updates only specified fields

To avoid request failures, you must ensure the data you send adheres to the following validation rules:

The chief_complaint and reason_for_visit fields must not exceed 255 characters.
The visit_type, encounter_type, and provider_role fields function as enums and only accept a specific set of predefined string values. You must use one of the allowed values for these fields, as any other string will cause the request to fail.

For the list of allowed values, refer to the Encounter-types, Visit-types, and Provider-roles.

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

Show child attributes

diagnoses.values

object[]

Optional - Array of diagnosis requests

Show child attributes

diagnoses.values.codes

object[]

Optional - Codes associated with the diagnosis

Show child attributes

diagnoses.values.codes.code

string

Code value

Example:

"30422"

diagnoses.values.codes.description

string

Description of the code

Example:

"Essential hypertension"

diagnoses.values.codes.type

enum<string>

Available options:

UNSPECIFIED,

IMO,

ICD10

Example:

"IMO"

diagnoses.values.diagnosis_note

string

Optional - Diagnosis note

Example:

"Hypertension"

patient

object

Optional - Information about the patient

Show child attributes

patient.dob

string

Optional - {YYYY-MM-DD}

Example:

"2000-01-01"

patient.sex

enum<string>

Optional

Available options:

male,

female,

other,

unknown

Example:

"male"

provider

object

Optional - Information about the provider

Show child attributes

provider.provider_role

enum<string>

Defines the role of the provider for the session

Available options:

ATTENDING,

CONSULTING

Example:

"ATTENDING"

provider.specialty

string

Optional

Example:

"CARDIOLOGY"

sections

object[]

Optional - Information about the sections to be generated. If not provided, all supported note-sections will be generated.

Show child attributes

sections.loinc

string

required

LOINC code for the section. Supported Loinc codes are available at: note-sections

Example:

"10164-2"

visit

object

Optional - Information about the visit

Show child attributes

visit.chief_complaint

string

Captures the initial problem the patient presents with

Example:

"Headache (Patient's primary symptom or problem stated in their own words)"

visit.encounter_type

enum<string>

Type of encounter

Available options:

AMBULATORY,

INPATIENT,

EMERGENCY

Example:

"AMBULATORY"

visit.reason_for_visit

string

Specific symptom / condition, or request (e.g., chest pain, wellness exam)

Example:

"Follow-up for migraines"

visit.visit_type

enum<string>

Type of visit

Available options:

NEW_PATIENT,

ESTABLISHED_PATIENT,

WELLNESS,

ED

Example:

"ESTABLISHED_PATIENT"

Response

Success Response

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

context

object

Updated context for the session

Show child attributes

context.diagnoses

object

Optional - Information about the diagnoses

Show child attributes

context.diagnoses.values

object[]

Optional - Array of diagnosis requests

Show child attributes

context.diagnoses.values.codes

object[]

Optional - Codes associated with the diagnosis

Show child attributes

context.diagnoses.values.codes.code

string

Code value

Example:

"30422"

context.diagnoses.values.codes.description

string

Description of the code

Example:

"Essential hypertension"

context.diagnoses.values.codes.type

enum<string>

Available options:

UNSPECIFIED,

IMO,

ICD10

Example:

"IMO"

context.diagnoses.values.diagnosis_note

string

Optional - Diagnosis note

Example:

"Hypertension"

context.patient

object

Optional - Information about the patient

Show child attributes

context.patient.dob

string

Optional - {YYYY-MM-DD}

Example:

"2000-01-01"

context.patient.sex

enum<string>

Optional

Available options:

male,

female,

other,

unknown

Example:

"male"

context.provider

object

Optional - Information about the provider

Show child attributes

context.provider.provider_role

enum<string>

Defines the role of the provider for the session

Available options:

ATTENDING,

CONSULTING

Example:

"ATTENDING"

context.provider.specialty

string

Optional

Example:

"CARDIOLOGY"

context.sections

object[]

Optional - Information about the sections to be generated. If not provided, all supported note-sections will be generated.

Show child attributes

context.sections.loinc

string

required

LOINC code for the section. Supported Loinc codes are available at: note-sections

Example:

"10164-2"

context.visit

object

Optional - Information about the visit

Show child attributes

context.visit.chief_complaint

string

Captures the initial problem the patient presents with

Example:

"Headache (Patient's primary symptom or problem stated in their own words)"

context.visit.encounter_type

enum<string>

Type of encounter

Available options:

AMBULATORY,

INPATIENT,

EMERGENCY

Example:

"AMBULATORY"

context.visit.reason_for_visit

string

Specific symptom / condition, or request (e.g., chest pain, wellness exam)

Example:

"Follow-up for migraines"

context.visit.visit_type

enum<string>

Type of visit

Available options:

NEW_PATIENT,

ESTABLISHED_PATIENT,

WELLNESS,

ED

Example:

"ESTABLISHED_PATIENT"

Seeds Session Context

Session Metadata

⌘I

API Overview

API References

Update Session Context

Comparison with POST Context

Headers

Path Parameters

Body

Response

API Overview

API References

​Comparison with POST Context

Headers

Path Parameters

Body

Response

Comparison with POST Context