Quick summary
Web SDK Medication orders and Ambient API structured data use the same Medication order object shape. If you use both workflows, you can reuse parsers, validators, and EHR mapping logic for complete and incomplete Medication orders.
For the full payload structure of Medication orders in the Web SDK, refer to Medication orders payload structure.
Payload alignment
The Web SDK and Ambient API place Medication orders in different parts of the response. The fields inside each Medication order are the same, so you can parse the order details the same way.Web SDK Note Submission Payload
Read complete orders from
orders.medication_orders.values and incomplete orders from orders.medication_orders.partial_values.Ambient API Structured Data
Read complete orders from
structured_data.orders.medication_orders.values and incomplete orders from structured_data.orders.medication_orders.partial_values.Get Ambient Session Structured Data
Retrieve structured data for an ambient session.
Get Encounter Structured Data
Retrieve structured data for an encounter.
Shared ingestion pattern
If your application receives Medication orders from both the Headed Web SDK and Ambient APIs, you do not need two separate parsers for the order details. Read the order arrays from the correct response path, then pass each order object into the same parser, validator, or EHR mapping logic. We recommend using the following approach for parsing Medication orders:Read orders from the response
Use the Web SDK or Ambient API response path to read complete orders from
values and incomplete orders from partial_values.Parse each order the same way
After you read the order arrays, parse each order object using the same Medication order field definitions, such as
drug_name, medication_code, dosage, and linked_diagnosis_codes.Handle complete and incomplete orders separately
Send orders from
values through your completed order workflow. Send orders from partial_values to manual review or additional handling.Validate metadata
Use Orders Info API and related info endpoints to validate enums, such as status, frequency, and origin.
Web SDK and Ambient API responsibilities
The Web SDK and Ambient APIs return aligned Medication order data, but each workflow has a different responsibility in your integration.| Topic | Web SDK | Ambient API |
|---|---|---|
| Order generation trigger | LOINC 52471-0 in ambientOptions.sections and the enable_medication_orders feature flag | Session context, structured data retrieval, and API configuration documented in Medication orders |
| Provider review | Built-in Medication orders section in the note UI | Your application UI |
| Payload delivery | note-submission:success / onNoteSubmit | GET structured data endpoints |
| EHR submission | Partner application | Partner application |
| Existing medication context | The Web SDK focuses on generating and returning orders from the ambient session | Send existing medication orders through the Context API |
Context ingest on the API
When you use the Ambient API, you can send existing medication orders through the Context API. Suki uses that context to reconcile and deduplicate against generated output. The Web SDK does not replace the Context API. In the Web SDK flow, Medication orders are generated from the ambient session and returned in the note submission payload.ImportantIf your integration uses both Web SDK and Ambient API workflows for the same encounter, keep the encounter identifiers and Web SDK LOINC configuration consistent.
Metadata and validation
Use the same metadata references when you validate or map Medication order fields:Orders Metadata API
Reference coding systems, units, frequencies, and other order metadata.
Medication Orders API Guide
Review platform-level details for EHR validation, PBC linking, and API reconciliation.
FAQs
What is the difference between the Web SDK and Ambient API Medication orders?
What is the difference between the Web SDK and Ambient API Medication orders?
Both the Web SDK and Ambient REST APIs return Medication orders in the same object shape. The main difference is how the orders are generated and returned.
- The Web SDK generates orders from the ambient session and returns them in the note submission payload.
- The Ambient REST APIs retrieve existing orders from the EHR and return them in the structured data response.
How do I validate Medication orders using REST APIs?
How do I validate Medication orders using REST APIs?
Use the Orders Info API and related info endpoints to validate enums, such as status, frequency, and origin.
In Web SDK, how do I enable Medication orders?
In Web SDK, how do I enable Medication orders?
Pass the LOINC code
52471-0 in ambientOptions.sections and the enable_generated_orders feature flag to enable Medication orders in the Web SDK.