FQL is a query language that allows you to retrieve, filter and project data from any data source containing FHIR Resources. It brings the power of three existing languages together: SQL, JSON and FhirPath. It allows you to create tables and is useful for gaining insight and perform quality control.
-
Default
What is FQL?
-
FQL Query resources
FQL Playground
Try Firely Query Language in our playground by using this scope as data source.
- FQL Documentation
-
FQL Language
Syntax specification
To learn more about FQL syntax choose this menu item.
-
YamlGen Generate resources
YamlGen Playground
Try YamlGen in our playground by using this scope as data source.
-
YamlGen Language
YamlGen Syntax specification
To learn more about YamlGen syntax choose this.
-
FHIRPath Inspect resource
FHIRPath Playground
Try out the FHIRPath playground and navigate inside this resource.
-
FHIRPath Documentation
FHIRPath Documentation
Find out what FHIRPath is or learn how to write FHIRPath scripts.
-
Project FHIR API
This is the location where you can find your resource using a FHIR client.
-
Simplifier FHIR API
The global endpoint is where users can search for all resources in Simplifier. Resources have a globally unique guid Id here.
-
Custom Example generation
Custom Example generation beta
Experiment with resource instance generation using YamlGen and based on this profile.
This feature is in beta. You can help us improve it by giving feedback with the feedback button at the top of the screen.
DeviceMetric
Base StructureDefinition for DeviceMetric Resource
- type Profile on DeviceMetric
- FHIR STU3
- status Draft
-
versionnone
The canonical from this resource does not match any claim in this context and conflicts with a claim from another scope.
http://hl7.org/fhir
Canonical claims are used to verify ownership of your canonical URLs.
DeviceMetric | I | DomainResource | Element idDeviceMetric Measurement, calculation or setting capability of a medical device DefinitionDescribes a measurement, calculation or setting capability of a medical device. For the initial scope, this DeviceMetric resource is only applicable to describe a single metric node in the containment tree that is produced by the context scanner in any medical device that implements or derives from the ISO/IEEE 11073 standard.
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idDeviceMetric.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idDeviceMetric.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idDeviceMetric.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idDeviceMetric.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language. ?? (extensible) | |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idDeviceMetric.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource, and may 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. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idDeviceMetric.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idDeviceMetric.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idDeviceMetric.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. Usually modifier elements provide negation or qualification. In order 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 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
|
identifier | Σ | 1..1 | Identifier | Element idDeviceMetric.identifier Unique identifier of this DeviceMetric DefinitionDescribes the unique identification of this metric that has been assigned by the device or gateway software. For example: handle ID. It should be noted that in order to make the identifier unique, the system element of the identifier should be set to the unique identifier of the device.
|
type | Σ | 1..1 | CodeableConceptBinding | Element idDeviceMetric.type Identity of metric, for example Heart Rate or PEEP Setting DefinitionDescribes the type of the metric. For example: Heart Rate, PEEP Setting, etc. DeviceMetric.type can be referred to either IEEE 11073-10101 or LOINC. Describes the metric type. ?? (preferred)Constraints
|
unit | Σ | 0..1 | CodeableConceptBinding | Element idDeviceMetric.unit Unit of Measure for the Metric DefinitionDescribes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc. DeviceMetric.unit can refer to either UCUM or preferable a RTMMS coding system. Describes the unit of the metric. ?? (preferred)Constraints
|
source | Σ I | 0..1 | Reference(Device) | Element idDeviceMetric.source Describes the link to the source Device DefinitionDescribes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
parent | Σ I | 0..1 | Reference(DeviceComponent) | Element idDeviceMetric.parent Describes the link to the parent DeviceComponent DefinitionDescribes the link to the DeviceComponent that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a DeviceComponent that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
operationalStatus | Σ | 0..1 | codeBinding | Element idDeviceMetric.operationalStatus on | off | standby | entered-in-error DefinitionIndicates current operational state of the device. For example: On, Off, Standby, etc. Describes the operational status of the DeviceMetric. ?? (required)Constraints
|
color | Σ | 0..1 | codeBinding | Element idDeviceMetric.color black | red | green | yellow | blue | magenta | cyan | white DefinitionDescribes the color representation for the metric. This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth for example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta. Describes the typical color of representation. ?? (required)Constraints
|
category | Σ | 1..1 | codeBinding | Element idDeviceMetric.category measurement | setting | calculation | unspecified DefinitionIndicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation. Describes the category of the metric. ?? (required)Constraints
|
measurementPeriod | Σ | 0..1 | Timing | Element idDeviceMetric.measurementPeriod Describes the measurement repetition time DefinitionDescribes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured. A timing schedule can be either a list of events - intervals on which the event occurs, or a single event with repeating criteria or just repeating criteria with no actual event. When both event and a repeating specification are provided, the list of events should be understood as an interpretation of the information in the repeat structure.
|
calibration | Σ | 0..* | BackboneElement | Element idDeviceMetric.calibration Describes the calibrations that have been performed or that are required to be performed DefinitionDescribes the calibrations that have been performed or that are required to be performed.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDeviceMetric.calibration.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idDeviceMetric.calibration.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idDeviceMetric.calibration.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. In order 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 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. 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.
|
type | Σ | 0..1 | codeBinding | Element idDeviceMetric.calibration.type unspecified | offset | gain | two-point DefinitionDescribes the type of the calibration method. Describes the type of a metric calibration. ?? (required)Constraints
|
state | Σ | 0..1 | codeBinding | Element idDeviceMetric.calibration.state not-calibrated | calibration-required | calibrated | unspecified DefinitionDescribes the state of the calibration. Describes the state of a metric calibration. ?? (required)Constraints
|
time | Σ | 0..1 | instant | Element idDeviceMetric.calibration.time Describes the time last calibration has been performed DefinitionDescribes the time last calibration has been performed. Note: This is intended for precisely observed times, typically system logs etc., and not human-reported times - for them, see date and dateTime below. Time zone is always required
|