Consumer Mobile Health Application Functional Framework, Release 2
2.0.1 - CI build
Consumer Mobile Health Application Functional Framework, Release 2, published by HL7 International / Mobile Health. 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/cmhaff-ig/ and changes regularly. See the Directory of published versions
| Page standards status: Informative |
<Requirements xmlns="http://hl7.org/fhir">
<id value="CMHAFFR2-APU.7"/>
<meta>
<profile
value="http://hl7.org/ehrs/uv/cmhaffr2/StructureDefinition/FMFunction"/>
</meta>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<div id="description"><b>Description <a href="https://hl7.org/fhir/versions.html#std-process" title="Informative Content" class="informative-flag">I</a>:</b> <p>
Example:
In the realm of alerts and notifications, the following table proposed suggested standardized (generic)terms in the left column, with mappings to the
leading two platforms in the middle columns, and comments in the right column. The platform-specific definitions have been derived from web
sources,with preference given to information from the creators of the platforms (Apple, Google). Note: the mapping cannot be made an exact 1:1. In
some cases, the platform-specific term may be more precise(e.g., subtypes) than the generic term, but we do not require a generic equivalent for
every platform- specific term. In other cases, there may be substantial similarity of concepts across platforms, but not identical behavior, and
certainly not identical appearance.
Despite the proposed granularity of these terms, that does not mean that there need to be separatecMHAFF conformance requirements for each
type, but at least the opportunity is there if the need arises. In particular, there may be different conformance requirements for “alerts” vs other
types ofnotifications.
Suggested “standardized” Apple (iOS) equivalent Google (Android OS) Comments
(generic) term for cMHAFF equivalent
Message Generally refers to Generally used to refer to Message, or Messaging, can
Any computer to computer or messages within specific messages from one describe cMHAFF’s overarching term
computer-to-human interface, types of apps, like email, device (or server) to for the data packages that are sent
whether via visual, aural, haptic, text, IM, Facebook… another. by apps. While we consider
olfactory, taste, or neural notifications and alerts as special
mediums. However, when types of messages, the specific term
discussing interoperability, the “message” is used a lot for messages
focus is on computer-to- within apps, but not generally used
computer 3 messaging. Note that when describing alerts and
the messages can be transmitted notifications. We in HL7 also have
within the same physical the HIT-specific legacy of structured
computer, but between different “messaging” formats that include
software (e.g., APIs). healthcare content and sometimes
PHI (e.g., HL7 v2 message).
Notification Notification – generic Notification – generic Generic term that has subtypes.
A device-specific message term to cover many term to cover many types
communicated to a user to inform types of notifications. of notifications. While HIT also has “notifications” that
them of device or app activities may be delivered to an app, not just
that are deemed important to the to a human user, cMHAFF uses a
user. Some types of notifications common consumer-based definition
require a response from the user,
while others do not.
Alert Alert Alert Dialog, aka These messages will always be seen
A type of Notification that is Dialog Notification by the user, except if the device is
communicated to a user and turned off or the user does not look at
requires a response before the the device at all (nothing is
user can proceed with activity on guaranteed). In general, these are
the device. For example, it may considered more “serious” than other
take the form of a “modal” pop-up types of notifications. Local or other
dialog that must be dismissed by policy make have more stringent
clicking OK or taking some other rules for anything deemed an “alert”
action. vs a “notification.”
Persistent Notification Notifications (in Status Notification Android has more than one type of
A device-specific message Notification Center) notification.
communicated to a user to inform Status Notifications can
them of device or app activities Badge (on individual app appear outside the app
and remain displayed on the icons) window and can be used
device. These remain persistent to attract the user back to
until the user deletes them or the app.
takes an action that changes their
status (e.g., checks text
messages, checks email)
Temporary Notification Banner Toast Since these messages fade after a
A subtype of Notification that short time, it is very possible that
does not remain displayed on the “Lock screen Toasts appear within the they will not be seen at all. In
screen more than a short time notifications” look like app window, not outside Android, Toasts appear within the
period. banners but appear on of it app window (not outside the app). In
the lock screen. iOS, they can appear outside the
app.
Emergency Notification iPhone provides options Four types: presidential These are outside the scope of an
A notification from an external for two types of notifications, imminent app, are not written by MH app
source, such as the government, Government Alerts, extreme notifications, developers, but can be configured to
communicating important “AMBER Alerts” and imminent severe alert and display on the device. They are
information about your area (e.g., “Emergency Alerts.” AMBER alert. You can mentioned so that we don’t use the
emergency, disaster, weather…) turn off every alert except same terms for something else.
for the presidential alert.
Hierarchy
• Message (overarching term)
o Content Message (e.g., HL7 v2, C-CDA payload, FHIR resource) – out of the scope for this set of definitions.
o Notification (overarching term)
Alert (requires user action, whereas all other types of notifications do not require it,though they may allow it)
Persistent notification
Temporary notification
Emergency Notification (government, outside app control)</p></div>
<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>
<table id="statements" class="grid dict">
<tr>
<td style="padding-left: 4px;">
APU.7#01
</td>
<td style="padding-left: 4px;">
SHALL
</td>
<td style="padding-left: 4px;" class="requirement">
<p>The system SHALL require opt-in consent from the account holder before sending notifications and alerts.</p>
</td>
</tr>
<tr>
<td style="padding-left: 4px;">
APU.7#02
</td>
<td style="padding-left: 4px;">
SHALL
</td>
<td style="padding-left: 4px;" class="requirement">
<p>The system SHALL inform the account holder of both the content and the channel, such as SMS, push notification, or email, of the notification or alert that is consented to.</p>
</td>
</tr>
<tr>
<td style="padding-left: 4px;">
APU.7#03
</td>
<td style="padding-left: 4px;">
SHALL
<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>
</td>
<td style="padding-left: 4px;" class="requirement">
<p>IF an alert, notification, or message is generated or prioritized by AI THEN the system SHALL identify the message as AI-generated or AI-prioritized when that information is material to the user's interpretation or action.</p>
</td>
</tr>
<tr>
<td style="padding-left: 4px;">
APU.7#04
</td>
<td style="padding-left: 4px;">
SHALL
</td>
<td style="padding-left: 4px;" class="requirement">
<p>The system SHALL provide the account holder with the ability to change consent decisions about notifications and alerts through settings available on the device on which the system was downloaded.</p>
</td>
</tr>
<tr>
<td style="padding-left: 4px;">
APU.7#05
</td>
<td style="padding-left: 4px;">
SHALL
</td>
<td style="padding-left: 4px;" class="requirement">
<p>The system SHALL provide notifications and alerts that contain the least amount of information necessary for the recipient to take a focused action.</p>
</td>
</tr>
<tr>
<td style="padding-left: 4px;">
APU.7#06
</td>
<td style="padding-left: 4px;">
SHALL
<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>
</td>
<td style="padding-left: 4px;" class="requirement">
<p>IF alerts notify the user of conditions that are abnormal, exceptional, or determined to be out of range THEN the system SHALL document or reference the sources (evidence base) of the formulas and algorithms on which those alerts and notifications are based.</p>
</td>
</tr>
<tr>
<td style="padding-left: 4px;">
APU.7#07
</td>
<td style="padding-left: 4px;">
SHALL
<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>
</td>
<td style="padding-left: 4px;" class="requirement">
<p>IF an AI-generated alert advises a health or safety action THEN the system SHALL ensure that the alert's triggering logic, evidence basis, validation scope, and safe escalation instructions are documented and appropriate to the system's intended use.</p>
</td>
</tr>
<tr>
<td style="padding-left: 4px;">
APU.7#08
</td>
<td style="padding-left: 4px;">
SHOULD
<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>
</td>
<td style="padding-left: 4px;" class="requirement">
<p>IF permitted by the account holder and agreed to by the recipients THEN the system SHOULD provide the ability to send notifications and alerts to the account holder and to another person or entity.</p>
</td>
</tr>
<tr>
<td style="padding-left: 4px;">
APU.7#09
</td>
<td style="padding-left: 4px;">
SHOULD
</td>
<td style="padding-left: 4px;" class="requirement">
<p>The system SHOULD provide alerts that notify the user of potential faults that could cause inconvenience or harm, such as low battery alerts.</p>
</td>
</tr>
<tr>
<td style="padding-left: 4px;">
APU.7#10
</td>
<td style="padding-left: 4px;">
SHOULD
</td>
<td style="padding-left: 4px;" class="requirement">
<p>The system SHOULD notify the user in the case of external interruptions or delays, such as loss of network connection, a database problem, or a lengthy operation.</p>
</td>
</tr>
<tr>
<td style="padding-left: 4px;">
APU.7#11
</td>
<td style="padding-left: 4px;">
SHOULD
<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>
</td>
<td style="padding-left: 4px;" class="requirement">
<p>IF the system can detect AI uncertainty, out-of-distribution input, or unavailable supporting data THEN the system SHOULD suppress, downgrade, or qualify the AI-generated alert when the risk assessment indicates that the underlying output may be unreliable.</p>
</td>
</tr>
<tr>
<td style="padding-left: 4px;">
APU.7#12
</td>
<td style="padding-left: 4px;">
MAY
<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>
</td>
<td style="padding-left: 4px;" class="requirement">
<p>IF the system uses AI to personalize notification timing or content THEN the system MAY allow the account holder to control the personalization settings and the categories of data used for personalization.</p>
</td>
</tr>
</table>
</div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="mobile"/>
</extension>
<url value="http://hl7.org/ehrs/uv/cmhaffr2/Requirements/CMHAFFR2-APU.7"/>
<version value="2.0.1"/>
<name value="APU_7_Notifications_and_Alerts"/>
<title value="APU.7 Notifications and Alerts (Function)"/>
<status value="active"/>
<date value="2026-11-18T11:24:54+00:00"/>
<publisher value="HL7 International / Mobile Health"/>
<contact>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/mobile"/>
</telecom>
</contact>
<description
value="This category applies only if an app exchanges data with other devices, health apps, and/or HIT systems. If so, there are applicable
standards for data format, vocabulary, and transport, to increase interoperability and ease of connection."/>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
<display value="World"/>
</coding>
</jurisdiction>
<purpose
value="
Example:
In the realm of alerts and notifications, the following table proposed suggested standardized (generic)terms in the left column, with mappings to the
leading two platforms in the middle columns, and comments in the right column. The platform-specific definitions have been derived from web
sources,with preference given to information from the creators of the platforms (Apple, Google). Note: the mapping cannot be made an exact 1:1. In
some cases, the platform-specific term may be more precise(e.g., subtypes) than the generic term, but we do not require a generic equivalent for
every platform- specific term. In other cases, there may be substantial similarity of concepts across platforms, but not identical behavior, and
certainly not identical appearance.
Despite the proposed granularity of these terms, that does not mean that there need to be separatecMHAFF conformance requirements for each
type, but at least the opportunity is there if the need arises. In particular, there may be different conformance requirements for “alerts” vs other
types ofnotifications.
Suggested “standardized” Apple (iOS) equivalent Google (Android OS) Comments
(generic) term for cMHAFF equivalent
Message Generally refers to Generally used to refer to Message, or Messaging, can
Any computer to computer or messages within specific messages from one describe cMHAFF’s overarching term
computer-to-human interface, types of apps, like email, device (or server) to for the data packages that are sent
whether via visual, aural, haptic, text, IM, Facebook… another. by apps. While we consider
olfactory, taste, or neural notifications and alerts as special
mediums. However, when types of messages, the specific term
discussing interoperability, the “message” is used a lot for messages
focus is on computer-to- within apps, but not generally used
computer 3 messaging. Note that when describing alerts and
the messages can be transmitted notifications. We in HL7 also have
within the same physical the HIT-specific legacy of structured
computer, but between different “messaging” formats that include
software (e.g., APIs). healthcare content and sometimes
PHI (e.g., HL7 v2 message).
Notification Notification – generic Notification – generic Generic term that has subtypes.
A device-specific message term to cover many term to cover many types
communicated to a user to inform types of notifications. of notifications. While HIT also has “notifications” that
them of device or app activities may be delivered to an app, not just
that are deemed important to the to a human user, cMHAFF uses a
user. Some types of notifications common consumer-based definition
require a response from the user,
while others do not.
Alert Alert Alert Dialog, aka These messages will always be seen
A type of Notification that is Dialog Notification by the user, except if the device is
communicated to a user and turned off or the user does not look at
requires a response before the the device at all (nothing is
user can proceed with activity on guaranteed). In general, these are
the device. For example, it may considered more “serious” than other
take the form of a “modal” pop-up types of notifications. Local or other
dialog that must be dismissed by policy make have more stringent
clicking OK or taking some other rules for anything deemed an “alert”
action. vs a “notification.”
Persistent Notification Notifications (in Status Notification Android has more than one type of
A device-specific message Notification Center) notification.
communicated to a user to inform Status Notifications can
them of device or app activities Badge (on individual app appear outside the app
and remain displayed on the icons) window and can be used
device. These remain persistent to attract the user back to
until the user deletes them or the app.
takes an action that changes their
status (e.g., checks text
messages, checks email)
Temporary Notification Banner Toast Since these messages fade after a
A subtype of Notification that short time, it is very possible that
does not remain displayed on the “Lock screen Toasts appear within the they will not be seen at all. In
screen more than a short time notifications” look like app window, not outside Android, Toasts appear within the
period. banners but appear on of it app window (not outside the app). In
the lock screen. iOS, they can appear outside the
app.
Emergency Notification iPhone provides options Four types: presidential These are outside the scope of an
A notification from an external for two types of notifications, imminent app, are not written by MH app
source, such as the government, Government Alerts, extreme notifications, developers, but can be configured to
communicating important “AMBER Alerts” and imminent severe alert and display on the device. They are
information about your area (e.g., “Emergency Alerts.” AMBER alert. You can mentioned so that we don’t use the
emergency, disaster, weather…) turn off every alert except same terms for something else.
for the presidential alert.
Hierarchy
• Message (overarching term)
o Content Message (e.g., HL7 v2, C-CDA payload, FHIR resource) – out of the scope for this set of definitions.
o Notification (overarching term)
Alert (requires user action, whereas all other types of notifications do not require it,though they may allow it)
Persistent notification
Temporary notification
Emergency Notification (government, outside app control)"/>
<statement>
<extension
url="http://hl7.org/ehrs/uv/cmhaffr2/StructureDefinition/requirements-dependent">
<valueBoolean value="false"/>
</extension>
<key value="CMHAFFR2-APU.7-01"/>
<label value="APU.7#01"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The system SHALL require opt-in consent from the account holder before sending notifications and alerts."/>
</statement>
<statement>
<extension
url="http://hl7.org/ehrs/uv/cmhaffr2/StructureDefinition/requirements-dependent">
<valueBoolean value="false"/>
</extension>
<key value="CMHAFFR2-APU.7-02"/>
<label value="APU.7#02"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The system SHALL inform the account holder of both the content and the channel, such as SMS, push notification, or email, of the notification or alert that is consented to."/>
</statement>
<statement>
<extension
url="http://hl7.org/ehrs/uv/cmhaffr2/StructureDefinition/requirements-dependent">
<valueBoolean value="false"/>
</extension>
<key value="CMHAFFR2-APU.7-03"/>
<label value="APU.7#03"/>
<conformance value="SHALL"/>
<conditionality value="true"/>
<requirement
value="IF an alert, notification, or message is generated or prioritized by AI THEN the system SHALL identify the message as AI-generated or AI-prioritized when that information is material to the user's interpretation or action."/>
</statement>
<statement>
<extension
url="http://hl7.org/ehrs/uv/cmhaffr2/StructureDefinition/requirements-dependent">
<valueBoolean value="false"/>
</extension>
<key value="CMHAFFR2-APU.7-04"/>
<label value="APU.7#04"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The system SHALL provide the account holder with the ability to change consent decisions about notifications and alerts through settings available on the device on which the system was downloaded."/>
</statement>
<statement>
<extension
url="http://hl7.org/ehrs/uv/cmhaffr2/StructureDefinition/requirements-dependent">
<valueBoolean value="false"/>
</extension>
<key value="CMHAFFR2-APU.7-05"/>
<label value="APU.7#05"/>
<conformance value="SHALL"/>
<conditionality value="false"/>
<requirement
value="The system SHALL provide notifications and alerts that contain the least amount of information necessary for the recipient to take a focused action."/>
</statement>
<statement>
<extension
url="http://hl7.org/ehrs/uv/cmhaffr2/StructureDefinition/requirements-dependent">
<valueBoolean value="false"/>
</extension>
<key value="CMHAFFR2-APU.7-06"/>
<label value="APU.7#06"/>
<conformance value="SHALL"/>
<conditionality value="true"/>
<requirement
value="IF alerts notify the user of conditions that are abnormal, exceptional, or determined to be out of range THEN the system SHALL document or reference the sources (evidence base) of the formulas and algorithms on which those alerts and notifications are based."/>
</statement>
<statement>
<extension
url="http://hl7.org/ehrs/uv/cmhaffr2/StructureDefinition/requirements-dependent">
<valueBoolean value="false"/>
</extension>
<key value="CMHAFFR2-APU.7-07"/>
<label value="APU.7#07"/>
<conformance value="SHALL"/>
<conditionality value="true"/>
<requirement
value="IF an AI-generated alert advises a health or safety action THEN the system SHALL ensure that the alert's triggering logic, evidence basis, validation scope, and safe escalation instructions are documented and appropriate to the system's intended use."/>
</statement>
<statement>
<extension
url="http://hl7.org/ehrs/uv/cmhaffr2/StructureDefinition/requirements-dependent">
<valueBoolean value="false"/>
</extension>
<key value="CMHAFFR2-APU.7-08"/>
<label value="APU.7#08"/>
<conformance value="SHOULD"/>
<conditionality value="true"/>
<requirement
value="IF permitted by the account holder and agreed to by the recipients THEN the system SHOULD provide the ability to send notifications and alerts to the account holder and to another person or entity."/>
</statement>
<statement>
<extension
url="http://hl7.org/ehrs/uv/cmhaffr2/StructureDefinition/requirements-dependent">
<valueBoolean value="false"/>
</extension>
<key value="CMHAFFR2-APU.7-09"/>
<label value="APU.7#09"/>
<conformance value="SHOULD"/>
<conditionality value="false"/>
<requirement
value="The system SHOULD provide alerts that notify the user of potential faults that could cause inconvenience or harm, such as low battery alerts."/>
</statement>
<statement>
<extension
url="http://hl7.org/ehrs/uv/cmhaffr2/StructureDefinition/requirements-dependent">
<valueBoolean value="false"/>
</extension>
<key value="CMHAFFR2-APU.7-10"/>
<label value="APU.7#10"/>
<conformance value="SHOULD"/>
<conditionality value="false"/>
<requirement
value="The system SHOULD notify the user in the case of external interruptions or delays, such as loss of network connection, a database problem, or a lengthy operation."/>
</statement>
<statement>
<extension
url="http://hl7.org/ehrs/uv/cmhaffr2/StructureDefinition/requirements-dependent">
<valueBoolean value="false"/>
</extension>
<key value="CMHAFFR2-APU.7-11"/>
<label value="APU.7#11"/>
<conformance value="SHOULD"/>
<conditionality value="true"/>
<requirement
value="IF the system can detect AI uncertainty, out-of-distribution input, or unavailable supporting data THEN the system SHOULD suppress, downgrade, or qualify the AI-generated alert when the risk assessment indicates that the underlying output may be unreliable."/>
</statement>
<statement>
<extension
url="http://hl7.org/ehrs/uv/cmhaffr2/StructureDefinition/requirements-dependent">
<valueBoolean value="false"/>
</extension>
<key value="CMHAFFR2-APU.7-12"/>
<label value="APU.7#12"/>
<conformance value="MAY"/>
<conditionality value="true"/>
<requirement
value="IF the system uses AI to personalize notification timing or content THEN the system MAY allow the account holder to control the personalization settings and the categories of data used for personalization."/>
</statement>
</Requirements>