Sign in

v1

latestOpenAPI 3.0.12026-07-2649123153.6 KB
/api/v1/ambient/encounter

Get encounter content

Returns cumulative clinical content across all ambient sessions linked to the encounter. Use the encounter_id from session create when you grouped multiple sessions under one visit.

get/api/v1/ambient/encounter/{encounter_id}/content

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

{
  "structured_data": [
    {
      "data": {
        "dosage": "2 puffs",
        "medication": "albuterol"
      },
      "title": "MEDICATIONS"
    }
  ],
  "summary": [
    {
      "content": "Asthma exacerbation",
      "loinc_code": "18776-5",
      "source_transcripts": [
        "asthma",
        "exacerbation"
      ],
      "title": "ASSESSMENT AND PLAN"
    }
  ]
}