Patient Info

Patient info lets you attach demographics and identifiers to an ambient session so Suki can personalize note generation for the patient in the encounter. Pass SukiAmbientConstant.kPatientInfo in setSessionContext(with:) after you create the session. All fields are optional.

dictionary

Use this parameter to provide demographic information that helps personalize the note generation.

You can now pass a partner or EMR patient id and a structured patient name when you have them.

Hide properties

date

Patient’s date of birth in yyyy-mm-dd format.

string

Patient’s gender. Valid values: “MALE” or “FEMALE”.

string

Partner or EMR patient identifier. String key: "patient_id". Optional.

dictionary

Structured patient name. String key: "name".Optional, pass one or more of the nested fields below when you have them.

Hide properties

string

Family or last name. String key: "family". Optional.

array of strings

Given or first names, in order. String key: "given".Optional. For example, ["Jane", "Marie"].

array of strings

Name suffixes. String key: "suffix".Optional. For example, ["Jr"].

string

How this name is used. String key: "use".Optional. Examples: "official", "usual", "nickname".

Code example:

Swift

do {
    let contextDetail: [String: AnyHashable] = [
        SukiAmbientConstant.kPatientInfo: [
            SukiAmbientConstant.kBirthdate: Date(), // Use yyyy-mm-dd format
            SukiAmbientConstant.kGender: "FEMALE",
            SukiAmbientConstant.kPatientId: "emr-patient-42",
            SukiAmbientConstant.kPatientName: [
                SukiAmbientConstant.kPatientFamily: "Doe",
                SukiAmbientConstant.kPatientGiven: ["Jane", "Marie"],
                SukiAmbientConstant.kPatientSuffix: ["Jr"],
                SukiAmbientConstant.kPatientNameUse: "official"
            ] as [String: AnyHashable]
        ]
    ]

    try SukiAmbientCoreManager.shared.setSessionContext(with: contextDetail) { result in
        switch result {
        case .success:
            print("Context updated successfully")
        case .failure(let error):
            print("Error updating context: \(error)")
        }
    }
} catch {
    print(error)
}

Next steps

Provide clinical context - Full setSessionContext overview and combined example. Provider context - Pass specialty and provider role. Recording controls - Start, pause, and resume recording.

Get Started

Concepts & Feature Guides

Resources

Patient Info

Next steps

​Next steps

Next steps