/api/v1/info

Get medication order metadata

Returns all supported medication order reference lists in one response.

get/api/v1/info/orders

Request

  • Base URL
    https://sdp.suki.ai
  • URL
    https://sdp.suki.ai/api/v1/info/orders
  • 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

{
  "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"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.