SUsuki
/api/v1/info

Get system information

Changed on

Returns reference metadata Suki supports for ambient integrations, including LOINC codes, specialties, diagnosis code types, encounter types, visit types, provider roles, and medication order enums.

get/api/v1/info

Request

  • Base URL
    https://sdp.suki.ai
  • URL
    https://sdp.suki.ai/api/v1/info
  • Auth
    API key in header sdp_suki_token

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

{
  "diagnosis_code_types": [
    {
      "code_type": "ICD10"
    }
  ],
  "encounter_types": [
    {
      "code": "AMBULATORY"
    }
  ],
  "loincs": [
    {
      "code": "10164-2",
      "common_name": "History of Present Illness"
    }
  ],
  "medication_coding_systems": [
    {
      "code": "RXCUI"
    }
  ],
  "medication_dosage_units": [
    {
      "code": "TAB"
    }
  ],
  "medication_frequency_types": [
    {
      "code": "ONE_A_DAY"
    }
  ],
  "medication_order_statuses": [
    {
      "code": "ACTIVE"
    }
  ],
  "medication_timings": [
    {
      "code": "WITH_MEALS"
    }
  ],
  "order_encounter_relations": [
    {
      "code": "CURRENT_ENCOUNTER"
    }
  ],
  "order_origins": [
    {
      "code": "SUKI_AMBIENT"
    }
  ],
  "provider_roles": [
    {
      "code": "ATTENDING"
    }
  ],
  "specialties": [
    {
      "code": "CARDIOLOGY"
    }
  ],
  "visit_types": [
    {
      "code": "ESTABLISHED_PATIENT"
    }
  ],
  "structured_data_field_types": [
    {
      "type": "text",
      "description": "Free-text field; value is a string"
    }
  ]
}

Changes