Devicecomponent.profile.xml

StructureDefinition for devicecomponent

Raw XML

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="DeviceComponent"/>
  <meta>
    <lastUpdated value="2015-03-27T00:13:00.999+11:00"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/StructureDefinition/DeviceComponent"/>
  <name value="DeviceComponent"/>
  <publisher value="HL7 FHIR Project (Healthcare Devices)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/healthcaredevices/index.cfm"/>
    </telecom>
  </contact>
  <description value="Base StructureDefinition for DeviceComponent Resource"/>
  <status value="draft"/>
  <date value="2015-03-27T00:13:00+11:00"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <type value="resource"/>
  <abstract value="true"/>
  <snapshot>
    <element>
      <path value="DeviceComponent"/>
      <short value="An instance of a medical-related component of a medical device"/>
      <definition value="Describes the characteristics, operational status and capabilities of a medical-related
       component of a medical device."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="DeviceComponent"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.id"/>
      <short value="Logical id of this artefact"/>
      <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this
       value never changes."/>
      <comments value="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 value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.meta"/>
      <short value="Metadata about the resource"/>
      <definition value="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 value="0"/>
      <max value="1"/>
      <type>
        <code value="Meta"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.implicitRules"/>
      <short value="A set of rules under which this content was created"/>
      <definition value="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 value="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 value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
      <isModifier value="true"/>
    </element>
    <element>
      <path value="DeviceComponent.language"/>
      <short value="Language of the resource content"/>
      <definition value="The base language in which the resource is written."/>
      <comments value="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)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="Language"/>
        <strength value="required"/>
        <description value="A human language"/>
        <valueSetUri value="http://tools.ietf.org/html/bcp47"/>
      </binding>
    </element>
    <element>
      <path value="DeviceComponent.text"/>
      <short value="Text summary of the resource, for human interpretation"/>
      <definition value="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 &quot;clinically
       safe&quot; 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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have
       a narrative."/>
      <alias value="narrative"/>
      <alias value="html"/>
      <alias value="xhtml"/>
      <alias value="display"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Narrative"/>
      </type>
      <condition value="dom-1"/>
      <mapping>
        <identity value="rim"/>
        <map value="Act.text?"/>
      </mapping>
    </element>
    <element>
      <path value="DeviceComponent.contained"/>
      <short value="Contained, inline Resources"/>
      <definition value="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 value="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 value="inline resources"/>
      <alias value="anonymous resources"/>
      <alias value="contained resources"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Resource"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="DeviceComponent.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="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 value="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 value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="DeviceComponent.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="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 value="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 value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="DeviceComponent.type"/>
      <short value="What kind of component it is"/>
      <definition value="Describes the specific component type as defined in the object-oriented or metric nomenclature
       partition."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <binding>
        <name value="ComponentType"/>
        <strength value="required"/>
        <description value="Describes the type of the component"/>
        <valueSetUri value="https://rtmms.nist.gov/rtmms/index.htm#!hrosetta"/>
      </binding>
    </element>
    <element>
      <path value="DeviceComponent.identifier"/>
      <short value="Instance id assigned by the software stack"/>
      <definition value="Describes the local assigned unique identification by the software. For example: handle
       ID."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Identifier"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.lastSystemChange"/>
      <short value="Recent system change timestamp"/>
      <definition value="Describes the timestamp for the most recent system change which includes device configuration
       or setting change."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="instant"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.source"/>
      <short value="A source device of this component"/>
      <definition value="Describes the link to the source Device that contains administrative device information
       such as manufacture, serial number, etc."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Device"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.parent"/>
      <short value="Parent resource link"/>
      <definition value="Describes the link to the parent resource. For example: Channel is linked to its VMD parent."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/DeviceComponent"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.operationalStatus"/>
      <short value="Component operational status"/>
      <definition value="Indicates current operational status of the device. For example: On, Off, Standby, etc."/>
      <comments value="OperationalStatus for the MDS, VMD, or Channel will be bound to a specific ValueSet that
       is defined in its profile."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.parameterGroup"/>
      <short value="Current supported parameter group"/>
      <definition value="Describes the parameter group supported by the current device component that is based
       on some nomenclature, e.g., cardiovascular."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.measurementPrinciple"/>
      <short value="other | chemical | electrical | impedance | nuclear | optical | thermal | biological |
       mechanical | acoustical | manual+"/>
      <definition value="Describes the physical principle of the measurement. For example: thermal, chemical, acoustical,
       etc."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="Measmnt-Principle"/>
        <strength value="required"/>
        <description value="Different measurement principle supported by the device"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/measurement-principle"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="DeviceComponent.productionSpecification"/>
      <short value="Production specification of the component"/>
      <definition value="Describes the production specification such as component revision, serial number, etc."/>
      <min value="0"/>
      <max value="*"/>
    </element>
    <element>
      <path value="DeviceComponent.productionSpecification.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="DeviceComponent.productionSpecification.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="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 value="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 value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="DeviceComponent.productionSpecification.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="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 value="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 value="extensions"/>
      <alias value="user content"/>
      <alias value="modifiers"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="DeviceComponent.productionSpecification.specType"/>
      <short value="Specification type"/>
      <definition value="Describes the specification type, such as, serial number, part number, hardware revision,
       software revision, etc."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.productionSpecification.componentId"/>
      <short value="Internal component unique identification"/>
      <definition value="Describes the internal component unique identification. This is a provision for manufacture
       specific standard components using a private OID. 11073-10101 has a partition for private
       OID semantic that the manufacture can make use of."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Identifier"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.productionSpecification.productionSpec"/>
      <short value="A printable string defining the component"/>
      <definition value="Describes the printable string defining the component."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.languageCode"/>
      <short value="Language code for the human-readable text strings produced by the device"/>
      <definition value="Describes the language code for the human-readable text string produced by the device.
       This language code will follow the IETF language tag. Example: en-US."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="DeviceComponent"/>
      <short value="An instance of a medical-related component of a medical device"/>
      <definition value="Describes the characteristics, operational status and capabilities of a medical-related
       component of a medical device."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="DomainResource"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.type"/>
      <short value="What kind of component it is"/>
      <definition value="Describes the specific component type as defined in the object-oriented or metric nomenclature
       partition."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <binding>
        <name value="ComponentType"/>
        <strength value="required"/>
        <description value="Describes the type of the component"/>
        <valueSetUri value="https://rtmms.nist.gov/rtmms/index.htm#!hrosetta"/>
      </binding>
    </element>
    <element>
      <path value="DeviceComponent.identifier"/>
      <short value="Instance id assigned by the software stack"/>
      <definition value="Describes the local assigned unique identification by the software. For example: handle
       ID."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Identifier"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.lastSystemChange"/>
      <short value="Recent system change timestamp"/>
      <definition value="Describes the timestamp for the most recent system change which includes device configuration
       or setting change."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="instant"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.source"/>
      <short value="A source device of this component"/>
      <definition value="Describes the link to the source Device that contains administrative device information
       such as manufacture, serial number, etc."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Device"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.parent"/>
      <short value="Parent resource link"/>
      <definition value="Describes the link to the parent resource. For example: Channel is linked to its VMD parent."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/DeviceComponent"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.operationalStatus"/>
      <short value="Component operational status"/>
      <definition value="Indicates current operational status of the device. For example: On, Off, Standby, etc."/>
      <comments value="OperationalStatus for the MDS, VMD, or Channel will be bound to a specific ValueSet that
       is defined in its profile."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.parameterGroup"/>
      <short value="Current supported parameter group"/>
      <definition value="Describes the parameter group supported by the current device component that is based
       on some nomenclature, e.g., cardiovascular."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.measurementPrinciple"/>
      <short value="other | chemical | electrical | impedance | nuclear | optical | thermal | biological |
       mechanical | acoustical | manual+"/>
      <definition value="Describes the physical principle of the measurement. For example: thermal, chemical, acoustical,
       etc."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="Measmnt-Principle"/>
        <strength value="required"/>
        <description value="Different measurement principle supported by the device"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/measurement-principle"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="DeviceComponent.productionSpecification"/>
      <short value="Production specification of the component"/>
      <definition value="Describes the production specification such as component revision, serial number, etc."/>
      <min value="0"/>
      <max value="*"/>
    </element>
    <element>
      <path value="DeviceComponent.productionSpecification.specType"/>
      <short value="Specification type"/>
      <definition value="Describes the specification type, such as, serial number, part number, hardware revision,
       software revision, etc."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.productionSpecification.componentId"/>
      <short value="Internal component unique identification"/>
      <definition value="Describes the internal component unique identification. This is a provision for manufacture
       specific standard components using a private OID. 11073-10101 has a partition for private
       OID semantic that the manufacture can make use of."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Identifier"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.productionSpecification.productionSpec"/>
      <short value="A printable string defining the component"/>
      <definition value="Describes the printable string defining the component."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element>
      <path value="DeviceComponent.languageCode"/>
      <short value="Language code for the human-readable text strings produced by the device"/>
      <definition value="Describes the language code for the human-readable text string produced by the device.
       This language code will follow the IETF language tag. Example: en-US."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
    </element>
  </differential>
</StructureDefinition>