Personal Health Device Implementation Guide
3.0.0-ballot - STU 3 Ballot Global (Whole world)

Personal Health Device Implementation Guide, published by HL7 International / Devices. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot 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

Resource Profile: PhdDeviceAlert

Official URL: http://hl7.org/fhir/uv/phd/StructureDefinition/PhdDeviceAlert Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 2 * Computable Name: PhdDeviceAlert
Other Identifiers: OID:2.16.840.1.113883.4.642.40.73.42.10

Profile for device alert that capture alert conditions from personal health devices.

PHD Device Alert Profile

Overview

The PhdDeviceAlert profile is based on the FHIR R6 DeviceAlert resource type and defines how personal health devices (PHDs) report alert conditions in the FHIR Personal Health Device implementation guide. A Personal Health Gateway (PHG) generates a DeviceAlert either when a numeric measurement crosses a configured or patient-specific limit, or when a device/sensor status bit signals a noteworthy condition. This profile represents alerts as separate resources that reference the measurement observations that triggered the alert condition, providing a clear separation between measurement data and alert notifications.

Alert Sources

A PhdDeviceAlert can arise from two distinct sources in the PHD data flow:

1. Threshold (limit) alerts on numeric observations

When a numeric measurement crosses a limit, an alert is raised. The limit may be a device-configured threshold or a patient-specific limit maintained by the Personal Health Gateway (PHG). When the PHG receives (or itself evaluates) a numeric observation whose value is outside the applicable range, it generates a DeviceAlert:

  • type = physiological
  • code is an MDC partition-3 condition such as MDC_EVT_HI (196648) or MDC_EVT_LO (196670)
  • derivedFrom.observation references the triggering PhdNumericObservation, PhdCompoundNumericObservation, or PhdCompoundObservation
  • derivedFrom.component identifies the specific component for a compound observation (e.g. systolic blood pressure)
  • derivedFrom.limit records the threshold range that was crossed. ACOM (IEEE 11073-10206) does not transmit limit values, so the PHG populates limit from device configuration or from locally-maintained, patient-specific settings

The source numeric observation also carries interpretation = in-alarm to mark that it is in an alarm state. See the Blood Pressure and SpO2 examples.

2. Device and sensor status-bit alerts

Devices also report non-numeric conditions — sensor displacement, poor signal quality, low battery, device malfunction, or a vendor device-specific alert — as status bits in their measurement/device-status objects. The PHG surfaces these bits on a PhdBitsEnumerationObservation whose component entries use ASN1ToHL7 codes. When such a bit represents an alert condition, the PHG generates a DeviceAlert:

  • type = technical
  • code is the ASN1ToHL7 status code directly (no MDC "umbrella" code is required)
  • derivedFrom.observation references the PhdBitsEnumerationObservation
  • derivedFrom.component points at the exact ASN1ToHL7 bit that triggered the alert
  • no limit is present, because no threshold was crossed

See the Sensor-Displaced Alert example.

Purpose

Device alerts indicate noteworthy conditions or occurrences detected by personal health devices, such as when a measured value exceeds configured threshold limits. Common examples include:

  • High or low blood pressure readings
  • Abnormal heart rate measurements
  • Low oxygen saturation levels
  • Out-of-range glucose values
  • Device technical alerts

By representing alerts as separate DeviceAlert resources (rather than embedding them within measurement observations), the profile enables:

  • Independent querying: Alerts can be searched and filtered separately from measurements
  • Multiple alerts per measurement: A single observation can trigger different alert types
  • Component-specific alerts: For compound observations, alerts can reference specific components
  • Clear data model: Separation of concerns between measurement data and alert conditions

Device alerts enable important clinical use cases:

  • Remote Patient Monitoring: Healthcare providers can query for active alerts to identify patients requiring attention
  • Alert Acknowledgment: Tracking which alerts have been reviewed and acknowledged
  • Historical Analysis: Analyzing patterns of alert occurrences over time
  • Device Configuration: Understanding what thresholds are configured on devices
  • Clinical Decision Support: Triggering workflows based on specific alert types

Profile Structure

General element semantics (status, priority, occurrence, acknowledged, signal, the condition/signal state machine, and search parameters) are defined by the base DeviceAlert resource. This section only describes where this profile constrains or specializes that behavior for personal health devices.

Alert Condition code (code)

The code element identifies the alert condition. The binding is required to the Device Alert Condition value set, which accepts either an IEEE 11073-10101 MDC partition-3 condition code or a device/sensor status code from the ASN1ToHL7 code system (used when no MDC concept fits, e.g. a device-specific alert). A code must always be provided. Common alert codes include:

  • MDC_EVT_HI (196648): Value exceeds upper threshold
  • MDC_EVT_LO (196670): Value below lower threshold
  • MDC_EVT_SIG_OUT_OF_RANGE (197054): Value/signal outside acceptable range

Type (type): The type element specifies the type of condition that triggered the alert with a required binding. Supported types are physiological conditions (e.g., high blood pressure) and technical conditions (e.g., device malfunction).

Cause of Condition (derivedFrom): The profile requires one or more derivedFrom elements to reference the source measurement observation(s) that caused this alert condition. Each derivedFrom element contains:

  • observation (required): Reference to the source observation (PhdNumericObservation, PhdCompoundNumericObservation, PhdCompoundObservation, or PhdBitsEnumerationObservation)
  • component (optional): For compound observations, identifies which specific component triggered the alert (e.g., systolic vs. diastolic blood pressure)
  • limit (optional): The threshold range that was exceeded. Note: ACOM (IEEE 11073-10206 Alert Communication Model) does not report limit values; the Personal Health Gateway (PHG) populates this element from device configuration or locally maintained threshold settings.

This structure allows precise identification of which measurement observation caused the alert condition.

Alert Label (label)

An optional human-readable text that describes the alert condition, typically combining information about the measurement type, value, and threshold (e.g., "Systolic BP > 140 mm[Hg]" or "SpO2 < 80%").

Signal Information (signal)

The signal element and its annunciation state machine are used as defined by the base resource; this profile adds no constraints. The PHD examples annunciate using manifestation = auditory or visual.

Examples

See the following examples demonstrating this profile:

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceAlert 0..* DeviceAlert Documentation of an alert (a.k.a. alarm) generated by a device indicating a noteworthy condition
DeviceAlert.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DeviceAlert.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
DeviceAlert.contained 0..* Resource Contained, inline Resources
DeviceAlert.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
DeviceAlert.status This element is a modifier element. This element is included in summaries. 1..1 code in-progress | completed | entered-in-error | unknown
Binding: DeviceAlertStatusCodes (required): in-progress | completed | entered-in-error | unknown
DeviceAlert.category This element is included in summaries. 0..* CodeableConcept High-level category of the alert
Binding: Device Alert Category Value Set (extensible)
DeviceAlert.code This element is included in summaries. 1..1 CodeableConcept Code for the alert condition
Binding: Device Alert Condition Codes (MDC or ASN1ToHL7) (required)
DeviceAlert.subject This element is included in summaries. 1..1 Reference(Patient | Device | BiologicallyDerivedProduct | Group | Location | Medication | NutritionProduct | Specimen) Who or what the alert is about
DeviceAlert.occurrence This element is included in summaries. 1..1 Period When the alert condition occurred/is occurring
DeviceAlert.derivedFrom 1..* BackboneElement Reference to the observation(s) this alert is associated with
DeviceAlert.derivedFrom.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
DeviceAlert.derivedFrom.observation This element is included in summaries. 1..1 Reference(PhdNumericObservation | PhdCompoundNumericObservation | PhdCompoundObservation | PhdBitsEnumerationObservation) The Observation having a value causing the alert condition
DeviceAlert.label 0..1 string Threshold notification text
DeviceAlert.signal 0..* BackboneElement Annunciation or notification of the alert condition
DeviceAlert.signal.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
DeviceAlert.signal.activationState This element is included in summaries. 1..1 CodeableConcept Whether the signal is activated
Binding: DeviceAlert Activation State Codes (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
DeviceAlert.status Base required DeviceAlert Status Codes 📍6.0.0-snapshot1 FHIR Std.

in-progress | completed | entered-in-error | unknown

DeviceAlert.category Base extensible Device Alert Category Value Set 📦3.0.0-ballot This IG
DeviceAlert.code Base required Device Alert Condition Codes (MDC or ASN1ToHL7) 📦3.0.0-ballot This IG
DeviceAlert.signal.activationState Base extensible DeviceAlert Activation State Codes 📦3.0.0 THO v7.5

Constraints

Id Grade Path(s) Description Expression
dom-2 error DeviceAlert If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DeviceAlert If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DeviceAlert If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DeviceAlert If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DeviceAlert A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

This structure is derived from DeviceAlert

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceAlert 0..* DeviceAlert Documentation of an alert (a.k.a. alarm) generated by a device indicating a noteworthy condition
DeviceAlert.category 0..* CodeableConcept High-level category of the alert
Binding: Device Alert Category Value Set (extensible)
DeviceAlert.code 1..1 CodeableConcept Code for the alert condition
Binding: Device Alert Condition Codes (MDC or ASN1ToHL7) (required)
DeviceAlert.derivedFrom 1..* BackboneElement Reference to the observation(s) this alert is associated with
DeviceAlert.derivedFrom.observation 1..1 Reference(PhdNumericObservation | PhdCompoundNumericObservation | PhdCompoundObservation | PhdBitsEnumerationObservation) The Observation having a value causing the alert condition
DeviceAlert.signal 0..* BackboneElement Annunciation or notification of the alert condition

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DeviceAlert.category Base extensible Device Alert Category Value Set 📦3.0.0-ballot This IG
DeviceAlert.code Base required Device Alert Condition Codes (MDC or ASN1ToHL7) 📦3.0.0-ballot This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceAlert 0..* DeviceAlert Documentation of an alert (a.k.a. alarm) generated by a device indicating a noteworthy condition
DeviceAlert.id This element is included in summaries. 0..1 id Logical id of this artifact
DeviceAlert.meta This element is included in summaries. 0..1 Meta Metadata about the resource
DeviceAlert.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DeviceAlert.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
DeviceAlert.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
DeviceAlert.contained 0..* Resource Contained, inline Resources
DeviceAlert.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DeviceAlert.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
DeviceAlert.identifier This element is included in summaries. 0..* Identifier Business identifier for this device alert
DeviceAlert.procedure This element is included in summaries. 0..* Reference(Procedure) Procedure during which the alert occurred
DeviceAlert.status This element is a modifier element. This element is included in summaries. 1..1 code in-progress | completed | entered-in-error | unknown
Binding: DeviceAlertStatusCodes (required): in-progress | completed | entered-in-error | unknown
DeviceAlert.category This element is included in summaries. 0..* CodeableConcept High-level category of the alert
Binding: Device Alert Category Value Set (extensible)
DeviceAlert.type 0..1 CodeableConcept The particular kind of alert
Binding: DeviceAlert Type Codes (extensible)
DeviceAlert.priority This element is included in summaries. 0..1 CodeableConcept The urgency by which the condition ought to be addressed
Binding: DeviceAlertPriorityCodes (extensible)
DeviceAlert.code This element is included in summaries. 1..1 CodeableConcept Code for the alert condition
Binding: Device Alert Condition Codes (MDC or ASN1ToHL7) (required)
DeviceAlert.subject This element is included in summaries. 1..1 Reference(Patient | Device | BiologicallyDerivedProduct | Group | Location | Medication | NutritionProduct | Specimen) Who or what the alert is about
DeviceAlert.encounter This element is included in summaries. 0..1 Reference(Encounter) Encounter during which the alert condition occurred
DeviceAlert.occurrence This element is included in summaries. 1..1 Period When the alert condition occurred/is occurring
DeviceAlert.device This element is included in summaries. 0..1 Reference(Device | DeviceMetric) The Device (or DeviceMetric) that detected the alert condition
DeviceAlert.acknowledged 0..1 boolean Whether the alert condition has been acknowledged
DeviceAlert.acknowledgedBy 0..1 Reference(Patient | Device | Practitioner | PractitionerRole | RelatedPerson) Who acknowledged the alert condition
DeviceAlert.location This element is included in summaries. 0..1 Reference(Location) Location of the subject when the alert was raised
DeviceAlert.derivedFrom 1..* BackboneElement Reference to the observation(s) this alert is associated with
DeviceAlert.derivedFrom.id 0..1 string Unique id for inter-element referencing
DeviceAlert.derivedFrom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DeviceAlert.derivedFrom.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
DeviceAlert.derivedFrom.observation This element is included in summaries. 1..1 Reference(PhdNumericObservation | PhdCompoundNumericObservation | PhdCompoundObservation | PhdBitsEnumerationObservation) The Observation having a value causing the alert condition
DeviceAlert.derivedFrom.component 0..1 Coding The Observation.component having a value causing the alert condition
Binding: LOINCCodes (example): Codes identifying names of simple observations.
DeviceAlert.derivedFrom.limit 0..1 Range The boundaries beyond which a value was detected to cause the alert condition
DeviceAlert.label 0..1 string Threshold notification text
DeviceAlert.signal 0..* BackboneElement Annunciation or notification of the alert condition
DeviceAlert.signal.id 0..1 string Unique id for inter-element referencing
DeviceAlert.signal.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DeviceAlert.signal.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
DeviceAlert.signal.identifier 0..* Identifier Identifier for the logical signal instance
DeviceAlert.signal.activationState This element is included in summaries. 1..1 CodeableConcept Whether the signal is activated
Binding: DeviceAlert Activation State Codes (extensible)
DeviceAlert.signal.presence 0..1 CodeableConcept Indicates whether signal annunciation is occurring, along with the underlying reason
Binding: DeviceAlert Presence Codes (extensible)
DeviceAlert.signal.annunciator 0..1 CodeableReference(Device) Where the signal is being annunciated
Binding: DeviceAlertAnnunciationCodes (1.0.0) (required)
DeviceAlert.signal.manifestation 0..1 CodeableConcept How the signal is being annunciated
Binding: DeviceAlert Manifestation Codes (extensible)
DeviceAlert.signal.type 0..* CodeableConcept Characteristics of the signal manifestation
Binding: DeviceAlertSignalTypeCodes (example)
DeviceAlert.signal.period 0..1 Period The period when the signal was in the indicated state

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
DeviceAlert.language Base required All Languages 📍6.0.0-snapshot1 FHIR Std.

IETF language tag for a human language

DeviceAlert.status Base required DeviceAlert Status Codes 📍6.0.0-snapshot1 FHIR Std.

in-progress | completed | entered-in-error | unknown

DeviceAlert.category Base extensible Device Alert Category Value Set 📦3.0.0-ballot This IG
DeviceAlert.type Base extensible DeviceAlert Type Codes 📦1.0.0 THO v7.5
DeviceAlert.priority Base extensible DeviceAlert Priority Codes 📍6.0.0-snapshot1 FHIR Std.
DeviceAlert.code Base required Device Alert Condition Codes (MDC or ASN1ToHL7) 📦3.0.0-ballot This IG
DeviceAlert.derivedFrom.​component Base example LOINC Codes 📍6.0.0-snapshot1 FHIR Std.

Codes identifying names of simple observations.

DeviceAlert.signal.activationState Base extensible DeviceAlert Activation State Codes 📦3.0.0 THO v7.5
DeviceAlert.signal.presence Base extensible DeviceAlert Presence Codes 📦1.0.0 THO v7.5
DeviceAlert.signal.annunciator Base required DeviceAlert Annunciation Codes 📍1.0.0 THO v7.5
DeviceAlert.signal.manifestation Base extensible DeviceAlert Manifestation Codes 📦1.0.0 THO v7.5
DeviceAlert.signal.type Base example DeviceAlert Signal Type Codes 📍6.0.0-snapshot1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DeviceAlert If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DeviceAlert If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DeviceAlert If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DeviceAlert If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DeviceAlert A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceAlert 0..* DeviceAlert Documentation of an alert (a.k.a. alarm) generated by a device indicating a noteworthy condition
DeviceAlert.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DeviceAlert.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
DeviceAlert.contained 0..* Resource Contained, inline Resources
DeviceAlert.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
DeviceAlert.status This element is a modifier element. This element is included in summaries. 1..1 code in-progress | completed | entered-in-error | unknown
Binding: DeviceAlertStatusCodes (required): in-progress | completed | entered-in-error | unknown
DeviceAlert.category This element is included in summaries. 0..* CodeableConcept High-level category of the alert
Binding: Device Alert Category Value Set (extensible)
DeviceAlert.code This element is included in summaries. 1..1 CodeableConcept Code for the alert condition
Binding: Device Alert Condition Codes (MDC or ASN1ToHL7) (required)
DeviceAlert.subject This element is included in summaries. 1..1 Reference(Patient | Device | BiologicallyDerivedProduct | Group | Location | Medication | NutritionProduct | Specimen) Who or what the alert is about
DeviceAlert.occurrence This element is included in summaries. 1..1 Period When the alert condition occurred/is occurring
DeviceAlert.derivedFrom 1..* BackboneElement Reference to the observation(s) this alert is associated with
DeviceAlert.derivedFrom.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
DeviceAlert.derivedFrom.observation This element is included in summaries. 1..1 Reference(PhdNumericObservation | PhdCompoundNumericObservation | PhdCompoundObservation | PhdBitsEnumerationObservation) The Observation having a value causing the alert condition
DeviceAlert.label 0..1 string Threshold notification text
DeviceAlert.signal 0..* BackboneElement Annunciation or notification of the alert condition
DeviceAlert.signal.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
DeviceAlert.signal.activationState This element is included in summaries. 1..1 CodeableConcept Whether the signal is activated
Binding: DeviceAlert Activation State Codes (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
DeviceAlert.status Base required DeviceAlert Status Codes 📍6.0.0-snapshot1 FHIR Std.

in-progress | completed | entered-in-error | unknown

DeviceAlert.category Base extensible Device Alert Category Value Set 📦3.0.0-ballot This IG
DeviceAlert.code Base required Device Alert Condition Codes (MDC or ASN1ToHL7) 📦3.0.0-ballot This IG
DeviceAlert.signal.activationState Base extensible DeviceAlert Activation State Codes 📦3.0.0 THO v7.5

Constraints

Id Grade Path(s) Description Expression
dom-2 error DeviceAlert If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DeviceAlert If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DeviceAlert If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DeviceAlert If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DeviceAlert A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

Differential View

This structure is derived from DeviceAlert

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceAlert 0..* DeviceAlert Documentation of an alert (a.k.a. alarm) generated by a device indicating a noteworthy condition
DeviceAlert.category 0..* CodeableConcept High-level category of the alert
Binding: Device Alert Category Value Set (extensible)
DeviceAlert.code 1..1 CodeableConcept Code for the alert condition
Binding: Device Alert Condition Codes (MDC or ASN1ToHL7) (required)
DeviceAlert.derivedFrom 1..* BackboneElement Reference to the observation(s) this alert is associated with
DeviceAlert.derivedFrom.observation 1..1 Reference(PhdNumericObservation | PhdCompoundNumericObservation | PhdCompoundObservation | PhdBitsEnumerationObservation) The Observation having a value causing the alert condition
DeviceAlert.label 0..1 string Threshold notification text
DeviceAlert.signal 0..* BackboneElement Annunciation or notification of the alert condition

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DeviceAlert.category Base extensible Device Alert Category Value Set 📦3.0.0-ballot This IG
DeviceAlert.code Base required Device Alert Condition Codes (MDC or ASN1ToHL7) 📦3.0.0-ballot This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceAlert 0..* DeviceAlert Documentation of an alert (a.k.a. alarm) generated by a device indicating a noteworthy condition
DeviceAlert.id This element is included in summaries. 0..1 id Logical id of this artifact
DeviceAlert.meta This element is included in summaries. 0..1 Meta Metadata about the resource
DeviceAlert.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DeviceAlert.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
DeviceAlert.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
DeviceAlert.contained 0..* Resource Contained, inline Resources
DeviceAlert.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DeviceAlert.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
DeviceAlert.identifier This element is included in summaries. 0..* Identifier Business identifier for this device alert
DeviceAlert.procedure This element is included in summaries. 0..* Reference(Procedure) Procedure during which the alert occurred
DeviceAlert.status This element is a modifier element. This element is included in summaries. 1..1 code in-progress | completed | entered-in-error | unknown
Binding: DeviceAlertStatusCodes (required): in-progress | completed | entered-in-error | unknown
DeviceAlert.category This element is included in summaries. 0..* CodeableConcept High-level category of the alert
Binding: Device Alert Category Value Set (extensible)
DeviceAlert.type 0..1 CodeableConcept The particular kind of alert
Binding: DeviceAlert Type Codes (extensible)
DeviceAlert.priority This element is included in summaries. 0..1 CodeableConcept The urgency by which the condition ought to be addressed
Binding: DeviceAlertPriorityCodes (extensible)
DeviceAlert.code This element is included in summaries. 1..1 CodeableConcept Code for the alert condition
Binding: Device Alert Condition Codes (MDC or ASN1ToHL7) (required)
DeviceAlert.subject This element is included in summaries. 1..1 Reference(Patient | Device | BiologicallyDerivedProduct | Group | Location | Medication | NutritionProduct | Specimen) Who or what the alert is about
DeviceAlert.encounter This element is included in summaries. 0..1 Reference(Encounter) Encounter during which the alert condition occurred
DeviceAlert.occurrence This element is included in summaries. 1..1 Period When the alert condition occurred/is occurring
DeviceAlert.device This element is included in summaries. 0..1 Reference(Device | DeviceMetric) The Device (or DeviceMetric) that detected the alert condition
DeviceAlert.acknowledged 0..1 boolean Whether the alert condition has been acknowledged
DeviceAlert.acknowledgedBy 0..1 Reference(Patient | Device | Practitioner | PractitionerRole | RelatedPerson) Who acknowledged the alert condition
DeviceAlert.location This element is included in summaries. 0..1 Reference(Location) Location of the subject when the alert was raised
DeviceAlert.derivedFrom 1..* BackboneElement Reference to the observation(s) this alert is associated with
DeviceAlert.derivedFrom.id 0..1 string Unique id for inter-element referencing
DeviceAlert.derivedFrom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DeviceAlert.derivedFrom.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
DeviceAlert.derivedFrom.observation This element is included in summaries. 1..1 Reference(PhdNumericObservation | PhdCompoundNumericObservation | PhdCompoundObservation | PhdBitsEnumerationObservation) The Observation having a value causing the alert condition
DeviceAlert.derivedFrom.component 0..1 Coding The Observation.component having a value causing the alert condition
Binding: LOINCCodes (example): Codes identifying names of simple observations.
DeviceAlert.derivedFrom.limit 0..1 Range The boundaries beyond which a value was detected to cause the alert condition
DeviceAlert.label 0..1 string Threshold notification text
DeviceAlert.signal 0..* BackboneElement Annunciation or notification of the alert condition
DeviceAlert.signal.id 0..1 string Unique id for inter-element referencing
DeviceAlert.signal.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DeviceAlert.signal.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Slice: Unordered, Open by value:url
DeviceAlert.signal.identifier 0..* Identifier Identifier for the logical signal instance
DeviceAlert.signal.activationState This element is included in summaries. 1..1 CodeableConcept Whether the signal is activated
Binding: DeviceAlert Activation State Codes (extensible)
DeviceAlert.signal.presence 0..1 CodeableConcept Indicates whether signal annunciation is occurring, along with the underlying reason
Binding: DeviceAlert Presence Codes (extensible)
DeviceAlert.signal.annunciator 0..1 CodeableReference(Device) Where the signal is being annunciated
Binding: DeviceAlertAnnunciationCodes (1.0.0) (required)
DeviceAlert.signal.manifestation 0..1 CodeableConcept How the signal is being annunciated
Binding: DeviceAlert Manifestation Codes (extensible)
DeviceAlert.signal.type 0..* CodeableConcept Characteristics of the signal manifestation
Binding: DeviceAlertSignalTypeCodes (example)
DeviceAlert.signal.period 0..1 Period The period when the signal was in the indicated state

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
DeviceAlert.language Base required All Languages 📍6.0.0-snapshot1 FHIR Std.

IETF language tag for a human language

DeviceAlert.status Base required DeviceAlert Status Codes 📍6.0.0-snapshot1 FHIR Std.

in-progress | completed | entered-in-error | unknown

DeviceAlert.category Base extensible Device Alert Category Value Set 📦3.0.0-ballot This IG
DeviceAlert.type Base extensible DeviceAlert Type Codes 📦1.0.0 THO v7.5
DeviceAlert.priority Base extensible DeviceAlert Priority Codes 📍6.0.0-snapshot1 FHIR Std.
DeviceAlert.code Base required Device Alert Condition Codes (MDC or ASN1ToHL7) 📦3.0.0-ballot This IG
DeviceAlert.derivedFrom.​component Base example LOINC Codes 📍6.0.0-snapshot1 FHIR Std.

Codes identifying names of simple observations.

DeviceAlert.signal.activationState Base extensible DeviceAlert Activation State Codes 📦3.0.0 THO v7.5
DeviceAlert.signal.presence Base extensible DeviceAlert Presence Codes 📦1.0.0 THO v7.5
DeviceAlert.signal.annunciator Base required DeviceAlert Annunciation Codes 📍1.0.0 THO v7.5
DeviceAlert.signal.manifestation Base extensible DeviceAlert Manifestation Codes 📦1.0.0 THO v7.5
DeviceAlert.signal.type Base example DeviceAlert Signal Type Codes 📍6.0.0-snapshot1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DeviceAlert If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DeviceAlert If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DeviceAlert If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DeviceAlert If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DeviceAlert A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Implementation Notes

The base DeviceAlert resource defines the general element semantics, the condition/signal state machine, and the search parameters. These notes cover only PHD-specific behavior.

derivedFrom in this IG

  • derivedFrom.observation is restricted to a PhdNumericObservation, PhdCompoundNumericObservation, PhdCompoundObservation, or PhdBitsEnumerationObservation. For a bits observation the triggering status bit is the component carrying an ASN1ToHL7 code.
  • derivedFrom.component is a Coding matching one of the referenced Observation.component.code values — an MDC code for a compound numeric component (e.g. systolic BP), or an ASN1ToHL7 code for a status bit. Omit it when the alert applies to the whole observation.
  • derivedFrom.limit is populated by the PHG (from device configuration or patient-specific settings), because ACOM does not transmit limit values.

Alert generation pathways

PHG implementers that generate device alerts SHOULD follow the two alert-generation pathways — threshold/limit alerts on numeric observations and device/sensor status-bit alerts — described in the PhdDeviceAlert profile.§24

  • Limit (threshold) alerts — the PHG compares a numeric measurement against the applicable limits and, when the value is out of range, creates an alert with an MDC MDC_EVT_HI/MDC_EVT_LO condition code and a derivedFrom.limit. Limits may be device-reported or patient-specific values the PHG holds for the subject; because ACOM does not transmit limits, the PHG is the source of the limit range. For compound observations, derivedFrom.component identifies which component (e.g. systolic BP) breached its limit.
  • Status-bit alerts — the PHG inspects the device/sensor status bits reported on a PhdBitsEnumerationObservation. When a bit denotes an alert condition (e.g. sensor-displaced, device-battery-low, device-specific-alert), the PHG creates a type = technical alert whose code is the ASN1ToHL7 bit code and whose derivedFrom.component points at that bit. No limit applies.

Alert state and timing

The relationship between occurrence (condition timing), signal.presence/signal.activationState (annunciation), and status (resource workflow) follows the base resource state machine; see the DeviceAlert resource. For PHD, occurrence.start is typically close to the source observation's effectiveDateTime, and a source numeric observation in alarm carries interpretation = in-alarm.

Querying

The standard DeviceAlert search parameters apply. A PHD-specific use is searching by condition code, e.g. GET /DeviceAlert?code=urn:iso:std:iso:11073:10101|196648 (high range alerts), or by an ASN1ToHL7 status code.

Compatibility Considerations

For systems transitioning from the earlier SimpleAlerting extension approach:

  1. Migration Path: Existing observations with SimpleAlerting extensions can be transformed into separate DeviceAlert resources
  2. Backward Compatibility: Both approaches can coexist during transition periods
  3. Data Mapping:
    • Extension currentLimits → DeviceAlert derivedFrom.limit
    • Extension alertOperationalState → DeviceAlert signal.activationState and signal.type
    • Extension thresholdNotificationText → DeviceAlert label
    • Observation interpretation (in-alarm) → DeviceAlert signal.presence=on
  4. ASN.1 status bits: Measurement-embedded alert bits from the ASN1ToHL7 code system map as follows:
    • lim-alert-off, lim-low-off, lim-high-off (limit alerting disabled) → no DeviceAlert is generated while disabled; an existing DeviceAlert for that limit has signal.activationState = off.
    • device-specific-alert (a device-specific alert condition is present) → generate a DeviceAlert with the appropriate partition-3 condition code and a derivedFrom reference to the source observation.

Best Practices

  1. Always provide derivedFrom: Link alerts to their source observations for traceability
  2. Use component for compound observations: Be specific about which component triggered the alert
  3. Include limit ranges when available: Helps understand device configuration and alert logic
  4. Provide meaningful labels: Make alerts human-readable for clinicians
  5. Set appropriate categories: Enable proper filtering and access control
  6. Include device references: Track which device generated the alert
  7. Use standard MDC codes: Ensure interoperability with IEEE 11073 ecosystem
  8. Update status appropriately: Mark alerts as completed when conditions resolve

Limitations

  1. Single component per derivedFrom: If multiple components of the same observation trigger alerts, create separate derivedFrom entries or separate DeviceAlert resources
  2. Limit precision: The limit element is a Range with Quantity values, which may not capture all complexity of alert logic (e.g., rate-of-change alerts, multi-condition alerts)
  3. Signal details: The signal element may not capture all aspects of complex multi-sensory alerting systems
  4. Historical limits: No built-in mechanism to track changes in limit settings over time