Visit Types

Get list of supported clinical visit types

GET /api/v1/info/visit-types

Gets the list of supported visit types.

cURL

curl --request GET \
  --url https://sdp.suki-stage.com/api/v1/info/visit-types \
  --header 'sdp_suki_token: <sdp_suki_token>'

200

{
  "visit_types": [
    {
      "code": "ESTABLISHED_PATIENT"
    }
  ]
}

Use this endpoint to get the list of supported visit types.

Code Examples

Python

import requests

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

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

if response.status_code == 200:
    visit_types_data = response.json()
    print("Supported Visit Types:")
    for visit_type in visit_types_data.get("visit_types", []):
        print(f"  {visit_type.get('code')}")
else:
    print(f"Failed to get visit types: {response.status_code}")
    print(response.json())

TypeScript

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

if (response.ok) {
  const visitTypesData = await response.json();
  console.log('Supported Visit Types:');
  visitTypesData.visit_types?.forEach((visitType: any) => {
    console.log(`  ${visitType.code}`);
  });
} else {
  const error = await response.json();
  console.error(`Failed to get visit types: ${response.status}`, error);
}

Headers

sdp_suki_token · string · required

sdp_suki_token

Response

200

*/*

Success Response

Response body for the /info/visit-types endpoint

visit_types · object[]

List of supported visit types

Show child attributes