Seed Ambient Session Context
Provide clinical context and patient information for ambient session
- details (e.g., specialty and role).
- Patient and visit information.
- A list of codes for the clinical sections you want to generate.
- Existing with their associated medical codes.
- EMR context, including target EMR, when you need EMR-specific behavior (for example order submission rules).
- Orders context (medication orders), including structured medication orders for active medications and related metadata.
Field validation and constraints
-
Character Limits: Ensure the
chief_complaintandreason_for_visitfields do not exceed 255 characters. -
Enumerated Values: Use only the predefined string values for
visit_type,encounter_type, andprovider_role. -
EMR Selection: You must set
emr.target_emrto one of the following:ATHENA,EPIC, orCERNER.
Medication order requirements
When you sendorders.medication_orders.values, include the following required properties for each object:
- Drug Information: Provide both the
drug_nameand amedication_code. - Coding Systems: For
medication_code, specify thecodeand set thetypetoRXCUIorNDC. - Order Status: Set the
statustoACTIVE,DISCONTINUED, orREFILLED. - Metadata: Include the
metadataobject with a requiredoriginofEMRorSUKI_AMBIENT.
origin to EMR, you must also set metadata.encounter_relation to either CURRENT_ENCOUNTER or PRIOR_ENCOUNTER.linked_diagnosis_codes match a diagnosis already provided in the diagnoses section.
Use the same coding system for both to allow the service to validate the link.Code examples
- Python
- TypeScript
Headers
sdp_suki_token
Unique identifier for the provider. Optional for standard partners. Required for Single Auth Token authentication, where multiple providers share the same partner_token.
"provider-123"
Path Parameters
ambient_session_id
Body
Context
Optional - Information about the diagnoses
Optional - Information about EMR context
Optional - Information about form-filling context
Optional - Information about orders context
Optional - Information about the patient
Optional - Information about the provider
Optional - Information about the sections to be generated. If not provided, all supported note-sections will be generated.
Optional - Information about the visit