Dictionaries

Base URL: https://api.welkinhealth.com/{tenantName}/{instanceName}/dictionaries

Dictionaries define reusable lookup lists (e.g., diagnosis codes, disposition values, referral sources) configured in Welkin Designer.

---

Get All Dictionaries

GET /dictionaries

Returns all dictionaries defined for the instance.

Query Parameters

Parameter	Type	Required	Description
page	integer	No	Page number (default: 0)
size	integer	No	Page size (default: 20)

Example Request

curl -X GET "https://api.welkinhealth.com/acme/live/dictionaries" \
  -H "Authorization: Bearer {access_token}"

Example Response

[
  {
    "id": "dict_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "referral_source",
    "label": "Referral Source",
    "entries": [
      { "value": "physician", "label": "Physician Referral", "active": true, "sortOrder": 1 },
      { "value": "self", "label": "Self Referral", "active": true, "sortOrder": 2 }
    ]
  }
]

---

Get Dictionary by Name

GET /dictionaries/{dictionaryName}

Returns a single dictionary and all its entries.

Path Parameters

Parameter	Type	Required	Description
dictionaryName	string	Yes	Programmatic name of the dictionary (e.g., referral_source)

Example Request

curl -X GET "https://api.welkinhealth.com/acme/live/dictionaries/referral_source" \
  -H "Authorization: Bearer {access_token}"

Example Response

{
  "id": "dict_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "referral_source",
  "label": "Referral Source",
  "entries": [
    { "value": "physician", "label": "Physician Referral", "active": true, "sortOrder": 1 },
    { "value": "self", "label": "Self Referral", "active": true, "sortOrder": 2 }
  ]
}

---

Dictionary Entry Object

Field	Type	Description
value	string	Internal value stored in records
label	string	Human-readable display label
active	boolean	Whether entry is active
sortOrder	integer	Display order