FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Health Care Devices icon Work GroupMaturity Level: 2 DraftSecurity Category: Patient Compartments: Device, Encounter, Group, Patient, Practitioner, RelatedPerson

Detailed Descriptions for the elements in the DeviceAlert resource.

Element Id DeviceAlert
Definition

Describes a noteworthy condition or occurrence determined to exist by a device.

Short Display Documentation of an alert (a.k.a. alarm) generated by a device indicating a noteworthy condition
Cardinality 0..*
Type DomainResource
Summary false
Comments

The DeviceAlert resource is derived from the ISO/IEEE 11073-10201 Domain Information Model standard, but is more widely applicable.

Element Id DeviceAlert.identifier
Definition

Business identifiers assigned to this alert, by the source device, gateway software, manufacturers, or other systems or organizations. These identifiers remain constant as the resource is updated and propagates from server to server.

Short Display Business identifier for this device alert
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 0..*
Type Identifier
Requirements

Allows identification of the device alert as it is known by various participating systems and in a way that remains consistent across servers.

Summary true
Comments

Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For identifiers assigned to an alert by the device or gateway software, the system element of the identifier might be set to an identifier of the device.

Element Id DeviceAlert.procedure
Definition

The procedure (or procedures) during which the alert condition was raised.

Short Display Procedure during which the alert occurred
Cardinality 0..*
Type Reference(Procedure)
Summary true
Element Id DeviceAlert.status
Definition

The current state of the device alert.

Short Display in-progress | completed | entered-in-error | unknown
Cardinality 1..1
Terminology Binding DeviceAlert Status Codes (Required)
Type code
Is Modifier true (Reason: This element is labeled as a modifier because it has a potential code that indicates the Alert was entered in error.)
Summary true
Comments

Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

Element Id DeviceAlert.category
Definition

Partitions the device alert into one or more categories that can be used to filter searching, to govern access control and/or to guide system behavior.

Short Display High level categorization of device alert
Cardinality 0..*
Terminology Binding DeviceAlert Category Codes (Example)
Type CodeableConcept
Summary true
Comments

Categorization might be done automatically (inferred by code) or manually by user assertion. The absence of a category may limit the ability to determine when the element should be handled, so strong consideration should be given to how systems will be able to determine category values for legacy data and how data that cannot be categorized will be handled. As well, some categories might not be mutually exclusive, so systems should prepare for multiple declared categories - even within a single category 'axis'.

Element Id DeviceAlert.type
Definition

physiological | technical.

Short Display physiological | technical
Cardinality 0..1
Terminology Binding DeviceAlert Type Codes (Extensible)
Type CodeableConcept
Summary false
Element Id DeviceAlert.priority
Definition

The alert priority is usually reported by the source device. A priority of info may indicate that the alert is “for information only” and not urgent action is required. The element may be omitted if the priority is unknown.

Short Display high | medium | low | info
Cardinality 0..1
Terminology Binding DeviceAlert Priority Codes (Extensible)
Type CodeableConcept
Summary true
Element Id DeviceAlert.code
Definition

A code that indicates the specific condition that triggered the alert.

Short Display The meaning of the alert
Cardinality 1..1
Terminology Binding DeviceAlert Condition Codes (Preferred)
Type CodeableConcept
Summary true
Element Id DeviceAlert.subject
Definition

Who or what the alert is about.

Short Display Who or what the alert is about
Cardinality 1..1
Type Reference(Patient | Device | BiologicallyDerivedProduct | Group | Location | Medication | NutritionProduct | Specimen)
Requirements

Links the device alert to the appropriate subject context. May also affect access control.

Summary true
Element Id DeviceAlert.encounter
Definition

The Encounter during which the alert condition was raised.

Short Display Encounter during which the alert condition occurred
Cardinality 0..1
Type Reference(Encounter)
Requirements

Links the device alert to the Encounter context. May also affect access control.

Summary true
Element Id DeviceAlert.presence
Definition

Whether the alert condition is currently active.

Short Display Whether the alert condition is currently active
Cardinality 1..1
Type boolean
Summary true
Element Id DeviceAlert.occurrence[x]
Definition

This element is used to record the date or time period when the alert condition did occur or is occurring.

Short Display When the alert condition occurred/is occurring
Cardinality 0..1
Type dateTime|Period
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
Comments

This element is used to record the time period during which the alert condition is or was active. The status code allows differentiation of whether the timing reflects a historic event or an ongoing event. A date/time value should be used for instantaneous conditions; without additional guidance, partial date/time values are ambiguous about whether they represent the condition occurring at some point in the partially specified period, or for all of the period. Ongoing events should not include a Period upper bound.

Element Id DeviceAlert.device
Definition

Indicates the device that detected the alert condition. The device may be a top-level Device or component Device (such as an MDS, VMD, or Channel); or may identify the specific DeviceMetric of a Device (e.g., a heart rate reading) that was in an alert condition.

Short Display The Device (or DeviceMetric) that detected the alert condition
Cardinality 0..1
Type Reference(Device | DeviceMetric)
Summary true
Element Id DeviceAlert.acknowledged
Definition

An indication of whether (true) or not (false) the alert condition has been acknowledged.

Short Display Whether the alert condition has been acknowledged
Cardinality 0..1
Type boolean
Summary false
Element Id DeviceAlert.acknowledgedBy
Definition

An indication of who or what acknowledged the alert condition.

Short Display Who acknowledged the alert condition
Cardinality 0..1
Type Reference(Patient | Device | Practitioner | PractitionerRole | RelatedPerson)
Summary false
Element Id DeviceAlert.location
Definition

The principal physical location of the subject at the time the alert condition occurred. This may be different from the location of the alerting device at that time, and from the current location of either the subject or the alert condition detecting device.

Short Display Location of the subject when the alert was raised
Cardinality 0..1
Type Reference(Location)
Requirements

Provides context around the alert occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting).

Summary true
Element Id DeviceAlert.derivedFrom
Definition

The value causing the alert condition.

Short Display The value causing the alert condition
Cardinality 0..*
Summary false
Element Id DeviceAlert.derivedFrom.observation
Definition

Indicates the Observation whose value is causing the alert condition; or, if component is present, the Observation with a component causing the alert condition.

Short Display The Observation having a value causing the alert condition
Cardinality 1..1
Type Reference(Observation)
Summary true
Element Id DeviceAlert.derivedFrom.component
Definition

If applicable, the code of the component (of the Observation identified in derivedFrom.observation) having a value causing the alert condition. This may be used when the alert is associated with a specific component of an Observation, rather than the overall Observation; for example, a low diastolic blood pressure. Since the component is identified by matching Observation.component.code, if more than one component have the same code, the specific component is ambiguous. Repetitions of this element indicate additional components contributing to the alert condition.

Short Display The Observation.component having a value causing the alert condition
Cardinality 0..1
Terminology Binding LOINC Codes (Example)
Type Coding
Summary false
Element Id DeviceAlert.derivedFrom.limit
Definition

The limits beyond which a value was detected to cause the alert condition. The actual value is the Observation.value[x] referenced by derivedFrom.observation or, if specified, the Observation.component.value[x] of the component (with Observation.component.code matching derivedFrom.component) of the reference Observation.

Short Display The boundaries beyond which a value was detected to cause the alert condition
Cardinality 0..1
Type Range
Summary false
Element Id DeviceAlert.label
Definition

The label may combine information from the alert code, priority, the measurement type, measurement value, body sites and other sources, e.g., “HR > 180”.

Short Display Text to be displayed for the alert condition
Cardinality 0..1
Type string
Summary false
Element Id DeviceAlert.signal
Definition

Annunciation or notification of the alert condition.

Short Display Annunciation or notification of the alert condition
Cardinality 0..*
Summary false
Element Id DeviceAlert.signal.activationState
Definition

Paused indicates that annunciation has temporarily been disabled ("snooze").

Short Display on | off | paused
Cardinality 1..1
Terminology Binding DeviceAlert Activation State Codes (Extensible)
Type CodeableConcept
Summary true
Element Id DeviceAlert.signal.presence
Definition

Indicates whether the signal is currently being annunciated. An on signal is currently being annunciated; a latched signal is currently being being annunciated although the alert condition has ended; an off signal is not currently being annunciated; and an acknowledged signal is not currently being annunciated because the user has acknowledged the signal.

Short Display on | latched | off | ack
Cardinality 0..1
Terminology Binding DeviceAlert Presence Codes (Extensible)
Type CodeableConcept
Summary false
Element Id DeviceAlert.signal.annunciator
Definition

Signalling by the source device is local; signalling elsewhere is considered remote. A reference to the "top level" signalling device may also be present.

Short Display Where the signal is being annunciated
Cardinality 0..1
Terminology Binding DeviceAlert Annunciation Codes (Required)
Type CodeableReference(Device)
Summary false
Element Id DeviceAlert.signal.manifestation
Definition

How the signal is being annunciated.

Short Display How the signal is being annunciated
Cardinality 0..1
Terminology Binding DeviceAlert Manifestation Codes (Extensible)
Type CodeableConcept
Summary false
Element Id DeviceAlert.signal.type
Definition

Details of the signal manifestation, such as a 1 meter visual indicator or a 4 meter visual indicator.

Short Display Characteristics of the signal manifestation
Cardinality 0..*
Terminology Binding DeviceAlert Signal Type Codes (Example)
Type CodeableConcept
Summary false
Element Id DeviceAlert.signal.indication
Definition

The period during which the signal was being annunciated. If there is no indicated period end, the annunciation is on-going.

Short Display When the signal was being annunciated
Cardinality 0..1
Type Period
Summary false
Comments

The indication period start when the signal presence is first on (or latched) and ends when the signal becomes off or acknowledged.