Update a patient's user defined field values by field name instead of numeric IDs.

patch

https://integrationhub.wellsky.io/commands/v4/userdefinedfields/patients/{medicalRecordNumber}

Resolves field names against the Patient UDF template and applies the updates.
Note: each request field's fieldName must match the template field's description
(the displayed label) — not the template field's fieldName (reporting/data-extraction name).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

medicalRecordNumber

string

required

Defaults to null

Query Params

api-version

string

The requested API version

Body Params

fields

array of objects

required

length ≥ 1

fields*

groupName

string | null

The group (container) name the field belongs to. Null or empty means the "unassigned" container.

fieldName

string

required

length ≥ 1

The field label as displayed in the CareTend Desktop UI. This must match the value
supplied as description when the field was created via
POST /commands/v4/userdefinedfields/template — it does NOT correspond to that
endpoint's fieldName property (which is the reporting/data-extraction name).

value

string | null

The value to set for simple fields (Boolean, ShortText, LongText, DateTime, ChoiceSinglePopup).
For Boolean fields, use "True" or "False".

selectedValues

array of strings | null

The selected values for choice fields (ChoiceSingleRadio, ChoiceMultiCheckboxes).
Pass the display text of the allowable values. Empty list clears all selections.

selectedValues

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

404Not Found

500Internal Server Error