Personal Health Device Implementation Guide
2.1.0 - STU 2.0 International flag

Personal Health Device Implementation Guide, published by HL7 International / Health Care Devices. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/phd/ and changes regularly. See the Directory of published versions

Extension: SimpleAlerting

Official URL: http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting Version: 2.1.0
Standards status: Trial-use Maturity Level: 3 Computable Name: SimpleAlerting

A simple alerting extension for PHDs.

Context of Use

Usage info

Usage:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension SimpleAlerting
... extension 2..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:alertType 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "alertType"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: MDC Value Set (extensible)
.... extension:currentLimits 1..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "currentLimits"
..... value[x] C 1..1 Range Value of extension
alerting-range-units: The units used should be equal.
...... low
....... unit 0..1 string Unit representation
...... high
....... unit 0..1 string Unit representation
.... extension:alertOperationalState 1..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "alertOperationalState"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Simple Alert Operational States (extensible)
.... extension:alertOperationalText 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "alertOperationalText"
..... value[x] 0..1 string Value of extension
.... extension:thresholdNotificationText 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "thresholdNotificationText"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:alertType.value[x]extensibleMDCValueSet
http://hl7.org/fhir/uv/phd/ValueSet/MDCValueSet
from this IG
Extension.extension:alertOperationalState.value[x]extensibleSimpleAlertOperationalStates (a valid code from Simple Alert Operational States)
http://hl7.org/fhir/uv/phd/ValueSet/SimpleAlertOperationalStates
from this IG

Constraints

IdGradePath(s)DetailsRequirements
alerting-range-unitswarningExtension.extension:currentLimits.value[x]The units used should be equal.
: low.code.exists() and high.code.exists() and low.code = high.code
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Notes:

Notes for the SimpleAlerting Extension

The SimpleAlerting extension is used to define the behavior and configuration of simple alerting systems for PHD Devices. Below is a description of the original IEEE 11073-20601 attributes, including their MDC code and the corresponding element in the extension. In IEEE 11073-10206 / ACOM simple alerting can be modeled as an extension to a numeric observation with the same attributes as this FHIR extension.

Alert Type

In some cases there can be multiple types of alerts defined for a monitored value. For example in a continuous glucose monitor there can be a patient normal range low and high value and a critical hypo and hyper value. In IEEE 11073-20601 these are reported as numeric settings with MDC codes MDC_CONC_GLU_PATIENT_THRESHOLDS_LOW_HIGH and MDC_CONC_GLU_THRESHOLDS_HYPO_HYPER that reports the monitored low and high limits.

Current Limits

The IEEE 11073 Current-Limits attribute specifies the lower and upper threshold limits of the monitored parameter. The MDC code of the attribute is MDC_ATTR_LIMIT_CURR.

The currentLimits element specifies the acceptable range for the monitored parameter. It is represented as a valueRange with the following sub-elements:

  • low: The lower limit of the acceptable range. If the monitored value falls below this limit, an alert may be triggered.
  • high: The upper limit of the acceptable range. If the monitored value exceeds this limit, an alert may be triggered.
  • Units: The limits are expressed in a specific unit (e.g., % for percentages) using the Unified Code for Units of Measure (UCUM) and should match the unit of the monitored parameter.

Alert Operational State

The IEEE 11073 Alert Operational State attribute uses an ASN1-BITs field to indicate whether the alerts on a given limit (upper or lower) are on or off. When SET, the alerts are off. This is a state-type measurement, and when this attribute is present, both the set and cleared states are reported. The MDC code of the attribute is MDC_ATTR_AL_OP_STAT.

The alertOperationalState element indicates the current operational state of the alerting system. It is represented as a valueCodeableConcept with codes from the SimpleAlertOperationalStates CodeSystem. Examples of operational states include:

  • On: The alerting system is active and monitoring the parameter.
  • LowLimitOff: The lower limit monitoring is disabled.
  • HighLimitOff: The upper limit monitoring is disabled.
  • LimitsOff: Both upper and lower limit monitoring are disabled.

Alert Operational Text

The IEEE 11073 Alert Operational Text attribute consists of a pair of strings that describe the operational state of the lower and upper threshold monitoring.

The alertOperationalText element provides a single human-readable string describing the operational state of the lower and upper threshold monitoring.

Threshold Notification Text

The IEEE 11073 Threshold-Notification-Text-String attribute provides a human-readable string notifying the user of a value outside the current limits. It may include details about the condition that triggered the alert or instructions for responding to it. The MDC code is MDC_ATTR_THRES_NOTIF_TEXT_STRING

The thresholdNotificationText element provides this notification text, ensuring that users are informed about the specific condition that caused the alert.


These elements collectively define the configuration and behavior of the SimpleAlerting extension, enabling systems to monitor and respond to specific conditions effectively.