SUsuki
/api/v1/ambient/encounter

Get encounter section structured data

Changed on

Returns Embedded Form results from the latest completed ambient session for the encounter, grouped by section LOINC. Results from earlier sessions on the same encounter are not merged in.

get/api/v1/ambient/encounter/{encounter_id}/structured-data/section-structured-data

Request

  • Base URL
    https://sdp.suki.ai
  • URL
    https://sdp.suki.ai/api/v1/ambient/encounter/{encounter_id}/structured-data/section-structured-data
  • Auth
    API key in header sdp_suki_token

Path parameters

encounter_idstring required

UUID for the patient encounter (visit). Use the encounter_id from session create or the UUID you assigned when grouping multiple sessions under one visit.

Headers

sdp_provider_idstring
Example:provider-123

Optional for standard partners.

Required for:

  • Bearer authentication. Use the same provider_id returned by the Login or Register API.
  • Single Auth Token authentication. Include the same provider_id on every request as sdp_provider_id.

Response

Request succeeded.

Example response

{
  "section_structured_values": [
    {
      "loinc_code": "10164-2",
      "forms": [
        {
          "template_id": "hpi-mood-v1",
          "values": [
            {
              "id": "slot-duration",
              "key": "symptom_duration",
              "value": "in the last two weeks"
            }
          ]
        }
      ]
    }
  ]
}

Changes