HL7 Electronic Health Record System Functional Model, Release 2.1.1
2.1.1-ballot - Normative Ballot

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

## : CP.1.6 Manage Immunization List (Function) - JSON Representation

Page standards status: Informative

Raw json | Download

    {
      "resourceType" : "Requirements",
      "id" : "EHRSFMR2-CP.1.6",
      "meta" : {
        "profile" : [
          🔗 "http://hl7.org/ehrs/uv/ehrsfmr2/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>Create and maintain patient-specific immunization lists.</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 lists are managed over time, whether over the course of a visit or stay, or the lifetime of a patient. Details of immunizations administered are captured as discrete data elements including date, type, manufacturer and lot number. The entire immunization history is viewable.</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>CP.1.6#01</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 manage all immunizations associated with a patient.</p>\n</div></span>\n                \n                \n                Satisfied by:<ol>\n                \n                    <li><a href=\"https://hl7.org/fhir/immunization.html\">https://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>CP.1.6#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 provide the ability to maintain immunization details, as discrete data, including:</p>\n<ul>\n<li>the immunization name/type, seqeunce number in the series &amp; series identifier, strength and dose;</li>\n<li>the date and time of administration;</li>\n<li>manufacturer, lot number, expiration date,</li>\n<li>route and site of administration;</li>\n<li>administering provider;</li>\n<li>observations, reactions and complications;</li>\n<li>reason immunization not given, and/or immunization related activity not performed;\naccording to scope of practice, organizational policy, and/or jurisdictional law.</li>\n</ul>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>CP.1.6#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, as discrete elements, data associated with an immunization that was not given to a patient (e.g., due to a contraindication or a patient's refusal). Data associated with an immunization that was not given to a patient includes date-and-time, immunization type, series, exception reason, and immunization-withholding provider.</p>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>CP.1.6#04</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                <i>dependent</i>\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 render (e.g., print or transmit) a report of a patient's immunization history (e.g., for appropriate authorities such as schools, day-care centers or public health immunization registries) according to scope of practice, 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>CP.1.6#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 capture the currently recommended date for a companion immunization (e.g., a subsequent or booster dose) with each immunization (if such a companion immunization is needed).</p>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>CP.1.6#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, maintain and render population-based immunization schedules from relevant public health immunization authorities (e.g., CDC for US realm).</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/ehrsfmr2/Requirements/EHRSFMR2-CP.1.6",
      "version" : "2.1.1-ballot",
      "name" : "CP_1_6_Manage_Immunization_List",
      "title" : "CP.1.6 Manage Immunization List (Function)",
      "status" : "active",
      "date" : "2025-04-04T11:04:36+11:00",
      "publisher" : "HL7 International / Electronic Health Records",
      "contact" : [
        {
          "telecom" : [
            {
              "system" : "url",
              "value" : "http://www.hl7.org/Special/committees/ehr"
            }
          ]
        }
      ],
      "description" : "Create and maintain patient-specific immunization lists.",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
              "code" : "001",
              "display" : "World"
            }
          ]
        }
      ],
      "purpose" : "Immunization lists are managed over time, whether over the course of a visit or stay, or the lifetime of a patient. Details of immunizations administered are captured as discrete data elements including date, type, manufacturer and lot number. The entire immunization history is viewable.",
      "statement" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/ehrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "EHRSFMR2-CP.1.6-01",
          "label" : "CP.1.6#01",
          "conformance" : [
            "SHOULD"
          ],
          "conditionality" : false,
          "requirement" : "The system SHOULD provide the ability to manage all immunizations associated with a patient.",
          "derivedFrom" : "EHR-S_FM_R1.1 DC.1.4.4#1",
          "satisfiedBy" : [
            "https://hl7.org/fhir/immunization.html"
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/ehrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : true
            }
          ],
          "key" : "EHRSFMR2-CP.1.6-02",
          "label" : "CP.1.6#02",
          "conformance" : [
            "SHOULD"
          ],
          "conditionality" : false,
          "requirement" : "The system SHOULD provide the ability to maintain immunization details, as discrete data, including:\n- the immunization name/type, seqeunce number in the series & series identifier, strength and dose;\n- the date and time of administration;\n- manufacturer, lot number, expiration date,\n- route and site of administration;\n- administering provider;\n- observations, reactions and complications;\n- reason immunization not given, and/or immunization related activity not performed;\naccording to scope of practice, organizational policy, and/or jurisdictional law.",
          "derivedFrom" : "EHR-S_FM_R1.1 DC.1.4.4#2"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/ehrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "EHRSFMR2-CP.1.6-03",
          "label" : "CP.1.6#03",
          "conformance" : [
            "SHALL"
          ],
          "conditionality" : false,
          "requirement" : "The system SHALL provide the ability to manage, as discrete elements, data associated with an immunization that was not given to a patient (e.g., due to a contraindication or a patient's refusal). Data associated with an immunization that was not given to a patient includes date-and-time, immunization type, series, exception reason, and immunization-withholding provider."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/ehrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : true
            }
          ],
          "key" : "EHRSFMR2-CP.1.6-04",
          "label" : "CP.1.6#04",
          "conformance" : [
            "SHALL"
          ],
          "conditionality" : false,
          "requirement" : "The system SHALL provide the ability to render (e.g., print or transmit) a report of a patient's immunization history (e.g., for appropriate authorities such as schools, day-care centers or public health immunization registries) according to scope of practice, organizational policy, and/or jurisdictional law.",
          "derivedFrom" : "EHR-S_FM_R1.1 DC.1.4.4#3"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/ehrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "EHRSFMR2-CP.1.6-05",
          "label" : "CP.1.6#05",
          "conformance" : [
            "SHALL"
          ],
          "conditionality" : false,
          "requirement" : "The system SHALL provide the ability to capture the currently recommended date for a companion immunization (e.g., a subsequent or booster dose) with each immunization (if such a companion immunization is needed)."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/ehrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "EHRSFMR2-CP.1.6-06",
          "label" : "CP.1.6#06",
          "conformance" : [
            "SHALL"
          ],
          "conditionality" : false,
          "requirement" : "The system SHALL provide the ability to capture, maintain and render population-based immunization schedules from relevant public health immunization authorities (e.g., CDC for US realm)."
        }
      ]
    }