FHIR Extensions Pack
5.3.0-ballot-tc1 - (September 2025 Ballot) International flag

This page is part of the FHIR Core Extensions Registry (v5.3.0-ballot-tc1: Release 5.3) based on FHIR (HL7® FHIR® Standard) v5.0.0. This version is a pre-release. The current official version is 5.2.0. For a full list of available versions, see the Directory of published versions

Extension: Device Alert Detection Extension

Official URL: http://hl7.org/fhir/StructureDefinition/device-alertDetection Version: 5.3.0-ballot-tc1
Standards status: Draft Maturity Level: 1 Responsible: HL7 International / Health Care Devices Computable Name: DeviceAlertDetection

Alert detection activation state describes whether a device is set to annunciate when a DeviceAlert condition occurs. This extension describes the reported alert detection activation state for the indicated combination of alert code and priority at the indicated point in time. The extension may be used on a Device, or on the specific DeviceMetric that could detect the condition or annunciate the alert.

This is an draft extension definition; the committee is seeking implementation feedback, and the definition or contents of the extension may change in future versions

Context of Use

This extension may be used on the following element(s)

Multiple repetitions of this extension may be applied to the target Device or DeviceMetric, each describing the activation state of different alerts (and priorities).

This extension is used to report—not set—alert detection activation state.

If more than one occurrence of this extension could describe the same alert and priority combination, the more specific occurrence should apply. For example, if this extension is used twice on a Device, once without an alertCode value, and once with; then, the activation state described in the occurrence with an alertCode applies to that alert, while the activation state of the occurrence without a code applies to other alerts. Broadly, “more specific” means:

  • A specific alert code, over an absent alert code (which implies “all alerts”);
  • A specific priority, over an absent priority (which implies “all priorities”);
  • A current effective date, over a historical or absent effective date;
  • An occurrence of this extension on a DeviceMetric instance, over an occurrence on mid-level Device, over an occurrence on a top-level Device.

Notes:

  • There is potential for contradictory interpretation of “more specific” (such as whether an “all priorities” activation state specified at the DeviceMetric level is more specific than a particular priority activation state specified at the Device level); feedback is requested on whether additional guidance is needed when multiple occurrences could apply.
  • Due to potential for confusion, “duplicate” extensions, e.g. having the same alert code and priority, should be avoided.

Usage info

Usages:

  • This Extension is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Changes since version 5.2.0:

  • New Content

    • Formal Views of Extension Content

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

    This structure is derived from Extension

    Summary

    Complex Extension: Alert detection activation state describes whether a device is set to annunciate when a DeviceAlert condition occurs. This extension describes the reported alert detection activation state for the indicated combination of alert code and priority at the indicated point in time. The extension may be used on a Device, or on the specific DeviceMetric that could detect the condition or annunciate the alert.

    • alertCode: CodeableConcept: The alert for which the alert detection activation state is described. If an alert code is specified, then the activation state is for the specified alert. If no alert code is specified, the alert detection activation state applies to all alerts of the device. (See the extension description for additional details regarding multiple occurrences of this extension.)
    • priority: code: The alert priority for which the alert detection activation state is described. If an alert priority is specified, then the activation state is for the indicated priority of the specified alert. If no alert priority is specified, the alert detection activation state applies to all priorities of the specified alert. (See the extension description for additional details regarding multiple occurrences of this extension.)
    • effective: dateTime, instant, Period: When this activation state was in effect, which may be a statement about a single point-in-time or a time period (possibly on-going) covered.
    • activationState: code: The reported activation state of the specified combination of alert and priority
    • limitRange: Range: The range of values outside of which an alarm condition of the (single) specified priority would be triggered for the specified alert code, if the alert activation state were active. Limits may include upper or lower values, or both. If units are present, they should be the same as the DeviceMetric. If absent, units are assumed to be the same as the DeviceMetric.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension C 0..* Extension Device Alert Detection Extension
    Constraints: alrtdet-1
    ... extension 1..* Extension Extension
    ... Slices for extension Content/Rules for all slices
    .... extension:alertCode 0..1 Extension The alert for which the alert detection activation state is described
    ..... extension 0..0
    ..... url 1..1 uri "alertCode"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: DeviceAlertConditionCodes (preferred)
    .... extension:priority 0..1 Extension The alert priority for which the alert detection activation state is described
    ..... extension 0..0
    ..... url 1..1 uri "priority"
    ..... value[x] 1..1 code Value of extension
    Binding: DeviceAlertPriorityCodes (required)
    .... extension:effective 0..1 Extension The point(s) in time this activation state was in effect
    ..... extension 0..0
    ..... url 1..1 uri "effective"
    ..... value[x] 1..1 Value of extension
    ...... valueDateTime dateTime
    ...... valueInstant instant
    ...... valuePeriod Period
    .... extension:activationState 1..1 Extension The activation state of the specified alert (or alerts)
    ..... extension 0..0
    ..... url 1..1 uri "activationState"
    ..... value[x] 1..1 code Value of extension
    Binding: DeviceAlertActivationStateCodes (required)
    .... extension:limitRange 0..1 Extension Limits applicable to the indicated alert priority.
    ..... extension 0..0
    ..... url 1..1 uri "limitRange"
    ..... value[x] 1..1 Range Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/device-alertDetection"

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension C 0..* Extension Device Alert Detection Extension
    Constraints: alrtdet-1
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:alertCode 0..1 Extension The alert for which the alert detection activation state is described
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "alertCode"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: DeviceAlertConditionCodes (preferred)
    .... extension:priority 0..1 Extension The alert priority for which the alert detection activation state is described
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "priority"
    ..... value[x] 1..1 code Value of extension
    Binding: DeviceAlertPriorityCodes (required)
    .... extension:effective 0..1 Extension The point(s) in time this activation state was in effect
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "effective"
    ..... value[x] 1..1 Value of extension
    ...... valueDateTime dateTime
    ...... valueInstant instant
    ...... valuePeriod Period
    .... extension:activationState 1..1 Extension The activation state of the specified alert (or alerts)
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "activationState"
    ..... value[x] 1..1 code Value of extension
    Binding: DeviceAlertActivationStateCodes (required)
    .... extension:limitRange 0..1 Extension Limits applicable to the indicated alert priority.
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "limitRange"
    ..... value[x] 1..1 Range Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/device-alertDetection"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: Alert detection activation state describes whether a device is set to annunciate when a DeviceAlert condition occurs. This extension describes the reported alert detection activation state for the indicated combination of alert code and priority at the indicated point in time. The extension may be used on a Device, or on the specific DeviceMetric that could detect the condition or annunciate the alert.

    • alertCode: CodeableConcept: The alert for which the alert detection activation state is described. If an alert code is specified, then the activation state is for the specified alert. If no alert code is specified, the alert detection activation state applies to all alerts of the device. (See the extension description for additional details regarding multiple occurrences of this extension.)
    • priority: code: The alert priority for which the alert detection activation state is described. If an alert priority is specified, then the activation state is for the indicated priority of the specified alert. If no alert priority is specified, the alert detection activation state applies to all priorities of the specified alert. (See the extension description for additional details regarding multiple occurrences of this extension.)
    • effective: dateTime, instant, Period: When this activation state was in effect, which may be a statement about a single point-in-time or a time period (possibly on-going) covered.
    • activationState: code: The reported activation state of the specified combination of alert and priority
    • limitRange: Range: The range of values outside of which an alarm condition of the (single) specified priority would be triggered for the specified alert code, if the alert activation state were active. Limits may include upper or lower values, or both. If units are present, they should be the same as the DeviceMetric. If absent, units are assumed to be the same as the DeviceMetric.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension C 0..* Extension Device Alert Detection Extension
    Constraints: alrtdet-1
    ... extension 1..* Extension Extension
    ... Slices for extension Content/Rules for all slices
    .... extension:alertCode 0..1 Extension The alert for which the alert detection activation state is described
    ..... extension 0..0
    ..... url 1..1 uri "alertCode"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: DeviceAlertConditionCodes (preferred)
    .... extension:priority 0..1 Extension The alert priority for which the alert detection activation state is described
    ..... extension 0..0
    ..... url 1..1 uri "priority"
    ..... value[x] 1..1 code Value of extension
    Binding: DeviceAlertPriorityCodes (required)
    .... extension:effective 0..1 Extension The point(s) in time this activation state was in effect
    ..... extension 0..0
    ..... url 1..1 uri "effective"
    ..... value[x] 1..1 Value of extension
    ...... valueDateTime dateTime
    ...... valueInstant instant
    ...... valuePeriod Period
    .... extension:activationState 1..1 Extension The activation state of the specified alert (or alerts)
    ..... extension 0..0
    ..... url 1..1 uri "activationState"
    ..... value[x] 1..1 code Value of extension
    Binding: DeviceAlertActivationStateCodes (required)
    .... extension:limitRange 0..1 Extension Limits applicable to the indicated alert priority.
    ..... extension 0..0
    ..... url 1..1 uri "limitRange"
    ..... value[x] 1..1 Range Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/device-alertDetection"

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension C 0..* Extension Device Alert Detection Extension
    Constraints: alrtdet-1
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:alertCode 0..1 Extension The alert for which the alert detection activation state is described
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "alertCode"
    ..... value[x] 1..1 CodeableConcept Value of extension
    Binding: DeviceAlertConditionCodes (preferred)
    .... extension:priority 0..1 Extension The alert priority for which the alert detection activation state is described
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "priority"
    ..... value[x] 1..1 code Value of extension
    Binding: DeviceAlertPriorityCodes (required)
    .... extension:effective 0..1 Extension The point(s) in time this activation state was in effect
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "effective"
    ..... value[x] 1..1 Value of extension
    ...... valueDateTime dateTime
    ...... valueInstant instant
    ...... valuePeriod Period
    .... extension:activationState 1..1 Extension The activation state of the specified alert (or alerts)
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "activationState"
    ..... value[x] 1..1 code Value of extension
    Binding: DeviceAlertActivationStateCodes (required)
    .... extension:limitRange 0..1 Extension Limits applicable to the indicated alert priority.
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "limitRange"
    ..... value[x] 1..1 Range Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/device-alertDetection"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.extension:alertCode.value[x]preferredDeviceAlertConditionCodes
    http://hl7.org/fhir/ValueSet/devicealert-condition
    From this IG
    Extension.extension:priority.value[x]requiredDeviceAlertPriorityCodes(a valid code from Device Alert Priority)
    http://hl7.org/fhir/ValueSet/devicealert-priority
    From this IG
    Extension.extension:activationState.value[x]requiredDeviceAlertActivationStateCodes(a valid code from Device Alert Activation State)
    http://hl7.org/fhir/ValueSet/devicealert-activationState
    From this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    alrtdet-1errorExtensionSubextension `alertCode` may only be omitted on the Device resource.
    : extension('alertCode').exists().not() implies (%resource is Device)
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    R4B

    The extension is unchanged in R4B

    R4

    The extension is unchanged in R4

    R3

    The extension is unchanged in R3

    Search Parameters for this Extension

    (none found)