API PatFields

See API Specification

Patient Fields are custom fields that are found in various areas of Open Dental such as the Patient Information area of the Family Module, Account Module, and Chart Module.

PatFields GET (single)

Version Added: 22.4

Gets a single PatField.

PatFieldNum: Required in the URL.

Example Request:
GET /patfields/5

Example Response:
{
"PatFieldNum": 5,
"PatNum": 69,
"FieldName": "Ins Verified",
"FieldValue": "Yes"
"SecDateTEdit": "2022-12-15 11:26:31"
}

PatFields GET (multiple)

Version Added: 21.1

Gets a list of PatFields.

Parameters: All optional.

PatNum: The patient's PatNum.
FieldName: FK to patFieldDef.FieldName. Case sensitive.
SecDateTEdit: (Added in version 22.4.5) Timestamp representing when the PatField was last edited. In "yyyy-MM-dd HH:mm:ss" format.

Example Requests:
GET /patfields
GET /patfields?PatNum=69&FieldName=Ins%20Verified
GET /patfields?FieldName=Deposit

Example Responses:
[
{
"PatFieldNum": 1,
"PatNum": 39,
"FieldName": "Deposit",
"FieldValue": "450.29",
"SecDateTEdit": "2022-12-22 09:31:00"
},
{
"PatFieldNum": 2,
"PatNum": 68,
"FieldName": "Over 18",
"FieldValue": "1",
"SecDateTEdit": "2022-10-22 08:35:33"
},
{
"PatFieldNum": 3,
"PatNum": 86,
"FieldName": "Ortho Status",
"FieldValue": "In Progress",
"SecDateTEdit": "2022-12-22 14:45:11"
},
etc...
]

or

{
"PatFieldNum": 5,
"PatNum": 69,
"FieldName": "Ins Verified",
"FieldValue":"Yes"
"SecDateTEdit": "2022-12-15 11:26:31"
}

or

{
"PatFieldNum": 1,
"PatNum": 39,
"FieldName": "Deposit",
"FieldValue": "450.29",
"SecDateTEdit": "2022-12-22 09:31:00"
}

PatFields POST (create)

Version Added: 22.4

Creates a PatField. Use a query to get a list of possible PatFieldDefs. Cannot create PatFields associated with hidden PatFieldDefs.

Parameters:

PatNum: Required. The patient's PatNum.
FieldName: Required. FK to PatFieldDef.FieldName. Case sensitive.
FieldValue: Required. Text depending on associated PatFieldDef.FieldType. (Text, PickList, Date, Checkbox, or Currency)

Example Request:
POST /patfields

{
"PatNum":10,
"FieldName": "Ins Verified",
"FieldValue":"Yes"
}

Example Response:
{
"PatFieldNum": 29,
"PatNum": 10,
"FieldName": "Ins Verified",
"FieldValue": "Yes",
"SecDateTEdit": "2022-12-28 09:38:01"
}

201 Created
400 BadRequest (with explanation)
404 NotFound (with explanation)

PatFields PUT

Version Added: 21.1

If a PatField already exists for the patient, it gets set to the new value, overwriting the old value. If a PatField does not yet exist for the patient, then a PatField gets inserted into the database. To delete a PatField, set the FieldValue to an empty string.

Parameters:

PatNum: Required. The patient's PatNum.
FieldName: Required. FK to patFieldDef.FieldName. Case sensitive.
FieldValue: Required. Text depending on associated PatFieldDef.FieldType. (Text, PickList, Date, Checkbox, or Currency)

Example Request:
PUT /patfields

{
"PatNum":101,
"FieldName": "Ins Verified",
"FieldValue":"Yes"
}

Example Response:
200 OK
400 BadRequest (with explanation)

PatFields DELETE

Version Added: 22.4

Deletes a PatField. Will not delete a PatField with an associated PatFieldDef of type CareCreditStatus.

PatFieldNum: Required in the URL.

Example Request:
DELETE /patfields/29

Example Response:
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)