System Information

Use this endpoint to get the list of supported codes, specialties, types, visit types, roles, code types, and medication order metadata (coding systems, dosage units, frequency types, timings, order statuses, encounter relations, and origins). You can also fetch each category with dedicated GET /api/v1/info/... routes listed under Info in the API reference.

Code examples

Python
TypeScript

import requests

url = "https://sdp.suki.ai/api/v1/info"
headers = {
    "sdp_suki_token": "<sdp_suki_token>"
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    info = response.json()
    print("System Information:")
    print(f"LOINCs: {len(info.get('loincs', []))} codes")
    print(f"Specialties: {len(info.get('specialties', []))} specialties")
    print(f"Encounter Types: {len(info.get('encounter_types', []))} types")
    print(f"Visit Types: {len(info.get('visit_types', []))} types")
    print(f"Provider Roles: {len(info.get('provider_roles', []))} roles")
    print(f"Diagnosis Code Types: {len(info.get('diagnosis_code_types', []))} types")
    print(f"Medication coding systems: {len(info.get('medication_coding_systems', []))}")
    print(f"Medication dosage units: {len(info.get('medication_dosage_units', []))}")
    print(f"Medication frequency types: {len(info.get('medication_frequency_types', []))}")
    print(f"Medication timings: {len(info.get('medication_timings', []))}")
    print(f"Medication order statuses: {len(info.get('medication_order_statuses', []))}")
    print(f"Order encounter relations: {len(info.get('order_encounter_relations', []))}")
    print(f"Order origins: {len(info.get('order_origins', []))}")
else:
    print(f"Failed to get system information: {response.status_code}")
    print(response.json())

const response = await fetch('https://sdp.suki.ai/api/v1/info', {
  headers: {
    'sdp_suki_token': '<sdp_suki_token>'
  }
});

if (response.ok) {
  const info = await response.json();
  console.log('System Information:');
  console.log(`LOINCs: ${info.loincs?.length || 0} codes`);
  console.log(`Specialties: ${info.specialties?.length || 0} specialties`);
  console.log(`Encounter Types: ${info.encounter_types?.length || 0} types`);
  console.log(`Visit Types: ${info.visit_types?.length || 0} types`);
  console.log(`Provider Roles: ${info.provider_roles?.length || 0} roles`);
  console.log(`Diagnosis Code Types: ${info.diagnosis_code_types?.length || 0} types`);
  console.log(`Medication coding systems: ${info.medication_coding_systems?.length ?? 0}`);
  console.log(`Medication dosage units: ${info.medication_dosage_units?.length ?? 0}`);
  console.log(`Medication frequency types: ${info.medication_frequency_types?.length ?? 0}`);
  console.log(`Medication timings: ${info.medication_timings?.length ?? 0}`);
  console.log(`Medication order statuses: ${info.medication_order_statuses?.length ?? 0}`);
  console.log(`Order encounter relations: ${info.order_encounter_relations?.length ?? 0}`);
  console.log(`Order origins: ${info.order_origins?.length ?? 0}`);
} else {
  const error = await response.json();
  console.error(`Failed to get system information: ${response.status}`, error);
}

Headers

sdp_suki_token

string

required

sdp_suki_token

Response

Success Response

Response body for the /info endpoints with flexible data based on category

diagnosis_code_types

object[]

Information about supported diagnosis code types

Show child attributes

encounter_types

object[]

Information about supported encounter types

Show child attributes

loincs

object[]

Information about supported section codes

Show child attributes

medication_coding_systems

object[]

Information about supported medication coding systems

Show child attributes

medication_dosage_units

object[]

Information about supported medication dosage units

Show child attributes

medication_frequency_types

object[]

Information about supported medication frequency types

Show child attributes

medication_order_statuses

object[]

Information about supported medication order statuses

Show child attributes

medication_timings

object[]

Information about supported medication timings

Show child attributes

order_encounter_relations

object[]

Information about supported order encounter relations

Show child attributes

order_origins

object[]

Information about supported order origins

Show child attributes

provider_roles

object[]

Information about supported provider roles

Show child attributes

specialties

object[]

Information about supported specialties

Show child attributes

visit_types

object[]

Information about supported visit types

Show child attributes

Get Started

API References

System Information

Code examples

Headers

Response

Get Started

API References

Documentation Index

​Code examples

Headers

Response

Code examples