HL7 Personal Health Record System Functional Model, Release 2
2.0.1-ballot - Normative Ballot

Publication Build: This will be filled in by the publication tooling

## : PH.2.5.4 Manage Allergy, Intolerance, and Adverse Reaction List (Function) - JSON Representation

Page standards status: Informative

Raw json | Download

    {
      "resourceType" : "Requirements",
      "id" : "PHRSFMR2-PH.2.5.4",
      "meta" : {
        "profile" : [
          🔗 "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/FMFunction"
        ]
      },
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n    <span id=\"description\"><b>Statement <a href=\"https://hl7.org/fhir/versions.html#std-process\" title=\"Normative Content\" class=\"normative-flag\">N</a>:</b> <div><p>Manage the PHR Account Holder’s list of known allergens and adverse reactions with all pertinent information.</p>\n</div></span>\n\n    \n    <span id=\"purpose\"><b>Description <a href=\"https://hl7.org/fhir/versions.html#std-process\" title=\"Informative Content\" class=\"informative-flag\">I</a>:</b> <div><p>Allergies, intolerances, sensitivities, and adverse reactions must be reviewed with every new prescription to avoid an allergic reaction.</p>\n<p>Environmental and food allergens should be listed and maintained here, as well as allergies to bee sting, sunlight, or substances (e.g., latex, metal, or contrast media (such as dye).</p>\n<p>Example(s): The system SHALL provide the ability to enter, store, update and display information related to allergic and adverse reactions or intolerances to drug and non-drug allergens or substances.</p>\n</div></span>\n    \n\n    \n    <span id=\"actors\"><b>Actors:</b><br/> ehr</span>\n    \n\n    \n    <span id=\"requirements\"><b>Criteria <a href=\"https://hl7.org/fhir/versions.html#std-process\" title=\"Normative Content\" class=\"normative-flag\">N</a>:</b></span>\n    \n    <table id=\"statements\" class=\"grid dict\">\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>PH.2.5.4#01</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                \n                <span>SHALL</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                \n                <span><div><p>The system SHALL provide the ability to manage information related to allergy, intolerance, and adverse reaction to drugs, foods, or environmental triggers as unique, discrete entries (including, for example, substances such as latex, metal, and contrast media (such as dye)).</p>\n</div></span>\n                \n                \n                Satisfied by:<ol>\n                \n                    <li><a href=\"https://www.hl7.org/fhir/allergyintolerance.html\">https://www.hl7.org/fhir/allergyintolerance.html</a></li>\n                \n                </ol>\n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>PH.2.5.4#02</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                \n                <span>SHOULD</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                \n                <span><div><p>The system SHOULD provide the ability to capture the reason for entry of the allergy, intolerance or adverse reaction.</p>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>PH.2.5.4#03</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                \n                <span>SHALL</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                \n                <span><div><p>The system SHALL provide the ability to manage information related to allergic and adverse reactions to drug and non-drug allergens or substances.</p>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>PH.2.5.4#04</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                \n                <span>SHALL</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                \n                <span><div><p>The system SHALL provide the ability to manage information regarding the reaction type.</p>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>PH.2.5.4#05</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                \n                <span>SHALL</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                \n                <span><div><p>The system SHALL provide the ability to manage information regarding the severity of a reaction.</p>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>PH.2.5.4#06</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                \n                <span>SHOULD</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                \n                <span><div><p>The system SHOULD provide the ability to maintain associated allergic reactions to the prevention protocols and/or medications being taken.</p>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>PH.2.5.4#07</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                \n                <span>SHALL</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                \n                <span><div><p>The system SHALL provide the ability to manage an indication regarding the negation of a health reaction (e.g., No Known Allergies (NKA), No Known Drug Allergies (NKDA), No Known Food Allergies (NKFA), No Known Sensitivies, or No Known Intolerances).</p>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>PH.2.5.4#08</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                \n                <span>SHOULD</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                \n                <span><div><p>The system SHOULD provide the ability to capture the source of allergy, intolerance, and adverse reaction information.</p>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>PH.2.5.4#09</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                \n                <span>SHOULD</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                \n                <span><div><p>The system SHOULD provide the ability to capture and maintain an indication regarding the deactivation of an item on the allergy, intolerance, and/or adverse reaction lists.</p>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>PH.2.5.4#10</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                \n                <span>SHOULD</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                \n                <span><div><p>The system SHOULD provide the ability to capture the reason for the deactivation of an item on the allergy, intolerance, and/or adverse reaction lists.</p>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>PH.2.5.4#11</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                \n                <span>SHOULD</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                \n                <span><div><p>The system SHOULD present allergies, intolerances and adverse reactions that have been deactivated.</p>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>PH.2.5.4#12</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                \n                <span>MAY</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                \n                <span><div><p>The system MAY provide the ability to present the list of allergies, intolerances, and/or adverse reactions in an order that is defined by the PHR Account Holder.</p>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>PH.2.5.4#13</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                \n                <span>SHALL</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                \n                <span><div><p>The system SHALL provide the ability to capture and maintain the date on which allergy information was entered.</p>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>PH.2.5.4#14</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                \n                <span>SHOULD</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                \n                <span><div><p>The system SHOULD provide the ability to capture and maintain the approximate date of the allergy, intolerance, sensitivity, and/or adverse reaction occurrence.</p>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>PH.2.5.4#15</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                \n                <span>MAY</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                \n                <span><div><p>The system MAY provide the ability to render a standard adverse reaction report within a jurisdiction (e.g., a standard report regarding an adverse reaction to a vaccine). For example, an adverse reaction report could be transmitted to a public health organization.</p>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n    </table>\n</div>"
      },
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
          "valueCode" : "ehr"
        }
      ],
      "url" : "http://hl7.org/ehrs/uv/phrsfmr2/Requirements/PHRSFMR2-PH.2.5.4",
      "version" : "2.0.1-ballot",
      "name" : "PH_2_5_4_Manage_Allergy__Intolerance__and_Adverse_Reaction_List",
      "title" : "PH.2.5.4 Manage Allergy, Intolerance, and Adverse Reaction List (Function)",
      "status" : "active",
      "date" : "2025-04-04T11:42:51+11:00",
      "publisher" : "EHR WG",
      "contact" : [
        {
          "telecom" : [
            {
              "system" : "url",
              "value" : "http://www.hl7.org/Special/committees/ehr"
            }
          ]
        }
      ],
      "description" : "Manage the PHR Account Holder’s list of known allergens and adverse reactions with all pertinent information.",
      "purpose" : "Allergies, intolerances, sensitivities, and adverse reactions must be reviewed with every new prescription to avoid an allergic reaction. \r\n\r\nEnvironmental and food allergens should be listed and maintained here, as well as allergies to bee sting, sunlight, or substances (e.g., latex, metal, or contrast media (such as dye).\r\n\r\nExample(s): The system SHALL provide the ability to enter, store, update and display information related to allergic and adverse reactions or intolerances to drug and non-drug allergens or substances.",
      "statement" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.4-01",
          "label" : "PH.2.5.4#01",
          "conformance" : [
            "SHALL"
          ],
          "conditionality" : false,
          "requirement" : "The system SHALL provide the ability to manage information related to allergy, intolerance, and adverse reaction to drugs, foods, or environmental triggers as unique, discrete entries (including, for example, substances such as latex, metal, and contrast media (such as dye)).",
          "satisfiedBy" : [
            "https://www.hl7.org/fhir/allergyintolerance.html"
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.4-02",
          "label" : "PH.2.5.4#02",
          "conformance" : [
            "SHOULD"
          ],
          "conditionality" : false,
          "requirement" : "The system SHOULD provide the ability to capture the reason for entry of the allergy, intolerance or adverse reaction."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.4-03",
          "label" : "PH.2.5.4#03",
          "conformance" : [
            "SHALL"
          ],
          "conditionality" : false,
          "requirement" : "The system SHALL provide the ability to manage information related to allergic and adverse reactions to drug and non-drug allergens or substances."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.4-04",
          "label" : "PH.2.5.4#04",
          "conformance" : [
            "SHALL"
          ],
          "conditionality" : false,
          "requirement" : "The system SHALL provide the ability to manage information regarding the reaction type."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.4-05",
          "label" : "PH.2.5.4#05",
          "conformance" : [
            "SHALL"
          ],
          "conditionality" : false,
          "requirement" : "The system SHALL provide the ability to manage information regarding the severity of a reaction."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.4-06",
          "label" : "PH.2.5.4#06",
          "conformance" : [
            "SHOULD"
          ],
          "conditionality" : false,
          "requirement" : "The system SHOULD provide the ability to maintain associated allergic reactions to the prevention protocols and/or medications being taken."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.4-07",
          "label" : "PH.2.5.4#07",
          "conformance" : [
            "SHALL"
          ],
          "conditionality" : false,
          "requirement" : "The system SHALL provide the ability to manage an indication regarding the negation of a health reaction (e.g., No Known Allergies (NKA), No Known Drug Allergies (NKDA), No Known Food Allergies (NKFA), No Known Sensitivies, or No Known Intolerances)."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.4-08",
          "label" : "PH.2.5.4#08",
          "conformance" : [
            "SHOULD"
          ],
          "conditionality" : false,
          "requirement" : "The system SHOULD provide the ability to capture the source of allergy, intolerance, and adverse reaction information."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.4-09",
          "label" : "PH.2.5.4#09",
          "conformance" : [
            "SHOULD"
          ],
          "conditionality" : false,
          "requirement" : "The system SHOULD provide the ability to capture and maintain an indication regarding the deactivation of an item on the allergy, intolerance, and/or adverse reaction lists."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.4-10",
          "label" : "PH.2.5.4#10",
          "conformance" : [
            "SHOULD"
          ],
          "conditionality" : false,
          "requirement" : "The system SHOULD provide the ability to capture the reason for the deactivation of an item on the allergy, intolerance, and/or adverse reaction lists."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.4-11",
          "label" : "PH.2.5.4#11",
          "conformance" : [
            "SHOULD"
          ],
          "conditionality" : false,
          "requirement" : "The system SHOULD present allergies, intolerances and adverse reactions that have been deactivated."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.4-12",
          "label" : "PH.2.5.4#12",
          "conformance" : [
            "MAY"
          ],
          "conditionality" : false,
          "requirement" : "The system MAY provide the ability to present the list of allergies, intolerances, and/or adverse reactions in an order that is defined by the PHR Account Holder."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.4-13",
          "label" : "PH.2.5.4#13",
          "conformance" : [
            "SHALL"
          ],
          "conditionality" : false,
          "requirement" : "The system SHALL provide the ability to capture and maintain the date on which allergy information was entered."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.4-14",
          "label" : "PH.2.5.4#14",
          "conformance" : [
            "SHOULD"
          ],
          "conditionality" : false,
          "requirement" : "The system SHOULD provide the ability to capture and maintain the approximate date of the allergy, intolerance, sensitivity, and/or adverse reaction occurrence."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.4-15",
          "label" : "PH.2.5.4#15",
          "conformance" : [
            "MAY"
          ],
          "conditionality" : false,
          "requirement" : "The system MAY provide the ability to render a standard adverse reaction report within a jurisdiction (e.g., a standard report regarding an adverse reaction to a vaccine). For example, an adverse reaction report could be transmitted to a public health organization."
        }
      ]
    }