Sign in

v1

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

Gets the ambient context for a note.

get/api/v1/ambient/note/{note_id}/context

Path parameters

note_idstring required

Note identifier. Use the composition_id returned from Ambient session create.

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

Success Response

Example response

{
  "context": {
    "chief_complaint": "Headache",
    "encounter_type": "AMBULATORY",
    "provider_role": "ATTENDING",
    "reason_for_visit": "Follow-up for migraines",
    "visit_type": "ESTABLISHED_PATIENT"
  }
}