---
title: "Entity: Allergy"
canonical: "https://wiki.patientsknowbest.com/space/api/3736141825/Entity%3A%20Allergy"
format: markdown
---
> Macro (toc)

# Class Diagram

<u>[Allergy](https://miro.com/app/board/uXjVMODcemM=/?share_link_id=856542688869)</u>

# Display

Allergies appear in the Health > Allergies page of the patient's record.

Please see[ ](https://www.google.com/url?q=https%3A%2F%2Fmanual.patientsknowbest.com%2Fpatient%2Fallergies&sa=D&sntz=1&usg=AOvVaw2q5Ef63tZlOToG_R3KQIjh)<u>[the manual](https://www.google.com/url?q=https%3A%2F%2Fmanual.patientsknowbest.com%2Fpatient%2Fallergies&sa=D&sntz=1&usg=AOvVaw2q5Ef63tZlOToG_R3KQIjh)</u> for more information.

# Mappings

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
|  | **HL7 API** | **FHIR API**<br>(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
|  |  | **Facade (STU3)** | **Aggregated (R4)** |  |  |
| **Summary of interactions** |
| Create | [A28](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28)/[A31](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a31) |  |  | [Allergies](https://manual.patientsknowbest.com/patient/allergies) |  |
| Read |  |  | [/AllergyIntolerance](http://fhir.patientsknowbest.com/structuredefinition/aggregated-allergyintolerance) | [Allergies](https://manual.patientsknowbest.com/patient/allergies) | [/v2-beta/allergies/forPatient/[patientId]](https://sandbox.patientsknowbest.com/api/index.html#!/Allergies/getAllergiesForPatient) |
| Update | [A28](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28)/[A31](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a31) |  |  | [Allergies](https://manual.patientsknowbest.com/patient/allergies) |  |
| Delete | [A28](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28)/[A31](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a31)<br>(replace, but cannot delete all) |  |  | [Allergies](https://manual.patientsknowbest.com/patient/allergies) |  |
| **Entity: Allergy - Extends: ****[Data Point](https://wiki.patientsknowbest.com/space/api/3750395905/Entity%3A+Data+Point)** |
| **Allergen **`CodeableConcept`<br>The allergen. | [AL1-3](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28) |  | code | A display-friendly representation of the allergy is shown; not every component of the CodeableConcept is shown in all circumstances. | substanceCode |
| **Disorder** `CodeableConcept`<br>A condition representing the allergy. This is sometimes populated instead of Allergen. |  |  | code | A display-friendly representation of the disorder is shown; not every component of the CodeableConcept is shown in all circumstances. |  |
| **Onset Timestamp **`Timestamp`<br>When the symptoms began. | [AL1-6.1](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28) |  | onsetDateTime | Shown.<br>The web interface permits entry of date but not time. | onsetOfSymptoms |
| **End Timestamp** `Timestamp`<br>When the symptoms ended. |  |  | lastOccurence | Not shown. |  |
| **Reactions** `CodeableConcept List`<br>The reactions to the allergen. | [AL1-5.1](http://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28) |  | reaction | Shown. | reactions |
| **Severity** `CodeableConcept`<br>How severe the reaction to the allergen is. | [AL1-4](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28) |  | reaction | Shown. | severity |
| **Status** `Enum`<br>- ACTIVE
- INACTIVE
- RESOLVED |  |  | clinicalStatus | Not shown. |  |