Sign in

v1

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

Seed ambient session metadata (deprecated)

Seeds metadata for an ambient session. Deprecated. Use POST /api/v1/ambient/session/{ambient_session_id}/context instead.

post/api/v1/ambient/session/{ambient_session_id}/metadata

Path parameters

ambient_session_idstring required

UUID for the ambient session. Use the ambient_session_id returned from Create Ambient Session, or the UUID you supplied in that request.

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.

Request body

patient_dobstring

Optional - {YYYY-MM-DD}

patient_sex'male' | 'female' | 'other' | 'unknown'

Optional

provider_specialtystring

Optional - Defaults to FAMILY_MEDICINE if not provided

Example request

{
  "note_sections": [
    {
      "description": "The main reason for the visit",
      "title": "CHIEF COMPLAINT"
    }
  ],
  "patient_dob": "2000-01-01",
  "patient_sex": "male",
  "provider_specialty": "CARDIOLOGY"
}

Response

Request succeeded.