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
| 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.
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.
A PhdDeviceAlert can arise from two distinct sources in the PHD data flow:
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 = physiologicalcode 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 PhdCompoundObservationderivedFrom.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 settingsThe source numeric observation also carries interpretation = in-alarm to mark that it is in an
alarm state. See the Blood Pressure and
SpO2 examples.
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 = technicalcode is the ASN1ToHL7 status code directly (no MDC "umbrella" code is required)derivedFrom.observation references the PhdBitsEnumerationObservationderivedFrom.component points at the exact ASN1ToHL7 bit that triggered the alertlimit is present, because no threshold was crossedSee the Sensor-Displaced Alert example.
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:
By representing alerts as separate DeviceAlert resources (rather than embedding them within measurement observations), the profile enables:
Device alerts enable important clinical use cases:
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.
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:
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:
This structure allows precise identification of which measurement observation caused the alert condition.
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)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.
See the following examples demonstrating this profile:
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | DeviceAlert | Documentation of an alert (a.k.a. alarm) generated by a device indicating a noteworthy condition | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
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 | |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | |
![]() ![]() |
1..1 | code | in-progress | completed | entered-in-error | unknown Binding: DeviceAlertStatusCodes (required): in-progress | completed | entered-in-error | unknown | |
![]() ![]() |
0..* | CodeableConcept | High-level category of the alert Binding: Device Alert Category Value Set (extensible) | |
![]() ![]() |
1..1 | CodeableConcept | Code for the alert condition Binding: Device Alert Condition Codes (MDC or ASN1ToHL7) (required) | |
![]() ![]() |
1..1 | Reference(Patient | Device | BiologicallyDerivedProduct | Group | Location | Medication | NutritionProduct | Specimen) | Who or what the alert is about | |
![]() ![]() |
1..1 | Period | When the alert condition occurred/is occurring | |
![]() ![]() |
1..* | BackboneElement | Reference to the observation(s) this alert is associated with | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | Reference(PhdNumericObservation | PhdCompoundNumericObservation | PhdCompoundObservation | PhdBitsEnumerationObservation) | The Observation having a value causing the alert condition | |
![]() ![]() |
0..1 | string | Threshold notification text | |
![]() ![]() |
0..* | BackboneElement | Annunciation or notification of the alert condition | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Whether the signal is activated Binding: DeviceAlert Activation State Codes (extensible) | |
Documentation for this format | ||||
| 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 |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | DeviceAlert | Documentation of an alert (a.k.a. alarm) generated by a device indicating a noteworthy condition | |
![]() ![]() |
0..* | CodeableConcept | High-level category of the alert Binding: Device Alert Category Value Set (extensible) | |
![]() ![]() |
1..1 | CodeableConcept | Code for the alert condition Binding: Device Alert Condition Codes (MDC or ASN1ToHL7) (required) | |
![]() ![]() |
1..* | BackboneElement | Reference to the observation(s) this alert is associated with | |
![]() ![]() ![]() |
1..1 | Reference(PhdNumericObservation | PhdCompoundNumericObservation | PhdCompoundObservation | PhdBitsEnumerationObservation) | The Observation having a value causing the alert condition | |
![]() ![]() |
0..1 | string | Threshold notification text | |
![]() ![]() |
0..* | BackboneElement | Annunciation or notification of the alert condition | |
Documentation for this format | ||||
| 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 |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DeviceAlert | Documentation of an alert (a.k.a. alarm) generated by a device indicating a noteworthy condition | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | |||||
![]() ![]() |
0..* | Identifier | Business identifier for this device alert | |||||
![]() ![]() |
0..* | Reference(Procedure) | Procedure during which the alert occurred | |||||
![]() ![]() |
1..1 | code | in-progress | completed | entered-in-error | unknown Binding: DeviceAlertStatusCodes (required): in-progress | completed | entered-in-error | unknown | |||||
![]() ![]() |
0..* | CodeableConcept | High-level category of the alert Binding: Device Alert Category Value Set (extensible) | |||||
![]() ![]() |
0..1 | CodeableConcept | The particular kind of alert Binding: DeviceAlert Type Codes (extensible) | |||||
![]() ![]() |
0..1 | CodeableConcept | The urgency by which the condition ought to be addressed Binding: DeviceAlertPriorityCodes (extensible) | |||||
![]() ![]() |
1..1 | CodeableConcept | Code for the alert condition Binding: Device Alert Condition Codes (MDC or ASN1ToHL7) (required) | |||||
![]() ![]() |
1..1 | Reference(Patient | Device | BiologicallyDerivedProduct | Group | Location | Medication | NutritionProduct | Specimen) | Who or what the alert is about | |||||
![]() ![]() |
0..1 | Reference(Encounter) | Encounter during which the alert condition occurred | |||||
![]() ![]() |
1..1 | Period | When the alert condition occurred/is occurring | |||||
![]() ![]() |
0..1 | Reference(Device | DeviceMetric) | The Device (or DeviceMetric) that detected the alert condition | |||||
![]() ![]() |
0..1 | boolean | Whether the alert condition has been acknowledged | |||||
![]() ![]() |
0..1 | Reference(Patient | Device | Practitioner | PractitionerRole | RelatedPerson) | Who acknowledged the alert condition | |||||
![]() ![]() |
0..1 | Reference(Location) | Location of the subject when the alert was raised | |||||
![]() ![]() |
1..* | BackboneElement | Reference to the observation(s) this alert is associated with | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
1..1 | Reference(PhdNumericObservation | PhdCompoundNumericObservation | PhdCompoundObservation | PhdBitsEnumerationObservation) | The Observation having a value causing the alert condition | |||||
![]() ![]() ![]() |
0..1 | Coding | The Observation.component having a value causing the alert condition Binding: LOINCCodes (example): Codes identifying names of simple observations. | |||||
![]() ![]() ![]() |
0..1 | Range | The boundaries beyond which a value was detected to cause the alert condition | |||||
![]() ![]() |
0..1 | string | Threshold notification text | |||||
![]() ![]() |
0..* | BackboneElement | Annunciation or notification of the alert condition | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | Identifier | Identifier for the logical signal instance | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Whether the signal is activated Binding: DeviceAlert Activation State Codes (extensible) | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Indicates whether signal annunciation is occurring, along with the underlying reason Binding: DeviceAlert Presence Codes (extensible) | |||||
![]() ![]() ![]() |
0..1 | CodeableReference(Device) | Where the signal is being annunciated Binding: DeviceAlertAnnunciationCodes (1.0.0) (required) | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | How the signal is being annunciated Binding: DeviceAlert Manifestation Codes (extensible) | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Characteristics of the signal manifestation Binding: DeviceAlertSignalTypeCodes (example) | |||||
![]() ![]() ![]() |
0..1 | Period | The period when the signal was in the indicated state | |||||
Documentation for this format | ||||||||
| 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. |
| 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
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | DeviceAlert | Documentation of an alert (a.k.a. alarm) generated by a device indicating a noteworthy condition | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
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 | |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | |
![]() ![]() |
1..1 | code | in-progress | completed | entered-in-error | unknown Binding: DeviceAlertStatusCodes (required): in-progress | completed | entered-in-error | unknown | |
![]() ![]() |
0..* | CodeableConcept | High-level category of the alert Binding: Device Alert Category Value Set (extensible) | |
![]() ![]() |
1..1 | CodeableConcept | Code for the alert condition Binding: Device Alert Condition Codes (MDC or ASN1ToHL7) (required) | |
![]() ![]() |
1..1 | Reference(Patient | Device | BiologicallyDerivedProduct | Group | Location | Medication | NutritionProduct | Specimen) | Who or what the alert is about | |
![]() ![]() |
1..1 | Period | When the alert condition occurred/is occurring | |
![]() ![]() |
1..* | BackboneElement | Reference to the observation(s) this alert is associated with | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | Reference(PhdNumericObservation | PhdCompoundNumericObservation | PhdCompoundObservation | PhdBitsEnumerationObservation) | The Observation having a value causing the alert condition | |
![]() ![]() |
0..1 | string | Threshold notification text | |
![]() ![]() |
0..* | BackboneElement | Annunciation or notification of the alert condition | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Whether the signal is activated Binding: DeviceAlert Activation State Codes (extensible) | |
Documentation for this format | ||||
| 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 |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | DeviceAlert | Documentation of an alert (a.k.a. alarm) generated by a device indicating a noteworthy condition | |
![]() ![]() |
0..* | CodeableConcept | High-level category of the alert Binding: Device Alert Category Value Set (extensible) | |
![]() ![]() |
1..1 | CodeableConcept | Code for the alert condition Binding: Device Alert Condition Codes (MDC or ASN1ToHL7) (required) | |
![]() ![]() |
1..* | BackboneElement | Reference to the observation(s) this alert is associated with | |
![]() ![]() ![]() |
1..1 | Reference(PhdNumericObservation | PhdCompoundNumericObservation | PhdCompoundObservation | PhdBitsEnumerationObservation) | The Observation having a value causing the alert condition | |
![]() ![]() |
0..1 | string | Threshold notification text | |
![]() ![]() |
0..* | BackboneElement | Annunciation or notification of the alert condition | |
Documentation for this format | ||||
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DeviceAlert | Documentation of an alert (a.k.a. alarm) generated by a device indicating a noteworthy condition | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | |||||
![]() ![]() |
0..* | Identifier | Business identifier for this device alert | |||||
![]() ![]() |
0..* | Reference(Procedure) | Procedure during which the alert occurred | |||||
![]() ![]() |
1..1 | code | in-progress | completed | entered-in-error | unknown Binding: DeviceAlertStatusCodes (required): in-progress | completed | entered-in-error | unknown | |||||
![]() ![]() |
0..* | CodeableConcept | High-level category of the alert Binding: Device Alert Category Value Set (extensible) | |||||
![]() ![]() |
0..1 | CodeableConcept | The particular kind of alert Binding: DeviceAlert Type Codes (extensible) | |||||
![]() ![]() |
0..1 | CodeableConcept | The urgency by which the condition ought to be addressed Binding: DeviceAlertPriorityCodes (extensible) | |||||
![]() ![]() |
1..1 | CodeableConcept | Code for the alert condition Binding: Device Alert Condition Codes (MDC or ASN1ToHL7) (required) | |||||
![]() ![]() |
1..1 | Reference(Patient | Device | BiologicallyDerivedProduct | Group | Location | Medication | NutritionProduct | Specimen) | Who or what the alert is about | |||||
![]() ![]() |
0..1 | Reference(Encounter) | Encounter during which the alert condition occurred | |||||
![]() ![]() |
1..1 | Period | When the alert condition occurred/is occurring | |||||
![]() ![]() |
0..1 | Reference(Device | DeviceMetric) | The Device (or DeviceMetric) that detected the alert condition | |||||
![]() ![]() |
0..1 | boolean | Whether the alert condition has been acknowledged | |||||
![]() ![]() |
0..1 | Reference(Patient | Device | Practitioner | PractitionerRole | RelatedPerson) | Who acknowledged the alert condition | |||||
![]() ![]() |
0..1 | Reference(Location) | Location of the subject when the alert was raised | |||||
![]() ![]() |
1..* | BackboneElement | Reference to the observation(s) this alert is associated with | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
1..1 | Reference(PhdNumericObservation | PhdCompoundNumericObservation | PhdCompoundObservation | PhdBitsEnumerationObservation) | The Observation having a value causing the alert condition | |||||
![]() ![]() ![]() |
0..1 | Coding | The Observation.component having a value causing the alert condition Binding: LOINCCodes (example): Codes identifying names of simple observations. | |||||
![]() ![]() ![]() |
0..1 | Range | The boundaries beyond which a value was detected to cause the alert condition | |||||
![]() ![]() |
0..1 | string | Threshold notification text | |||||
![]() ![]() |
0..* | BackboneElement | Annunciation or notification of the alert condition | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | Identifier | Identifier for the logical signal instance | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Whether the signal is activated Binding: DeviceAlert Activation State Codes (extensible) | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Indicates whether signal annunciation is occurring, along with the underlying reason Binding: DeviceAlert Presence Codes (extensible) | |||||
![]() ![]() ![]() |
0..1 | CodeableReference(Device) | Where the signal is being annunciated Binding: DeviceAlertAnnunciationCodes (1.0.0) (required) | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | How the signal is being annunciated Binding: DeviceAlert Manifestation Codes (extensible) | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Characteristics of the signal manifestation Binding: DeviceAlertSignalTypeCodes (example) | |||||
![]() ![]() ![]() |
0..1 | Period | The period when the signal was in the indicated state | |||||
Documentation for this format | ||||||||
| 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. |
| 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
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
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.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.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
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.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.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.
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.
For systems transitioning from the earlier SimpleAlerting extension approach:
currentLimits → DeviceAlert derivedFrom.limitalertOperationalState → DeviceAlert signal.activationState and signal.typethresholdNotificationText → DeviceAlert labelinterpretation (in-alarm) → DeviceAlert signal.presence=onlim-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.