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

HL7 Personal Health Record System Functional Model, Release 2, published by EHR WG. This guide is not an authorized publication; it is the continuous build for version 2.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/phrsfm-ig/ and changes regularly. See the Directory of published versions

: PH.3.5.1 Manage Health Calendar (Function)

Page standards status: Normative

Raw json | Download

{
  "resourceType" : "Requirements",
  "id" : "PHRSFMR2-PH.3.5.1",
  "meta" : {
    "profile" : [
      🔗 "http://hl7.org/ehrs/uv/phrsfmr2/StructureDefinition/FMFunction"
    ]
  },
  "language" : "en",
  "text" : {
    "status" : "extensions",
    "div" : "<div xml:lang=\"en\" xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"en\">\n    \n    \n    <div id=\"description\"><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></div>\n    \n    \n    \n    <div id=\"requirements\"><b>Criteria <a href=\"https://hl7.org/fhir/versions.html#std-process\" title=\"Normative Content\" class=\"normative-flag\">N</a>:</b></div>\n    \n    <table id=\"statements\" class=\"grid dict\">\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n            PH.3.5.1#01\n            </td>\n            <td style=\"padding-left: 4px;\">\n            MAY\n            \n            \n            \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                <div><p>The system MAY maintain a health calendar function for recording and displaying scheduled health appointments or events.</p>\n</div>\n                Satisfied by:<ol>\n                <li><a href=\"http://fhir.org/guides/argonaut/scheduling/\">http://fhir.org/guides/argonaut/scheduling/</a></li>\n                </ol>\n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n            PH.3.5.1#02\n            </td>\n            <td style=\"padding-left: 4px;\">\n            SHOULD\n            \n            <span style=\"border-radius: 999px;margin: 2px 2px;font-size: 10px;display: inline-block;padding: 3px 5px;letter-spacing: 0.5px;line-height: 1;white-space: nowrap;background-color: #f3e5ff;color: #7b1fa2;border: 1px solid #d1a3ff;\">conditional</span>\n            \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                <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>\n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n            PH.3.5.1#03\n            </td>\n            <td style=\"padding-left: 4px;\">\n            SHOULD\n            \n            <span style=\"border-radius: 999px;margin: 2px 2px;font-size: 10px;display: inline-block;padding: 3px 5px;letter-spacing: 0.5px;line-height: 1;white-space: nowrap;background-color: #f3e5ff;color: #7b1fa2;border: 1px solid #d1a3ff;\">conditional</span>\n            \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                <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>\n                \n            </td>\n        </tr>\n        \n        <tr>\n            <td style=\"padding-left: 4px;\">\n            PH.3.5.1#04\n            </td>\n            <td style=\"padding-left: 4px;\">\n            MAY\n            \n            <span style=\"border-radius: 999px;margin: 2px 2px;font-size: 10px;display: inline-block;padding: 3px 5px;letter-spacing: 0.5px;line-height: 1;white-space: nowrap;background-color: #f3e5ff;color: #7b1fa2;border: 1px solid #d1a3ff;\">conditional</span>\n            \n            </td>\n            <td style=\"padding-left: 4px;\" class=\"requirement\">\n                <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>\n                \n            </td>\n        </tr>\n        \n    </table>\n</div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "normative"
    },
    {
      "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",
  "name" : "PH_3_5_1_Manage_Health_Calendar",
  "title" : "PH.3.5.1 Manage Health Calendar (Function)",
  "status" : "active",
  "date" : "2025-12-07T09:26:53+00: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."
    }
  ]
}