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.3.5.1 Manage Health Calendar (Function) - JSON Representation

Page standards status: Informative

Raw json | Download

    {
      "resourceType" : "Requirements",
      "id" : "PHRSFMR2-PH.3.5.1",
      "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>Provide a health calendar to record and display health care events.</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>A health calendar provides a method to view time related healthcare activity both in the future as scheduled events and in the past as historic events. It is a handy and well understood format. The calendar can also be used as a data input device, mimicking the paper calendar where clinical observations (such as gallbladder attacks or menstrual periods) can be written directly onto a calendar and captured as a timed note. This idea was put forward from usability studies with lay people how they would like to interact with their PHR.</p>\n<p>Example(s): IF a health calendar function is provided, THEN future appointments and other timed events SHOULD be displayed on the health calendar.</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.3.5.1#01</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 maintain a health calendar function for recording and displaying scheduled health appointments or events.</p>\n</div></span>\n                \n                \n                Satisfied by:<ol>\n                \n                    <li><a href=\"http://fhir.org/guides/argonaut/scheduling/\">http://fhir.org/guides/argonaut/scheduling/</a></li>\n                \n                </ol>\n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>PH.3.5.1#02</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                <i>conditional</i>\n                \n                \n                <span>SHOULD</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                \n                <span><div><p>IF a health calendar function is provided, THEN the system SHOULD present future appointments and other timed events on the health calendar.</p>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>PH.3.5.1#03</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                <i>conditional</i>\n                \n                \n                <span>SHOULD</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                \n                <span><div><p>IF a health calendar function is provided, THEN the system SHOULD provide the ability to annotate directly onto the health calendar as date stamped text entries.</p>\n</div></span>\n                \n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n                \n                <span>PH.3.5.1#04</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\">\n                \n                \n                <i>conditional</i>\n                \n                \n                <span>MAY</span>\n                \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                \n                <span><div><p>IF a health calendar function is provided, THEN the system MAY present care plans (e.g., lifelong immunization schedules or cancer surveillance tests) as health calendar entries.</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.3.5.1",
      "version" : "2.0.1-ballot",
      "name" : "PH_3_5_1_Manage_Health_Calendar",
      "title" : "PH.3.5.1 Manage Health Calendar (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" : "Provide a health calendar to record and display health care events.",
      "purpose" : "A health calendar provides a method to view time related healthcare activity both in the future as scheduled events and in the past as historic events. It is a handy and well understood format. The calendar can also be used as a data input device, mimicking the paper calendar where clinical observations (such as gallbladder attacks or menstrual periods) can be written directly onto a calendar and captured as a timed note. This idea was put forward from usability studies with lay people how they would like to interact with their PHR.\r\n\r\nExample(s): IF a health calendar function is provided, THEN future appointments and other timed events SHOULD be displayed on the health calendar.",
      "statement" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.3.5.1-01",
          "label" : "PH.3.5.1#01",
          "conformance" : [
            "MAY"
          ],
          "conditionality" : false,
          "requirement" : "The system MAY maintain a health calendar function for recording and displaying scheduled health appointments or events.",
          "satisfiedBy" : [
            "http://fhir.org/guides/argonaut/scheduling/"
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.3.5.1-02",
          "label" : "PH.3.5.1#02",
          "conformance" : [
            "SHOULD"
          ],
          "conditionality" : true,
          "requirement" : "IF a health calendar function is provided, THEN the system SHOULD present future appointments and other timed events on the health calendar."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.3.5.1-03",
          "label" : "PH.3.5.1#03",
          "conformance" : [
            "SHOULD"
          ],
          "conditionality" : true,
          "requirement" : "IF a health calendar function is provided, THEN the system SHOULD provide the ability to annotate directly onto the health calendar as date stamped text entries."
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/requirements-dependent",
              "valueBoolean" : false
            }
          ],
          "key" : "PHRSFMR2-PH.3.5.1-04",
          "label" : "PH.3.5.1#04",
          "conformance" : [
            "MAY"
          ],
          "conditionality" : true,
          "requirement" : "IF a health calendar function is provided, THEN the system MAY present care plans (e.g., lifelong immunization schedules or cancer surveillance tests) as health calendar entries."
        }
      ]
    }