Custom Data Types (CDT)

Create, read, update, and delete Custom Data Type (CDT) record instances.

Custom Data Types are configurable data structures defined in Welkin Designer. Each CDT has a schema (see CDT Formation) and can hold multiple record instances per patient.

Base path: /{tenantName}/{instanceName}/patients/{patientId}/cdts/{cdtName}/records

---

Endpoints

GET Get All CDT Records

GET /{tenantName}/{instanceName}/patients/{patientId}/cdts/{cdtName}/records

Returns all CDT records of a given type for a patient.

Path Parameters

Parameter	Type	Required	Description
patientId	string	Yes	Welkin patient UUID
cdtName	string	Yes	CDT name as defined in Designer

Query Parameters

Parameter	Type	Default	Description
page	integer	0	Page number
size	integer	20	Results per page

---

GET Get CDT Record by ID

GET /{tenantName}/{instanceName}/patients/{patientId}/cdts/{cdtName}/records/{recordId}

Returns a single CDT record instance.

Path Parameters

Parameter	Type	Required	Description
patientId	string	Yes	Welkin patient UUID
cdtName	string	Yes	CDT name
recordId	string	Yes	CDT record UUID

---

POST Create CDT Record

POST /{tenantName}/{instanceName}/patients/{patientId}/cdts/{cdtName}/records

Creates a new CDT record for a patient. The request body fields must match the CDT schema.

Example Request

POST /acme-health/live/patients/a1b2c3d4/cdts/vitals/records
Authorization: Bearer <token>
Content-Type: application/json

{
  "bloodPressure": "120/80",
  "heartRate": 72,
  "recordedAt": "2026-03-19T09:00:00Z"
}

Example Response 201 Created

{
  "id": "rec-uuid-here",
  "patientId": "a1b2c3d4",
  "cdtName": "vitals",
  "bloodPressure": "120/80",
  "heartRate": 72,
  "recordedAt": "2026-03-19T09:00:00Z",
  "createdAt": "2026-03-19T10:00:00Z"
}

---

PATCH Update CDT Record

PATCH /{tenantName}/{instanceName}/patients/{patientId}/cdts/{cdtName}/records/{recordId}

Partially updates an existing CDT record. Only include the fields you want to change.

---

PATCH Bulk Update CDT Records

PATCH /{tenantName}/{instanceName}/patients/{patientId}/cdts/{cdtName}/records

Updates multiple CDT records for a patient in a single request. The request body is an array of record objects, each including the id of the record to update.

---

DELETE Delete CDT Record

DELETE /{tenantName}/{instanceName}/patients/{patientId}/cdts/{cdtName}/records/{recordId}

Permanently deletes a CDT record instance.

Response 204 No Content

No body is returned on successful deletion.