Skip to content

Commit

Permalink
Define the modelling and requirements for compound metrics. (#254)
Browse files Browse the repository at this point in the history
* Define the modelling and requirements for compound metrics.

* Update asciidoc/volume3/biceps-content-module/tf3-ch-8.3.2.9.7-compound-metric-modelling.adoc

Agree with suggestion.

Co-authored-by: David Gregorczyk <[email protected]>

* Update asciidoc/volume3/biceps-content-module/tf3-ch-8.3.2.9.7-compound-metric-modelling.adoc

Agree with suggestion.

Co-authored-by: David Gregorczyk <[email protected]>

* Update asciidoc/volume3/biceps-content-module/tf3-ch-8.3.2.9.7-compound-metric-modelling.adoc

Agree with suggestion.

Co-authored-by: David Gregorczyk <[email protected]>

* Update asciidoc/volume3/biceps-content-module/tf3-ch-8.3.2.9.7-compound-metric-modelling.adoc

Agree with suggestion.

Co-authored-by: David Gregorczyk <[email protected]>

* Update asciidoc/volume3/biceps-content-module/tf3-ch-8.3.2.9.7-compound-metric-modelling.adoc

Agree with suggestion.

Co-authored-by: David Gregorczyk <[email protected]>

* Update asciidoc/volume3/biceps-content-module/tf3-ch-8.3.2.9.7-compound-metric-modelling.adoc

Agree with suggestion.

Co-authored-by: David Gregorczyk <[email protected]>

* #228 Change R0707 and R0708 to cover inference of compound metric measurement cycles.

---------

Co-authored-by: David Gregorczyk <[email protected]>
Co-authored-by: David Gregorczyk <[email protected]>
  • Loading branch information
3 people authored Mar 19, 2024
1 parent d75b9ee commit bb556bd
Show file tree
Hide file tree
Showing 3 changed files with 159 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
<?xml version="1.0" encoding="UTF-8"?>
<msg:GetMdibResponse
SequenceId="urn:uuid:09578906-7efd-43a7-8344-8bf37b674524"
xmlns:ext="http://standards.ieee.org/downloads/11073/11073-10207-2017/extension"
xmlns:pm="http://standards.ieee.org/downloads/11073/11073-10207-2017/participant"
xmlns:msg="http://standards.ieee.org/downloads/11073/11073-10207-2017/message"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:sdpi="urn:oid:1.3.6.1.4.1.19376.1.6.2.10.1.1.1">
<msg:Mdib SequenceId="urn:uuid:09578906-7efd-43a7-8344-8bf37b674524">
<pm:MdDescription>
<pm:Mds Handle="mds0">
<!-- containment subtree -->
<pm:Vmd Handle="vmd0" SafetyClassification="MedA">
<!-- containment subtree -->
<pm:Channel Handle="chan0" SafetyClassification="MedA">
<!-- containment subtree -->
<pm:Metric xsi:type="pm:NumericMetricDescriptor"
Handle="metric0.sys"
SafetyClassification="MedA"
Resolution="1.0"
MetricCategory="Msrmt"
DerivationMethod="Auto"
MetricAvailability="Intr"
LifeTimePeriod="PT300S">
<pm:Type Code="150021">
<pm:ConceptDescription>Noninvasive systolic blood pressure</pm:ConceptDescription>
</pm:Type>
<pm:Unit Code="266016">
<pm:ConceptDescription>mmHg</pm:ConceptDescription>
</pm:Unit>
<pm:Relation Kind="SST" Entries="metric0.dia metric0.mean">
<pm:Code Code="150020">
<pm:ConceptDescription>Noninvasive blood pressure</pm:ConceptDescription>
</pm:Code>
</pm:Relation>
</pm:Metric>
<pm:Metric xsi:type="pm:NumericMetricDescriptor"
Handle="metric0.dia"
SafetyClassification="MedA"
Resolution="1.0"
MetricCategory="Msrmt"
DerivationMethod="Auto"
MetricAvailability="Intr"
LifeTimePeriod="PT300S">
<pm:Type Code="150022">
<pm:ConceptDescription>Noninvasive diastolic blood pressure</pm:ConceptDescription>
</pm:Type>
<pm:Unit Code="266016">
<pm:ConceptDescription>mmHg</pm:ConceptDescription>
</pm:Unit>
<pm:Relation Kind="SST" Entries="metric0.sys metric0.mean">
<pm:Code Code="150020">
<pm:ConceptDescription>Noninvasive blood pressure</pm:ConceptDescription>
</pm:Code>
</pm:Relation>
</pm:Metric>
<pm:Metric xsi:type="pm:NumericMetricDescriptor"
Handle="metric0.mean"
SafetyClassification="MedA"
Resolution="1.0"
MetricCategory="Msrmt"
DerivationMethod="Auto"
MetricAvailability="Intr"
LifeTimePeriod="PT300S">
<pm:Type Code="150023">
<pm:ConceptDescription>Noninvasive mean blood pressure</pm:ConceptDescription>
</pm:Type>
<pm:Unit Code="266016">
<pm:ConceptDescription>mmHg</pm:ConceptDescription>
</pm:Unit>
<pm:Relation Kind="SST" Entries="metric0.sys metric0.dia">
<pm:Code Code="150020">
<pm:ConceptDescription>Noninvasive blood pressure</pm:ConceptDescription>
</pm:Code>
</pm:Relation>
</pm:Metric>
</pm:Channel>
</pm:Vmd>
</pm:Mds>
</pm:MdDescription>
<pm:MdState>
<!-- states -->
</pm:MdState>
</msg:Mdib>
</msg:GetMdibResponse>
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
[#vol3_clause_compound_metric_modelling]
====== Compound Metric Modelling

BICEPS does not natively support the concept of compound metrics. An example of compound metrics are blood pressures with their systolic, diastolic, and mean pressure components.

However, BICEPS supports the concept of relations in the *pm:AbstractMetricDescriptor* element that can be utilized to model compound metrics.


[sdpi_level=+1]
====== Model
This section defines the modelling of compound metrics.

In order to define which metrics belong to the same compound metric, the *pm:AbstractMetricDescriptor+++<wbr/>+++/pm:Relation* element of each metric points to the other metrics which are also part of the same compound metric.

The *pm:AbstractMetricDescriptor+++<wbr/>+++/pm:Relation+++<wbr/>+++/pm:Code* element defines the compound metric and is set to the same concept on all metrics belonging to this compound metric.

.Non-invasive Blood Pressure Metric Compound Descriptor Example
[#vol3_example_nibp_compound_metric_descriptor]
====
[source,xml]
----
include::../../listings/vol3-clause-biceps-content-example-compound-metric.xml[]
----
====

[sdpi_level=+1]
====== Requirements

This section defines the requirements to compound metrics provided in the MDIB descriptive and state parts.

[sdpi_level=+2]
====== Descriptor Part
.R0703
[sdpi_requirement#r0703,sdpi_req_level=shall]
****
For each compound metric, the <<actor_somds_provider>> shall provide a *pm:Relation* element to relate to all metrics belonging to the same compound metric.
****

.R0704
[sdpi_requirement#r0704,sdpi_req_level=shall]
****
For each *pm:Relation* of a <<actor_somds_provider>> that expresses membership in a compound metric, the <<actor_somds_provider>> shall set *pm:Code* to the coded term of the compound metric it belongs to.
****

.R0705
[sdpi_requirement#r0705,sdpi_req_level=shall]
****
For each *pm:Relation* of a <<actor_somds_provider>> that expresses membership in a compound metric, the <<actor_somds_provider>> shall set *@Kind* to *SST*.
****

.R0706
[sdpi_requirement#r0706,sdpi_req_level=shall]
****
For each *pm:Relation* of a <<actor_somds_provider>> that expresses membership in a compound metric, the <<actor_somds_provider>> shall include all handle references of those metrics that belong to the same compound metric in *pm:Relation/@Entries* excluding the handle of the metric that contains the *pm:Relation*.
****

[sdpi_level=+2]
====== State Part

.R0707
[sdpi_requirement#r0707,sdpi_req_level=shall]
****
For each compound metric of a <<actor_somds_provider>>, if *@StartTime* and *@StopTime* are available, the <<actor_somds_provider>> shall provide the same values for *@StartTime* and *@StopTime* in each metric of the compound metric to signify the same measurement cycle.
NOTE: *@DeterminationTime* may vary between individual metrics of the compound metric.
****

.R0708
[sdpi_requirement#r0708,sdpi_req_level=shall]
****
For each compound metric of a <<actor_somds_provider>>, if *@StartTime* and *@StopTime* are not available, the <<actor_somds_provider>> shall provide the same value for *@DeterminationTime* in each metric of the compound metric to signify the same measurement cycle.
****
2 changes: 2 additions & 0 deletions asciidoc/volume3/tf3-ch-8.3.2-biceps-content.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -272,5 +272,7 @@ include::biceps-extension-provisions/tf3-ch-8.3.2.9.5-extension-gender.adoc[]

include::biceps-extension-provisions/tf3-ch-8.3.2.9.6-extension-equipment-identifier.adoc[]

include::biceps-content-module/tf3-ch-8.3.2.9.7-compound-metric-modelling.adoc[]

// 8.3.2.10
include::mdib-efficieny/tf3-ch-8.3.2.10-mdib-efficiency-considerations.adoc[]

0 comments on commit bb556bd

Please sign in to comment.