Medication Order Metadata

Get all supported medication order metadata in one response

GET /api/v1/info/orders

cURL

cURL

curl --request GET \
  --url https://sdp.suki.ai/api/v1/info/orders \
  --header 'sdp_suki_token: <sdp_suki_token>' \
  --header 'sdp_provider_id: <sdp_provider_id>'

200

{
  "coding_systems": [
    {
      "code": "RXCUI"
    }
  ],
  "dosage_units": [
    {
      "code": "TAB"
    }
  ],
  "encounter_relations": [
    {
      "code": "CURRENT_ENCOUNTER"
    }
  ],
  "frequency_types": [
    {
      "code": "ONE_A_DAY"
    }
  ],
  "origins": [
    {
      "code": "SUKI_AMBIENT"
    }
  ],
  "statuses": [
    {
      "code": "ACTIVE"
    }
  ],
  "timings": [
    {
      "code": "WITH_MEALS"
    }
  ]
}

Use this endpoint to get supported metadata for medication orders in one response, including coding systems, dosage units, frequency types, timings, statuses, origins, and encounter relations.

Code examples

Python

import requests

url = "https://sdp.suki-stage.com/api/v1/info/orders"
headers = {
    "sdp_suki_token": "<sdp_suki_token>",
    "sdp_provider_id": "<sdp_provider_id>"
}

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

if response.status_code == 200:
    order_info = response.json()
    print("Medication order metadata:")
    print(f"  Coding systems: {len(order_info.get('coding_systems', []))}")
    print(f"  Dosage units: {len(order_info.get('dosage_units', []))}")
    print(f"  Encounter relations: {len(order_info.get('encounter_relations', []))}")
    print(f"  Frequency types: {len(order_info.get('frequency_types', []))}")
    print(f"  Origins: {len(order_info.get('origins', []))}")
    print(f"  Statuses: {len(order_info.get('statuses', []))}")
    print(f"  Timings: {len(order_info.get('timings', []))}")
else:
    print(f"Failed to get medication order metadata: {response.status_code}")
    print(response.json())

TypeScript

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

if (response.ok) {
  const orderInfo = await response.json();
  console.log('Medication order metadata:');
  console.log(`  Coding systems: ${orderInfo.coding_systems?.length ?? 0}`);
  console.log(`  Dosage units: ${orderInfo.dosage_units?.length ?? 0}`);
  console.log(`  Encounter relations: ${orderInfo.encounter_relations?.length ?? 0}`);
  console.log(`  Frequency types: ${orderInfo.frequency_types?.length ?? 0}`);
  console.log(`  Origins: ${orderInfo.origins?.length ?? 0}`);
  console.log(`  Statuses: ${orderInfo.statuses?.length ?? 0}`);
  console.log(`  Timings: ${orderInfo.timings?.length ?? 0}`);
} else {
  const error = await response.json();
  console.error(`Failed to get medication order metadata: ${response.status}`, error);
}

Authorizations

sdp_suki_token · string · header · required

Suki access token (suki_token) from Login or Register. Expires after one hour.

Headers

sdp_provider_id · string

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.

Example:

"provider-123"

Response

200

*/*

Request succeeded.

Response body for the /info/orders endpoint

coding_systems · object[]

Information about supported medication coding systems

Show child attributes

dosage_units · object[]

Information about supported dosage units

Show child attributes

encounter_relations · object[]

Information about supported order encounter relations

Show child attributes

frequency_types · object[]

Information about supported frequency types

Show child attributes

origins · object[]

Information about supported order origins

Show child attributes

statuses · object[]

Information about supported medication order statuses

Show child attributes

timings · object[]

Information about supported medication timings

Show child attributes