API AllergyDefs
Anyone using the API should also become very familiar with our schema documentation which contains important details about individual database table columns.
See AllergyDef Database Schema.
AllergyDefs GET (single)
Version Added: 26.1.15
Gets a single allergydef.
AllergyDefNum: Required in the URL.
Example Request:
GET /allergydefs/14
Example Response:
{
"AllergyDefNum": 14,
"Description ": "Latex",
"IsHidden": "false",
"DateTStamp": "2011-07-15 12:19:11",
"SnomedType": "None",
"MedicationNum": 0,
"UniiCode": ""
}
200 OK
404 NotFound (with explanation)
AllergyDefs GET (multiple)
Version Added: 21.3
Gets a list of allergydefs.
Example Requests:
GET /allergydefs
GET /allergydefs?Offset=200
Example Response:
[
{
"AllergyDefNum": 44,
"Description ": "Allergy - Phentermine",
"IsHidden": "false",
"DateTStamp": "2020-07-17 02:45:38",
"SnomedType": "None",
"MedicationNum": 0,
"UniiCode": ""
},
{
"AllergyDefNum": 45,
"Description ": "Allergy - Sudogest",
"IsHidden": "false",
"DateTStamp": "2015-12-10 05:40:32",
"SnomedType": "None",
"MedicationNum": 0,
"UniiCode": ""
},
etc...
]
200 OK
AllergyDefs POST
Version Added: 21.3
Creates an allergydef.
Parameters:
Description: Required. Name of the allergy.
Example Request:
POST /allergydefs
{
"Description": "Tylenol"
}
Example Response:
{
"AllergyDefNum": 84,
"Description ": "Tylenol",
"IsHidden": "false",
"DateTStamp": "2026-04-10 13:24:54",
"SnomedType": "None",
"MedicationNum": 0,
"UniiCode": ""
}
201 Created
400 BadRequest (with explanation)
AllergyDefs PUT
Version Added: 26.1.15
Updates an allergydef.
Parameters:
AllergyDefNum: Required in the URL.
Description: Optional. Name of the allergy.
IsHidden: Optional. Either "true" or "false".
Example Request:
PUT /allergydefs/84
{
"IsHidden": "true"
}
Example Response:
{
"AllergyDefNum": 84,
"Description ": "Tylenol",
"IsHidden": "true",
"DateTStamp": "2026-04-10 13:24:54",
"SnomedType": "None",
"MedicationNum": 0,
"UniiCode": ""
}
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)