Name Flags Card. Type Description & Constraints DeviceMetric 0..* DeviceMetric Measurement, calculation or setting capability of a medical device Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url instance S 0..1 (Complex) Instance number or label URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/device-instance extension:number 0..1 Extension Instance number valueUnsignedInt 1..1 unsignedInt Value of extension extension:label 0..1 Extension Instance label valueString 1..1 string Value of extension relation 0..* (Complex) Modelling relationships URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/relation metricAvailability S 0..1 code Availability of metrics URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/metric-availability Binding: Metric Availability (extensible): Metric Availability technicalRange S 0..1 (Complex) Technical range and accuracy URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/technical-range resolution S 0..1 decimal Minimum determinable difference URL: http://hl7.org/fhir/uv/pocd/StructureDefinition/resolution type S 1..1 CodeableConcept Identity of metric, for example Heart Rate or PEEP Setting Binding: MDC Metric nomenclature (extensible) coding 0..* Coding Code defined by a terminology system system 0..1 uri Identity of the terminology system version 0..1 string Version of the system - if relevant code 0..1 code Symbol in syntax defined by the system text 0..1 string Plain text representation of the concept unit S 0..1 CodeableConcept Unit of Measure for the Metric Binding: MDC Unit of Measurement (extensible) coding 0..* Coding Code defined by a terminology system system 0..1 uri Identity of the terminology system version 0..1 string Version of the system - if relevant code 0..1 code Symbol in syntax defined by the system text 0..1 string Plain text representation of the concept source S 1..1 Reference(MDS Device profile) Describes the link to the source Device parent S 1..1 Reference(Channel Device profile) Describes the link to the parent Device operationalStatus S 0..1 code on | off | standby | entered-in-error color 0..1 code black | red | green | yellow | blue | magenta | cyan | white category S 1..1 code measurement | setting | calculation | unspecified measurementPeriod S 0..1 Timing Describes the measurement repetition time repeat 0..1 Element When the event is to occur duration 0..1 decimal How long when it happens period 0..1 decimal Event occurs frequency times per period periodUnit 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM) calibration S 0..* BackboneElement Describes the calibrations that have been performed or that are required to be performed type 0..1 code unspecified | offset | gain | two-point state 0..1 code not-calibrated | calibration-required | calibrated | unspecified time 0..1 instant Describes the time last calibration has been performed Documentation for this format
The profile defines the following rules: * `DeviceMetric.type` shall have a coding from the ISO/IEEE 11073 MDC Metric nomenclature if there is an appropriate code available. * If `DeviceMetric.unit` is present, it shall have a coding from the ISO/IEEE 11073 MDC Units of measurement if there is an appropriate code available. * `DeviceMetric.source` shall be present and refer to the MDS Device resource. * `DeviceMetric.parent` shall be present and refer to the Channel Device resource which this metric belongs to. * If multiple instances of the same metric type exist, the Instance extension allows a squence to be defined. * Extensions allow relationships, metric availability, technical range, and resolution to be added.
StructureDefinition for DeviceMetric resources that represent numerical measurements, calculations, or settings characteristics and capabilities.
Measurement, calculation or setting capability of a medical device
Describes 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.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
The 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.
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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
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.
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The 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).
Text summary of the resource, for human interpretation
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.
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 information is added later.
These 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
Instance number or label for multiple components of the same type.
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Additional content defined by implementations
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.
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.
Source of the definition for the extension code - a logical name or a URL.
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.
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
Relation allows the modelling of relationships between a metric and other containment tree entries.
Availability of the means that derives the metric state.
The technical possible range of determined values.
Resolution is the minimum determinable difference between two determined values.
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's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID.
For identifiers assigned to a device by the device or gateway software, the `system` element of the identifier should be set to the unique identifier of the device.
Identity of metric, for example Heart Rate or PEEP Setting
Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.
DeviceMetric.type can be referred to either IEEE 11073-10101 or LOINC.
According to ISO/IEEE 11073-20701 this element can't be empty
A reference to a code defined by a terminology system.
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Allows for alternative encodings within a code system, and translations to other code systems.
fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
The identification of the code system that defines the meaning of the symbol in the code.
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Need to be unambiguous about the source of the definition of the symbol.
fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Need to refer to a particular code in the system.
fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
A representation of the meaning of the code in the system, following the rules of the system.
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
C*E.2 - but note this is not well followed
fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
If this coding was chosen directly by the user
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Plain text representation of the concept
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Very often the text is the same as a displayName of one of the codings.
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
C*E.9. But note many systems use C*E.2 for this
fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Describes 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 link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.
Describes the link to the Device 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 Device 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.
Indicates current operational state of the device. For example: On, Off, Standby, etc.
Describes the operational status of the DeviceMetric.
NumericMetricState/ActivationState note the mapping of the value set
black | red | green | yellow | blue | magenta | cyan | white
Describes 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.
measurement | setting | calculation | unspecified
Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
NumericMetricDescriptor/MetricCategory note the mapping of the value set
Describes the measurement repetition time
Describes 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.
Extensions that cannot be ignored even if unrecognized
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's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Identifies specific times when the event occurs.
In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.
A set of rules that describe when the event is scheduled.
Many timing schedules are determined by regular repetitions.
if there's a duration, there needs to be duration units
duration.empty() or durationUnit.exists()
not(exists(f:duration)) or exists(f:durationUnit)
if there's a period, there needs to be period units
not(exists(f:period)) or exists(f:periodUnit)
f:duration/@value >= 0 or not(f:duration/@value)
f:period/@value >= 0 or not(f:period/@value)
If there's a periodMax, there must be a period
not(exists(f:periodMax)) or exists(f:period)
If there's a durationMax, there must be a duration
durationMax.empty() or duration.exists()
not(exists(f:durationMax)) or exists(f:duration)
If there's a countMax, there must be a count
not(exists(f:countMax)) or exists(f:count)
If there's an offset, there must be a when (and not C, CM, CD, CV)
offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
If there's a timeOfDay, there cannot be a when, or vice versa
not(exists(f:timeOfDay)) or not(exists(f:when))
Length/Range of lengths, or (Start and/or end) limits
Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.
If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.
Repetitions may be limited by end time or total occurrences.
If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.
For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
Some activities are not instantaneous and need to be maintained for a period of time.
NumericMetricDescriptor/DeterminationPeriod Unit can be specified by durationUnit
If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.
s | min | h | d | wk | mo | a - unit of time (UCUM)
The units of time for the duration, in UCUM units.
The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.
If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
Event occurs up to frequencyMax times per period
If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.
The units of time for the period in UCUM units.
If one or more days of week is provided, then the action happens only on the specified day(s).
If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.
Specified time of day for action to take place.
When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.
An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.
When more than one event is listed, the event is tied to the union of the specified events.
Timings are frequently determined by occurrences such as waking, eating and sleep.
Real world event relating to the schedule.
The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.
BID | TID | QID | AM | PM | QD | QOD | +
A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).
BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times).
Code for a known / defined timing pattern.
Describes the calibrations that have been performed or that are required to be performed
Describes the calibrations that have been performed or that are required to be performed.
Describes the type of the calibration method.
Describes the type of a metric calibration.
not-calibrated | calibration-required | calibrated | unspecified
Describes the state of a metric calibration.
Describes the time last calibration has been performed
Describes the time last calibration has been performed.