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.5 Manage Immunization List (Function) - JSON Representation

Page standards status: Informative

Raw json | Download

    {
      "resourceType" : "Requirements",
      "id" : "PHRSFMR2-PH.2.5.5",
      "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 Account Holder's immunization data and associated capabilities including reminders, alerts, compliance, and administration.</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>Immunization records can be maintained in the PHR-S. The list of immunizations can be associated with the health maintenance care plans in PH.1.3.3 maintaining a prospective immunization schedule for routine recommendations. In addition, vaccinations in preparation for foreign travel and episodic public health outbreaks such as bird flu vaccinations can be maintained here. Also, some jurisdictions accept titers or specific dates of infection as proof of adequate protection.</p>\n<p>Immunization information can be shared with national registries in order to support public health / population health stakeholder requirements.</p>\n<p>Example(s): The system SHOULD provide the ability to associate standard codes with discrete data elements associated with an immunization.</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.5#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 immunization histories associated with a PHR Account Holder.</p>\n</div></span>\n                \n                \n                Satisfied by:<ol>\n                \n                    <li><a href=\"https://www.hl7.org/fhir/immunization.html\">https://www.hl7.org/fhir/immunization.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.5#02</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                <i>dependent</i>\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 capture as discrete data elements data associated with any immunization (this might include certification that the immunization was administered) according to organizational policy and/or jurisdictional law.</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.5#03</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 standard codes with discrete data elements associated with an immunization.</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.5#04</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 standard codes with discrete data elements associated with an immunization.</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.5#05</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 immunization administration details, such as date, route of administration, type, lot number, manufacturer, and the identity of the immunization administrator.</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.5#06</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 the currently recommended date for an immunization booster dose with each immunization if needed.</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.5#07</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                <i>dependent</i>\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 render a PHR Account Holder‘s immunization history (e.g., when reporting to appropriate authorities such as public health immunization registries, schools, or day-care centers) according to organizational policy and/or jurisdictional law.</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.5",
      "version" : "2.0.1-ballot",
      "name" : "PH_2_5_5_Manage_Immunization_List",
      "title" : "PH.2.5.5 Manage Immunization 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 Account Holder's immunization data and associated capabilities including reminders, alerts, compliance, and administration.",
      "purpose" : "Immunization records can be maintained in the PHR-S. The list of immunizations can be associated with the health maintenance care plans in PH.1.3.3 maintaining a prospective immunization schedule for routine recommendations. In addition, vaccinations in preparation for foreign travel and episodic public health outbreaks such as bird flu vaccinations can be maintained here. Also, some jurisdictions accept titers or specific dates of infection as proof of adequate protection.\r\n\r\nImmunization information can be shared with national registries in order to support public health / population health stakeholder requirements.\r\n\r\nExample(s): The system SHOULD provide the ability to associate standard codes with discrete data elements associated with an immunization.",
      "statement" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.5-01",
          "label" : "PH.2.5.5#01",
          "conformance" : [
            "SHALL"
          ],
          "conditionality" : false,
          "requirement" : "The system SHALL provide the ability to manage immunization histories associated with a PHR Account Holder.",
          "satisfiedBy" : [
            "https://www.hl7.org/fhir/immunization.html"
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : true
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.5-02",
          "label" : "PH.2.5.5#02",
          "conformance" : [
            "SHOULD"
          ],
          "conditionality" : false,
          "requirement" : "The system SHOULD capture as discrete data elements data associated with any immunization (this might include certification that the immunization was administered) according to organizational policy and/or jurisdictional law."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.5-03",
          "label" : "PH.2.5.5#03",
          "conformance" : [
            "SHOULD"
          ],
          "conditionality" : false,
          "requirement" : "The system SHOULD provide the ability to capture standard codes with discrete data elements associated with an immunization."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.5-04",
          "label" : "PH.2.5.5#04",
          "conformance" : [
            "SHOULD"
          ],
          "conditionality" : false,
          "requirement" : "The system SHOULD provide the ability to maintain standard codes with discrete data elements associated with an immunization."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.5-05",
          "label" : "PH.2.5.5#05",
          "conformance" : [
            "SHOULD"
          ],
          "conditionality" : false,
          "requirement" : "The system SHOULD provide the ability to capture immunization administration details, such as date, route of administration, type, lot number, manufacturer, and the identity of the immunization administrator."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.5-06",
          "label" : "PH.2.5.5#06",
          "conformance" : [
            "SHALL"
          ],
          "conditionality" : false,
          "requirement" : "The system SHALL provide the ability to capture the currently recommended date for an immunization booster dose with each immunization if needed."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : true
            }
          ],
          "key" : "PHRSFMR2-PH.2.5.5-07",
          "label" : "PH.2.5.5#07",
          "conformance" : [
            "SHOULD"
          ],
          "conditionality" : false,
          "requirement" : "The system SHOULD provide the ability to render a PHR Account Holder‘s immunization history (e.g., when reporting to appropriate authorities such as public health immunization registries, schools, or day-care centers) according to organizational policy and/or jurisdictional law."
        }
      ]
    }