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.0.0-ballot2 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
Official URL: http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting | Version: 2.0.0-ballot2 | |||
Standards status: Trial-use | Maturity Level: 1 | Computable Name: SimpleAlerting |
A simple alerting extension for PHDs.
Context of Use
This extension may be used on the following element(s)
Observation
DeviceMetric
Observation.component
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..1 | Extension | SimpleAlerting | |
![]() ![]() ![]() |
2..* | Extension | Extension | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "alertType" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: MDC Value Set (extensible) | |
![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "currentLimits" | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | Range | Value of extension Constraints: alerting-range-units |
![]() ![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unit representation | |
![]() ![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unit representation | |
![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "alertOperationalState" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Simple Alert Operational States (extensible) | |
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "alertOperationalText" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "thresholdNotificationText" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting" | |
![]() ![]() ![]() |
0..0 | |||
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..1 | Extension | SimpleAlerting | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "alertType" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: MDC Value Set (extensible) | |
![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "currentLimits" | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | Range | Value of extension Constraints: alerting-range-units |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity | Low limit |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | System that defines coded unit form |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Coded form of the unit |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity | High limit |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | System that defines coded unit form |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Coded form of the unit |
![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "alertOperationalState" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Simple Alert Operational States (extensible) | |
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "alertOperationalText" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "thresholdNotificationText" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting" | |
![]() |
This structure is derived from Extension
Summary
Complex Extension: A simple alerting extension for PHDs.
Maturity: 1
Differential View
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..1 | Extension | SimpleAlerting | |
![]() ![]() ![]() |
2..* | Extension | Extension | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "alertType" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: MDC Value Set (extensible) | |
![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "currentLimits" | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | Range | Value of extension Constraints: alerting-range-units |
![]() ![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unit representation | |
![]() ![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unit representation | |
![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "alertOperationalState" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Simple Alert Operational States (extensible) | |
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "alertOperationalText" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "thresholdNotificationText" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting" | |
![]() ![]() ![]() |
0..0 | |||
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..1 | Extension | SimpleAlerting | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "alertType" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: MDC Value Set (extensible) | |
![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "currentLimits" | |
![]() ![]() ![]() ![]() ![]() |
C | 1..1 | Range | Value of extension Constraints: alerting-range-units |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity | Low limit |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | System that defines coded unit form |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Coded form of the unit |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity | High limit |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | System that defines coded unit form |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Coded form of the unit |
![]() ![]() ![]() ![]() |
1..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "alertOperationalState" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Simple Alert Operational States (extensible) | |
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "alertOperationalText" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "thresholdNotificationText" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |
![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting" | |
![]() |
This structure is derived from Extension
Summary
Complex Extension: A simple alerting extension for PHDs.
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet | URI |
Extension.extension:alertType.value[x] | extensible | MDCValueSethttp://hl7.org/fhir/uv/phd/ValueSet/MDCValueSet From this IG | |
Extension.extension:alertOperationalState.value[x] | extensible | SimpleAlertOperationalStates(a valid code from Simple Alert Operational States)http://hl7.org/fhir/uv/phd/ValueSet/SimpleAlertOperationalStates From this IG |
Id | Grade | Path(s) | Details | Requirements |
alerting-range-units | warning | Extension.extension:currentLimits.value[x] | The units used should be equal. : low.code.exists() and high.code.exists() and low.code = high.code | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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.
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.
The IEEE 11073-10206 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.%
for percentages) using the Unified Code for Units of Measure (UCUM) and should match the unit of the monitored parameter.The IEEE 11073-10206 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 reference Identifier 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
ValueSet. 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.The IEEE 11073-10206 Alert Operational Text attribute consists of a pair of strings that describe the operational state of the lower and upper threshold monitoring. The MDC reference Identifier is MDC_ATTR_AL_OP_TEXT_STRING
.
The alertOperationalText
element provides a single human-readable string describing the operational state of the lower and upper threshold monitoring.
The IEEE 11073-10206 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.