{
  "resourceType": "StructureDefinition",
  "id": "DeviceMetric",
  "meta": {
    "lastUpdated": "2021-01-01T21:58:31.578+00:00"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
      "valueString": "Base.Entities"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
      "valueCode": "anonymous"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "dev"
    },
    {
      "url": "http://hl7.org/fhir/build/StructureDefinition/entered-in-error-status",
      "valueCode": ".operationalStatus = entered-in-error"
    }
  ],
  "url": "http://hl7.org/fhir/StructureDefinition/DeviceMetric",
  "version": "4.6.0",
  "name": "DeviceMetric",
  "status": "draft",
  "date": "2021-01-01T21:58:31+00:00",
  "publisher": "Health Level Seven International (Health Care Devices)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/healthcaredevices/index.cfm"
        }
      ]
    }
  ],
  "description": "Describes a measurement, calculation or setting capability of a medical device.",
  "fhirVersion": "4.6.0",
  "mapping": [
    {
      "identity": "w5",
      "uri": "http://hl7.org/fhir/fivews",
      "name": "FiveWs Pattern Mapping"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "resource",
  "abstract": false,
  "type": "DeviceMetric",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
  "derivation": "specialization",
  "differential": {
    "element": [
      {
        "id": "DeviceMetric",
        "path": "DeviceMetric",
        "short": "Measurement, calculation or setting capability of a medical device",
        "definition": "Describes a measurement, calculation or setting capability of a medical device.",
        "comment": "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.",
        "min": 0,
        "max": "*",
        "mapping": [
          {
            "identity": "w5",
            "map": "administrative.device"
          }
        ]
      },
      {
        "id": "DeviceMetric.identifier",
        "path": "DeviceMetric.identifier",
        "short": "Instance identifier",
        "definition": "Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID.",
        "comment": "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.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Identifier"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "w5",
            "map": "FiveWs.identifier"
          }
        ]
      },
      {
        "id": "DeviceMetric.type",
        "path": "DeviceMetric.type",
        "short": "Identity of metric, for example Heart Rate or PEEP Setting",
        "definition": "Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.",
        "comment": "DeviceMetric.type can be referred to either IEEE 11073-10101 or LOINC.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "MetricType"
            },
            {
              "url": "http://hl7.org/fhir/build/StructureDefinition/definition",
              "valueString": "Describes the metric type."
            }
          ],
          "strength": "preferred",
          "description": "IEEE 11073-10101",
          "valueSet": "http://hl7.org/fhir/ValueSet/devicemetric-type"
        },
        "mapping": [
          {
            "identity": "w5",
            "map": "FiveWs.class"
          }
        ]
      },
      {
        "id": "DeviceMetric.unit",
        "path": "DeviceMetric.unit",
        "short": "Unit of Measure for the Metric",
        "definition": "Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.",
        "comment": "DeviceMetric.unit can refer to either UCUM or preferable a RTMMS coding system.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "MetricUnit"
            },
            {
              "url": "http://hl7.org/fhir/build/StructureDefinition/definition",
              "valueString": "Describes the unit of the metric."
            }
          ],
          "strength": "preferred",
          "description": "IEEE 11073-10101",
          "valueSet": "http://hl7.org/fhir/ValueSet/devicemetric-type"
        }
      },
      {
        "id": "DeviceMetric.source",
        "path": "DeviceMetric.source",
        "short": "Describes the link to the source Device",
        "definition": "Describes the link to the  Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Device"
            ]
          }
        ],
        "isSummary": true
      },
      {
        "id": "DeviceMetric.parent",
        "path": "DeviceMetric.parent",
        "short": "Describes the link to the parent Device",
        "definition": "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.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Device"
            ]
          }
        ],
        "isSummary": true
      },
      {
        "id": "DeviceMetric.operationalStatus",
        "path": "DeviceMetric.operationalStatus",
        "short": "on | off | standby | entered-in-error",
        "definition": "Indicates current operational state of the device. For example: On, Off, Standby, etc.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "DeviceMetricOperationalStatus"
            }
          ],
          "strength": "required",
          "description": "Describes the operational status of the DeviceMetric.",
          "valueSet": "http://hl7.org/fhir/ValueSet/metric-operational-status"
        }
      },
      {
        "id": "DeviceMetric.color",
        "path": "DeviceMetric.color",
        "short": "black | red | green | yellow | blue | magenta | cyan | white",
        "definition": "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.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "DeviceMetricColor"
            }
          ],
          "strength": "required",
          "description": "Describes the typical color of representation.",
          "valueSet": "http://hl7.org/fhir/ValueSet/metric-color"
        }
      },
      {
        "id": "DeviceMetric.category",
        "path": "DeviceMetric.category",
        "short": "measurement | setting | calculation | unspecified",
        "definition": "Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "DeviceMetricCategory"
            }
          ],
          "strength": "required",
          "description": "Describes the category of the metric.",
          "valueSet": "http://hl7.org/fhir/ValueSet/metric-category"
        },
        "mapping": [
          {
            "identity": "w5",
            "map": "FiveWs.class"
          }
        ]
      },
      {
        "id": "DeviceMetric.measurementPeriod",
        "path": "DeviceMetric.measurementPeriod",
        "short": "Describes the measurement repetition time",
        "definition": "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.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Timing"
          }
        ],
        "isSummary": true
      },
      {
        "id": "DeviceMetric.calibration",
        "extension": [
          {
            "url": "http://hl7.org/fhir/build/StructureDefinition/uml-dir",
            "valueCode": "right"
          }
        ],
        "path": "DeviceMetric.calibration",
        "short": "Describes the calibrations that have been performed or that are required to be performed",
        "definition": "Describes the calibrations that have been performed or that are required to be performed.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "BackboneElement"
          }
        ],
        "isSummary": true
      },
      {
        "id": "DeviceMetric.calibration.type",
        "path": "DeviceMetric.calibration.type",
        "short": "unspecified | offset | gain | two-point",
        "definition": "Describes the type of the calibration method.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "DeviceMetricCalibrationType"
            }
          ],
          "strength": "required",
          "description": "Describes the type of a metric calibration.",
          "valueSet": "http://hl7.org/fhir/ValueSet/metric-calibration-type"
        }
      },
      {
        "id": "DeviceMetric.calibration.state",
        "path": "DeviceMetric.calibration.state",
        "short": "not-calibrated | calibration-required | calibrated | unspecified",
        "definition": "Describes the state of the calibration.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "DeviceMetricCalibrationState"
            }
          ],
          "strength": "required",
          "description": "Describes the state of a metric calibration.",
          "valueSet": "http://hl7.org/fhir/ValueSet/metric-calibration-state"
        }
      },
      {
        "id": "DeviceMetric.calibration.time",
        "path": "DeviceMetric.calibration.time",
        "short": "Describes the time last calibration has been performed",
        "definition": "Describes the time last calibration has been performed.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "instant"
          }
        ],
        "isSummary": true
      }
    ]
  }
}