Allergy Management

Create Allergy - JSON Structure

Request body for POST /allergies. Per OpenDental API.

Example 1 – using defDescription (recommended):

{
  "PatNum": 12,
  "defDescription": "Penicillin",
  "Reaction": "Hives",
  "DateAdverseReaction": "2019-09-23",
  "StatusIsActive": "true"
}

Example 2 – using AllergyDefNum:

{"PatNum": 12, "AllergyDefNum": "243"}

Response (201 Created):

{
  "AllergyNum": 1,
  "AllergyDefNum": 4,
  "PatNum": 12,
  "defDescription": "Penicillin",
  "defSnomedType": "None",
  "Reaction": "Hives",
  "StatusIsActive": "true",
  "DateAdverseReaction": "2019-09-23"
}

Field Reference:

PatNum: Required. Patient number.
defDescription: Required unless AllergyDefNum. Allergy type (e.g. Penicillin, Latex). Auto-creates AllergyDef.
AllergyDefNum: Rarely used. Required unless defDescription. Use defDescription instead for automatic handling.
Reaction: Optional. Adverse reaction (e.g. Rash, Hives).
StatusIsActive: Optional. "true" or "false". Default "true".
DateAdverseReaction: Optional. "yyyy-MM-dd". Default "0001-01-01".

Allergies

Create New Allergy

Result:

Search & Update Allergy

Select an allergy to update or delete:

Update Allergy

Result:

Allergy Management

Create New Allergy

Result:

Search & Update Allergy

Select an allergy to update or delete:

Update Allergy

Result:

Create Allergy - JSON Structure

Example 1 – using defDescription (recommended):

Example 2 – using AllergyDefNum:

Response (201 Created):

Field Reference:

Allergy Object - GET Response

Example Response:

Field Descriptions:

Search & Update Allergy - JSON Structure

Search: GET /allergies?PatNum=15

Update: PUT /allergies/{AllergyNum}

Delete: DELETE /allergies/{AllergyNum}