Devicemetric.profile.json

StructureDefinition for devicemetric

{
  "resourceType": "StructureDefinition",
  "id": "DeviceMetric",
  "meta": {
    "lastUpdated": "2015-04-03T14:24:32.000+11:00"
  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/StructureDefinition/DeviceMetric",
  "name": "DeviceMetric",
  "publisher": "HL7 FHIR Project (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": "Base StructureDefinition for DeviceMetric Resource",
  "status": "draft",
  "date": "2015-04-03T14:24:32+11:00",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM"
    }
  ],
  "type": "resource",
  "abstract": true,
  "snapshot": {
    "element": [
      {
        "path": "DeviceMetric",
        "short": "Measurement, calculation or setting capability of a medical device",
        "definition": "Describes a measurement, calculation or setting capability of a medical device.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "DomainResource"
          }
        ]
      },
      {
        "path": "DeviceMetric.id",
        "short": "Logical id of this artefact",
        "definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
        "comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "id"
          }
        ]
      },
      {
        "path": "DeviceMetric.meta",
        "short": "Metadata about the resource",
        "definition": "The 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.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Meta"
          }
        ]
      },
      {
        "path": "DeviceMetric.implicitRules",
        "short": "A set of rules under which this content was created",
        "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
        "comments": "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 as much as possible.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "uri"
          }
        ],
        "isModifier": true
      },
      {
        "path": "DeviceMetric.language",
        "short": "Language of the resource content",
        "definition": "The base language in which the resource is written.",
        "comments": "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\n\nNot 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).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "Language",
          "strength": "required",
          "description": "A human language",
          "valueSetUri": "http://tools.ietf.org/html/bcp47"
        }
      },
      {
        "path": "DeviceMetric.text",
        "short": "Text summary of the resource, for human interpretation",
        "definition": "A 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.",
        "comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
        "alias": [
          "narrative",
          "html",
          "xhtml",
          "display"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Narrative"
          }
        ],
        "condition": [
          "dom-1"
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "Act.text?"
          }
        ]
      },
      {
        "path": "DeviceMetric.contained",
        "short": "Contained, inline Resources",
        "definition": "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.",
        "comments": "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.",
        "alias": [
          "inline resources",
          "anonymous resources",
          "contained resources"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Resource"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "DeviceMetric.extension",
        "short": "Additional Content defined by implementations",
        "definition": "May 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.",
        "comments": "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.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "DeviceMetric.modifierExtension",
        "short": "Extensions that cannot be ignored",
        "definition": "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. 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.",
        "comments": "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.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "isModifier": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "DeviceMetric.type",
        "short": "Type of metric",
        "definition": "Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "name": "MetricType",
          "strength": "required",
          "description": "Describes the metric type",
          "valueSetUri": "https://rtmms.nist.gov/rtmms/index.htm#!hrosetta"
        }
      },
      {
        "path": "DeviceMetric.identifier",
        "short": "Unique identifier of this DeviceMetric",
        "definition": "Describes the unique identification of this metric that has been assigned by the device or gateway software. For example: handle ID. \nIt 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.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "path": "DeviceMetric.unit",
        "short": "Unit of metric",
        "definition": "Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "name": "MetricUnit",
          "strength": "required",
          "description": "Describes the unit of the metric",
          "valueSetUri": "https://rtmms.nist.gov/rtmms/index.htm#!units"
        }
      },
      {
        "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 manufacture, serial number, etc.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/Device"
          }
        ]
      },
      {
        "path": "DeviceMetric.parent",
        "short": "Describes the link to the parent DeviceComponent",
        "definition": "Describes 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.\nAn 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.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/DeviceComponent"
          }
        ]
      },
      {
        "path": "DeviceMetric.operationalStatus",
        "short": "on | off | standby",
        "definition": "Indicates current operational state of the device. For example: On, Off, Standby, etc.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "DeviceMetricOperationalStatus",
          "strength": "required",
          "description": "Describes the operational status of the DeviceMetric",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/metric-operational-status"
          }
        }
      },
      {
        "path": "DeviceMetric.color",
        "short": "black | red | green | yellow | blue | magenta | cyan | white",
        "definition": "Describes the typical color of the representation of observations that have been generated for this DeviceMetric.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "DeviceMetricColor",
          "strength": "required",
          "description": "Describes the typical color of representation",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/metric-color"
          }
        }
      },
      {
        "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"
          }
        ],
        "binding": {
          "name": "DeviceMetricCategory",
          "strength": "required",
          "description": "Describes the category of the metric",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/metric-category"
          }
        }
      },
      {
        "path": "DeviceMetric.measurementPeriod",
        "short": "Describes the measurement repetition time",
        "definition": "Describes the measurement repetition time. This is not\nnecessarily the same as the update\nperiod.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Timing"
          }
        ]
      },
      {
        "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": "*"
      },
      {
        "path": "DeviceMetric.calibration.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "xml:id (or equivalent in JSON)",
        "definition": "unique id for the element within a resource (for internal references).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "id"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "DeviceMetric.calibration.extension",
        "short": "Additional Content defined by implementations",
        "definition": "May 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.",
        "comments": "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.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "DeviceMetric.calibration.modifierExtension",
        "short": "Extensions that cannot be ignored",
        "definition": "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 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.",
        "comments": "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.",
        "alias": [
          "extensions",
          "user content",
          "modifiers"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "isModifier": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "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"
          }
        ],
        "binding": {
          "name": "DeviceMetricCalibrationType",
          "strength": "required",
          "description": "Describes the type of a metric calibration",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/metric-calibration-type"
          }
        }
      },
      {
        "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"
          }
        ],
        "binding": {
          "name": "DeviceMetricCalibrationState",
          "strength": "required",
          "description": "Describes the state of a metric calibration",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/metric-calibration-state"
          }
        }
      },
      {
        "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"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "path": "DeviceMetric",
        "short": "Measurement, calculation or setting capability of a medical device",
        "definition": "Describes a measurement, calculation or setting capability of a medical device.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "DomainResource"
          }
        ]
      },
      {
        "path": "DeviceMetric.type",
        "short": "Type of metric",
        "definition": "Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "name": "MetricType",
          "strength": "required",
          "description": "Describes the metric type",
          "valueSetUri": "https://rtmms.nist.gov/rtmms/index.htm#!hrosetta"
        }
      },
      {
        "path": "DeviceMetric.identifier",
        "short": "Unique identifier of this DeviceMetric",
        "definition": "Describes the unique identification of this metric that has been assigned by the device or gateway software. For example: handle ID. \nIt 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.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "path": "DeviceMetric.unit",
        "short": "Unit of metric",
        "definition": "Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "name": "MetricUnit",
          "strength": "required",
          "description": "Describes the unit of the metric",
          "valueSetUri": "https://rtmms.nist.gov/rtmms/index.htm#!units"
        }
      },
      {
        "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 manufacture, serial number, etc.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/Device"
          }
        ]
      },
      {
        "path": "DeviceMetric.parent",
        "short": "Describes the link to the parent DeviceComponent",
        "definition": "Describes 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.\nAn 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.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/DeviceComponent"
          }
        ]
      },
      {
        "path": "DeviceMetric.operationalStatus",
        "short": "on | off | standby",
        "definition": "Indicates current operational state of the device. For example: On, Off, Standby, etc.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "DeviceMetricOperationalStatus",
          "strength": "required",
          "description": "Describes the operational status of the DeviceMetric",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/metric-operational-status"
          }
        }
      },
      {
        "path": "DeviceMetric.color",
        "short": "black | red | green | yellow | blue | magenta | cyan | white",
        "definition": "Describes the typical color of the representation of observations that have been generated for this DeviceMetric.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "DeviceMetricColor",
          "strength": "required",
          "description": "Describes the typical color of representation",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/metric-color"
          }
        }
      },
      {
        "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"
          }
        ],
        "binding": {
          "name": "DeviceMetricCategory",
          "strength": "required",
          "description": "Describes the category of the metric",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/metric-category"
          }
        }
      },
      {
        "path": "DeviceMetric.measurementPeriod",
        "short": "Describes the measurement repetition time",
        "definition": "Describes the measurement repetition time. This is not\nnecessarily the same as the update\nperiod.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Timing"
          }
        ]
      },
      {
        "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": "*"
      },
      {
        "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"
          }
        ],
        "binding": {
          "name": "DeviceMetricCalibrationType",
          "strength": "required",
          "description": "Describes the type of a metric calibration",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/metric-calibration-type"
          }
        }
      },
      {
        "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"
          }
        ],
        "binding": {
          "name": "DeviceMetricCalibrationState",
          "strength": "required",
          "description": "Describes the state of a metric calibration",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/metric-calibration-state"
          }
        }
      },
      {
        "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"
          }
        ]
      }
    ]
  }
}