Orders Info

Use orders info when Medication orders is enabled and you want structured medication orders from an ambient session. When the provider prescribes medications during the visit conversation, Suki includes those orders in the session output. After processing completes, retrieve them with getStructuredData(for:) so your application can submit them through your EHR workflow. Pass optional SukiAmbientConstant.kOrdersInfo in setSessionContext(with:) after you create the session when your workflow needs medication order context for the visit. This parameter is optional.

This feature is not enabled by default. To enable it, contact Suki support to request access (if not already enabled).

dictionary

Use this parameter when you need to attach medication order context for the ambient visit. Generated Medication orders from the encounter still come from what the provider prescribes during the session, and you retrieve them with getStructuredData(for:) after processing completes.The data is structured as a single bundle. On the wire, the outer payload key is orders. Inside this bundle, you must include a single list keyed by MedicationOrderKeys.kMedicationOrders (wire string medication_orders). Each entry in this list represents a single medication order and must be formatted as an individual dictionary.You can skip kOrdersInfo entirely if it is not required for your workflow. If you do send the MedicationOrderKeys.kMedicationOrders list, each order in that list should satisfy the following recommendations.

Missing information or incomplete metadata fails with invalidMedicationOrder. If you include origin or encounter_relation under metadata, each value must be non-empty and match one of the allowed choices. Values that do not match can fail parsing with invalidOrderMetadata.

Payload keys

The following payload (wire) keys are important when present in the MedicationOrderKeys.kMedicationOrders array:

medication_code: If provided, include both code_type and code.
linked_diagnosis_codes: If provided, include at least one item containing both code_type and code.
metadata.origin and metadata.encounter_relation: You must use only the approved values for these fields.

When you use optional fields that carry codes (medication_code.code_type, dosage.unit, frequency, medication_timing, status), the SDK checks them against its own supported lists. Use only values that your SDK already accepts to avoid validation errors.

Code example:

Swift

do {
    let contextDetail: [String: AnyHashable] = [
        SukiAmbientConstant.kOrdersInfo: [
            MedicationOrderKeys.kMedicationOrders: [
                [
                    MedicationOrderKeys.kDrugName: "Atorvastatin", // optional
                    MedicationOrderKeys.kMedicationCode: [
                        SukiAmbientConstant.kCodeType: "<code_type>", // optional; coded values must match a supported catalog in your SDK version
                        SukiAmbientConstant.kCode: "<code>" // optional
                    ],
                    MedicationOrderKeys.kStrength: "10 mg", // optional
                    MedicationOrderKeys.kFormat: "tablet", // optional
                    MedicationOrderKeys.kRoute: "oral", // optional
                    MedicationOrderKeys.kLinkedDiagnosisCodes: [
                        [
                            SukiAmbientConstant.kCodeType: "ICD-10",
                            SukiAmbientConstant.kCode: "E78.5"
                        ]
                    ],
                    MedicationOrderKeys.kMetadata: [
                        MedicationOrderKeys.kOrigin: "EMR",
                        MedicationOrderKeys.kEncounterRelation: "CURRENT_ENCOUNTER"
                    ]
                ]
            ]
        ]
    ]

    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)
}

Hide properties

Each object in the MedicationOrderKeys.kMedicationOrders array can include the following. The payload keys checklist above defines the minimum; the ResponseField entries use Swift constant names for the same rules.

string

required

The medication name. Required when this order is included in the array.

dictionary

The coded medication identifier. Optional when this order is included.

Hide medication_code properties

string

The coding system for the medication code. Optional for validation. Must match a supported catalog when you send a coded value.

string

The medication code. Optional for validation. Must match a supported catalog when you send a coded value.

string

The medication strength (for example dosage amount with unit). Optional when this order is included.

string

The dose form (for example tablet, capsule). Optional when this order is included.

string

The route of administration. Optional when this order is included.

dictionary

Optional structured dosage information.

Show dosage properties

string

Free-text dosage as entered in your system.

number

Numeric quantity for the dose.

string

Unit for the quantity. When used as a coded field, must match a supported catalog.

dictionary

Optional dosing frequency. Uses the same inner keys as MedicationOrderKeys.kMedicationTiming.

Show frequency properties

string

Free-text frequency.

string

Structured frequency value. When used as a coded field, must match a supported catalog.

string

Quantity dispensed.

integer

Number of refills.

date

Start date for the order when you supply it through context bridging.

date

End date for the order.

integer

Duration of therapy in days.

string

Patient- or pharmacy-facing instructions.

dictionary

Optional timing details for the medication. Same shape as MedicationOrderKeys.kFrequency.

Show medication_timing properties

string

Free-text timing.

string

Structured timing value. When used as a coded field, must match a supported catalog.

array of dictionaries

Optional for validation: if provided, include at least one object. Each array element uses code_type and code (SukiAmbientConstant.kCodeType and SukiAmbientConstant.kCode in Swift).

Hide code properties

string

The coding system for the diagnosis (for example “ICD-10”). Must match a supported catalog when you send a coded value.

string

The diagnosis code. Must match a supported catalog when you send a coded value.

string

Order status. When used as a coded field, must match a supported catalog.

dictionary

Provenance for the order. Optional when this order is included. If provided, you should set origin and encounter_relation under metadata (use MedicationOrderKeys.kOrigin and MedicationOrderKeys.kEncounterRelation in Swift). Each value must be non-empty after trim and must be one of the allowed strings below.

Hide metadata properties

string

Payload key origin. Where the order came from. Valid values: SUKI_AMBIENT, EMR.

string

Payload key encounter_relation. How the order relates to the encounter. Valid values: PRIOR_ENCOUNTER, CURRENT_ENCOUNTER.

This field is required if the origin is EMR.

Next steps

Provide clinical context - Full setSessionContext overview and combined example. Medication orders - platform concept across ambient products. Check status and retrieve content - Pull structured medication order payloads.

Get Started

Concepts & Feature Guides

Resources

Orders Info

Payload keys

Next steps

​Payload keys

​Next steps

Payload keys

Next steps