FHIR CI-Build
AdministrationThis is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions 
| Health Care Devices Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Device, Encounter, Group, Patient, Practitioner, RelatedPerson |
This is a representation of the json schema for DeviceAlert, which is just a part of the full JSON Schema.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/DeviceAlert",
"$ref": "#/definitions/DeviceAlert",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"DeviceAlert": {
"description": "Describes a noteworthy condition or occurrence determined to exist by a device.",
"properties": {
"resourceType": {
"description": "This is a DeviceAlert resource",
"const": "DeviceAlert"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"procedure": {
"description": "The procedure (or procedures) during which the alert condition was raised.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"status": {
"description": "The current state of the device alert.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"category": {
"description": "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.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"type": {
"description": "physiological | technical.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"priority": {
"description": "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.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"code": {
"description": "A code that indicates the specific condition that triggered the alert.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"subject": {
"description": "Who or what the alert is about.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"encounter": {
"description": "The Encounter during which the alert condition was raised.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"presence": {
"description": "Whether the alert condition is currently active.",
"$ref": "#/definitions/boolean"
},
"_presence": {
"description": "Extensions for presence",
"$ref": "Element.schema.json#/definitions/Element"
},
"presencePeriod": {
"description": "The period when the alert condition occurred or is occurring.",
"$ref": "Period.schema.json#/definitions/Period"
},
"device": {
"description": "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.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"acknowledged": {
"description": "An indication of whether (true) or not (false) the alert condition has been acknowledged.",
"$ref": "#/definitions/boolean"
},
"_acknowledged": {
"description": "Extensions for acknowledged",
"$ref": "Element.schema.json#/definitions/Element"
},
"acknowledgedBy": {
"description": "An indication of who or what acknowledged the alert condition.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"location": {
"description": "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.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"derivedFrom": {
"description": "The value causing the alert condition.",
"items": {
"$ref": "#/definitions/DeviceAlert_DerivedFrom"
},
"type": "array"
},
"label": {
"description": "The label may combine information from the alert code, priority, the measurement type, measurement value, body sites and other sources, e.g., “HR \u003e 180”.",
"$ref": "#/definitions/string"
},
"_label": {
"description": "Extensions for label",
"$ref": "Element.schema.json#/definitions/Element"
},
"signal": {
"description": "Annunciation or notification of the alert condition.",
"items": {
"$ref": "#/definitions/DeviceAlert_Signal"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"code",
"subject",
"resourceType"
]
},
"DeviceAlert_DerivedFrom": {
"description": "Describes a noteworthy condition or occurrence determined to exist by a device.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "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 managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"observation": {
"description": "Indicates the Observation whose value is causing the alert condition; or, if `component` is present, the Observation with a component causing the alert condition.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"component": {
"description": "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.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"limit": {
"description": "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.",
"$ref": "Range.schema.json#/definitions/Range"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"observation"
]
},
"DeviceAlert_Signal": {
"description": "Describes a noteworthy condition or occurrence determined to exist by a device.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "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 managable, 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"activationState": {
"description": "Paused indicates that annunciation has temporarily been disabled (\"snooze\").",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"presence": {
"description": "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.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"annunciator": {
"description": "Signalling by the source device is local; signalling elsewhere is considered remote. A reference to the \"top level\" signalling device may also be present.",
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"manifestation": {
"description": "How the signal is being annunciated.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": {
"description": "Details of the signal manifestation, such as a 1 meter visual indicator or a 4 meter visual indicator.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"indication": {
"description": "The period during which the signal was being annunciated. If there is no indicated period end, the annunciation is on-going.",
"$ref": "Period.schema.json#/definitions/Period"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"activationState"
]
}
}
}
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-ballot3 generated on Thu, Oct 30, 2025 02:56+0000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change