Personal Health Device Implementation Guide
2.0.1 - STU 2 International flag

This page is part of the Personal Health Device FHIR IG (v2.0.1: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Extension: Simple Alerting - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the SimpleAlerting extension

See the documentation on how to interpret the contents of this table

0. Extension
Definition

A simple set of parameters for basic alerting on numerical observed data.


Optional Extension Element - found in all resources.

ShortSimpleAlertingOptional Extensions Element
Control0..1*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control20..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Extension.extension:alertType
Slice NamealertType
Definition

An Extension

ShortExtensionAdditional content defined by implementations
Control0..1*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Extension.extension:alertType.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
8. Extension.extension:alertType.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "alertType"
}
<url value="alertType"/>
10. Extension.extension:alertType.value[x]
Definition

The type of alerting system.


Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control10..1
BindingUnless not suitable, these codes SHALL be taken from For codes, see MDC Value Set
(extensible to http://hl7.org/fhir/uv/phd/ValueSet/MDCValueSet)
TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Extension.extension:currentLimits
Slice NamecurrentLimits
Definition

An Extension

ShortExtensionAdditional content defined by implementations
Control10..1*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. Extension.extension:currentLimits.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. Extension.extension:currentLimits.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "currentLimits"
}
<url value="currentLimits"/>
18. Extension.extension:currentLimits.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control10..1
TypeRange, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
alerting-range-units: The units used should be equal. (low.code.exists() and high.code.exists() and low.code = high.code)
20. Extension.extension:alertOperationalState
Slice NamealertOperationalState
Definition

An Extension

ShortExtensionAdditional content defined by implementations
Control10..1*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. Extension.extension:alertOperationalState.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
24. Extension.extension:alertOperationalState.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "alertOperationalState"
}
<url value="alertOperationalState"/>
26. Extension.extension:alertOperationalState.value[x]
Definition

The operational state of the alerting system.


Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control10..1
BindingUnless not suitable, these codes SHALL be taken from For codes, see Simple Alert Operational States
(extensible to http://hl7.org/fhir/uv/phd/ValueSet/SimpleAlertOperationalStates)
TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Extension.extension:alertOperationalText
Slice NamealertOperationalText
Definition

An Extension

ShortExtensionAdditional content defined by implementations
Control0..1*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
30. Extension.extension:alertOperationalText.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
32. Extension.extension:alertOperationalText.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "alertOperationalText"
}
<url value="alertOperationalText"/>
34. Extension.extension:alertOperationalText.value[x]
Definition

A human readable description of the operational state of the alerting system.


Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..1
Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Extension.extension:thresholdNotificationText
Slice NamethresholdNotificationText
Definition

An Extension

ShortExtensionAdditional content defined by implementations
Control0..1*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
38. Extension.extension:thresholdNotificationText.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
40. Extension.extension:thresholdNotificationText.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "thresholdNotificationText"
}
<url value="thresholdNotificationText"/>
42. Extension.extension:thresholdNotificationText.value[x]
Definition

A human readable description of the threshold notification (DeviceAlert.label in FHIR R6).


Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..1
Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting"
}
<url value="http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting"/>
46. Extension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..01
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

See the documentation on how to interpret the contents of this table

0. Extension
Definition

A simple set of parameters for basic alerting on numerical observed data.

ShortSimpleAlerting
Control0..1
2. Extension.extension
Control2..?
4. Extension.extension:alertType
Slice NamealertType
Control0..1
6. Extension.extension:alertType.extension
Control0..0
8. Extension.extension:alertType.url
Fixed Value
{
  "url" : "alertType"
}
<url value="alertType"/>
10. Extension.extension:alertType.value[x]
Definition

The type of alerting system.

Control1..?
BindingUnless not suitable, these codes SHALL be taken from MDC Value Set
(extensible to http://hl7.org/fhir/uv/phd/ValueSet/MDCValueSet)
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
12. Extension.extension:currentLimits
Slice NamecurrentLimits
Control1..1
14. Extension.extension:currentLimits.extension
Control0..0
16. Extension.extension:currentLimits.url
Fixed Value
{
  "url" : "currentLimits"
}
<url value="currentLimits"/>
18. Extension.extension:currentLimits.value[x]
Control1..?
TypeRange
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Invariantsalerting-range-units: The units used should be equal. (low.code.exists() and high.code.exists() and low.code = high.code)
20. Extension.extension:currentLimits.value[x].low
22. Extension.extension:currentLimits.value[x].low.unit
Definition

The units should be the same as the unit of the quantity this applies to.

24. Extension.extension:currentLimits.value[x].high
26. Extension.extension:currentLimits.value[x].high.unit
Definition

The units should be the same as the unit of the quantity this applies to.

28. Extension.extension:alertOperationalState
Slice NamealertOperationalState
Control1..1
30. Extension.extension:alertOperationalState.extension
Control0..0
32. Extension.extension:alertOperationalState.url
Fixed Value
{
  "url" : "alertOperationalState"
}
<url value="alertOperationalState"/>
34. Extension.extension:alertOperationalState.value[x]
Definition

The operational state of the alerting system.

Control1..?
BindingUnless not suitable, these codes SHALL be taken from Simple Alert Operational States
(extensible to http://hl7.org/fhir/uv/phd/ValueSet/SimpleAlertOperationalStates)
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
36. Extension.extension:alertOperationalText
Slice NamealertOperationalText
Control0..1
38. Extension.extension:alertOperationalText.extension
Control0..0
40. Extension.extension:alertOperationalText.url
Fixed Value
{
  "url" : "alertOperationalText"
}
<url value="alertOperationalText"/>
42. Extension.extension:alertOperationalText.value[x]
Definition

A human readable description of the operational state of the alerting system.

Typestring
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. Extension.extension:thresholdNotificationText
Slice NamethresholdNotificationText
Control0..1
46. Extension.extension:thresholdNotificationText.extension
Control0..0
48. Extension.extension:thresholdNotificationText.url
Fixed Value
{
  "url" : "thresholdNotificationText"
}
<url value="thresholdNotificationText"/>
50. Extension.extension:thresholdNotificationText.value[x]
Definition

A human readable description of the threshold notification (DeviceAlert.label in FHIR R6).

Typestring
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. Extension.url
Fixed Value
{
  "url" : "http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting"
}
<url value="http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting"/>
54. Extension.value[x]
Control0..0

See the documentation on how to interpret the contents of this table

0. Extension
Definition

A simple set of parameters for basic alerting on numerical observed data.

ShortSimpleAlerting
Control0..1
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. Extension.extension
Definition

An Extension

ShortExtension
Control2..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. Extension.extension:alertType
Slice NamealertType
Definition

An Extension

ShortExtension
Control0..1
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Extension.extension:alertType.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
10. Extension.extension:alertType.extension
Definition

An Extension

ShortExtension
Control0..0
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
12. Extension.extension:alertType.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "alertType"
}
<url value="alertType"/>
14. Extension.extension:alertType.value[x]
Definition

The type of alerting system.

ShortValue of extension
Control1..1
BindingUnless not suitable, these codes SHALL be taken from MDC Value Set
(extensible to http://hl7.org/fhir/uv/phd/ValueSet/MDCValueSet)
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Extension.extension:currentLimits
Slice NamecurrentLimits
Definition

An Extension

ShortExtension
Control1..1
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. Extension.extension:currentLimits.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
20. Extension.extension:currentLimits.extension
Definition

An Extension

ShortExtension
Control0..0
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
22. Extension.extension:currentLimits.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "currentLimits"
}
<url value="currentLimits"/>
24. Extension.extension:currentLimits.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control1..1
TypeRange
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
alerting-range-units: The units used should be equal. (low.code.exists() and high.code.exists() and low.code = high.code)
26. Extension.extension:currentLimits.value[x].id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
28. Extension.extension:currentLimits.value[x].extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension.value[x].extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
30. Extension.extension:currentLimits.value[x].low
Definition

The low limit. The boundary is inclusive.

ShortLow limit
Comments

If the low element is missing, the low boundary is not known.

Control0..1
TypeQuantity(SimpleQuantity)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
32. Extension.extension:currentLimits.value[x].low.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
34. Extension.extension:currentLimits.value[x].low.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension.value[x].low.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
36. Extension.extension:currentLimits.value[x].low.value
Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

ShortNumerical value (with implicit precision)
Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Control0..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Precision is handled implicitly in almost all cases of measurement.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Extension.extension:currentLimits.value[x].low.comparator
Definition

Not allowed to be used in this context

Short< | <= | >= | > - how to understand the value
Control0..0
BindingThe codes SHALL be taken from QuantityComparator
(required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)

How the Quantity should be understood and represented.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Meaning if MissingIf there is no comparator, then there is no modification of the value
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Extension.extension:currentLimits.value[x].low.unit
Definition

The units should be the same as the unit of the quantity this applies to.

ShortUnit representation
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Extension.extension:currentLimits.value[x].low.system
Definition

The identification of the system that provides the coded form of the unit.

ShortSystem that defines coded unit form
Control0..1
This element is affected by the following invariants: qty-3
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to know the system that defines the coded form of the unit.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Extension.extension:currentLimits.value[x].low.code
Definition

A computer processable form of the unit in some unit representation system.

ShortCoded form of the unit
Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Control0..1
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Extension.extension:currentLimits.value[x].high
Definition

The high limit. The boundary is inclusive.

ShortHigh limit
Comments

If the high element is missing, the high boundary is not known.

Control0..1
TypeQuantity(SimpleQuantity)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
sqty-1: The comparator is not used on a SimpleQuantity (comparator.empty())
48. Extension.extension:currentLimits.value[x].high.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
50. Extension.extension:currentLimits.value[x].high.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension.value[x].high.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
52. Extension.extension:currentLimits.value[x].high.value
Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

ShortNumerical value (with implicit precision)
Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Control0..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Precision is handled implicitly in almost all cases of measurement.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Extension.extension:currentLimits.value[x].high.comparator
Definition

Not allowed to be used in this context

Short< | <= | >= | > - how to understand the value
Control0..0
BindingThe codes SHALL be taken from QuantityComparator
(required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)

How the Quantity should be understood and represented.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Meaning if MissingIf there is no comparator, then there is no modification of the value
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. Extension.extension:currentLimits.value[x].high.unit
Definition

The units should be the same as the unit of the quantity this applies to.

ShortUnit representation
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Extension.extension:currentLimits.value[x].high.system
Definition

The identification of the system that provides the coded form of the unit.

ShortSystem that defines coded unit form
Control0..1
This element is affected by the following invariants: qty-3
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to know the system that defines the coded form of the unit.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. Extension.extension:currentLimits.value[x].high.code
Definition

A computer processable form of the unit in some unit representation system.

ShortCoded form of the unit
Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Control0..1
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Extension.extension:alertOperationalState
Slice NamealertOperationalState
Definition

An Extension

ShortExtension
Control1..1
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
64. Extension.extension:alertOperationalState.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
66. Extension.extension:alertOperationalState.extension
Definition

An Extension

ShortExtension
Control0..0
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
68. Extension.extension:alertOperationalState.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "alertOperationalState"
}
<url value="alertOperationalState"/>
70. Extension.extension:alertOperationalState.value[x]
Definition

The operational state of the alerting system.

ShortValue of extension
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Simple Alert Operational States
(extensible to http://hl7.org/fhir/uv/phd/ValueSet/SimpleAlertOperationalStates)
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. Extension.extension:alertOperationalText
Slice NamealertOperationalText
Definition

An Extension

ShortExtension
Control0..1
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
74. Extension.extension:alertOperationalText.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
76. Extension.extension:alertOperationalText.extension
Definition

An Extension

ShortExtension
Control0..0
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
78. Extension.extension:alertOperationalText.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "alertOperationalText"
}
<url value="alertOperationalText"/>
80. Extension.extension:alertOperationalText.value[x]
Definition

A human readable description of the operational state of the alerting system.

ShortValue of extension
Control0..1
Typestring
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. Extension.extension:thresholdNotificationText
Slice NamethresholdNotificationText
Definition

An Extension

ShortExtension
Control0..1
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
84. Extension.extension:thresholdNotificationText.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
86. Extension.extension:thresholdNotificationText.extension
Definition

An Extension

ShortExtension
Control0..0
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
88. Extension.extension:thresholdNotificationText.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "thresholdNotificationText"
}
<url value="thresholdNotificationText"/>
90. Extension.extension:thresholdNotificationText.value[x]
Definition

A human readable description of the threshold notification (DeviceAlert.label in FHIR R6).

ShortValue of extension
Control0..1
Typestring
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting"
}
<url value="http://hl7.org/fhir/uv/phd/StructureDefinition/SimpleAlerting"/>
94. Extension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))