Deviceobservationreport.profile.xml

Profile for deviceobservationreport

Raw XML

<Profile xmlns="http://hl7.org/fhir">
  <text>
    <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre>
&lt;<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport" title="Describes the data produced by a device at a point in time."><b>DeviceObservationReport</b></a> xmlns=&quot;http://hl7.org/fhir&quot;&gt; <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span>
 &lt;!-- from <a href="resources.html">Resource</a>: <a href="extensibility.html">extension</a>, <a href="extensibility.html#modifierExtension">modifierExtension</a>, language, <a href="narrative.html#Narrative">text</a>, and <a href="references.html#contained">contained</a> --&gt;
 &lt;<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.instant" title="The point in time that the values are reported."><b>instant</b></a> value=&quot;[<span style="color: darkgreen"><a href="datatypes.html#instant">instant</a></span>]&quot;/&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">When the data values are reported</span><span style="color: Gray"> --&gt;</span>
 &lt;<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.identifier" title="An identifier assigned to this observation bu the source device that made the observation."><b>identifier</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#Identifier">Identifier</a></span> <span style="color: navy">As assigned by the source device</span><span style="color: Gray"> --&gt;</span>&lt;/identifier&gt;
 &lt;<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.source" title="Identification information for the device that is the source of the data."><b>source</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="device.html#Device">Device</a>)</span> <span style="color: navy">Identifies/describes where the data came from</span><span style="color: Gray"> --&gt;</span>&lt;/source&gt;
 &lt;<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.subject" title="The subject of the measurement."><b>subject</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="patient.html#Patient">Patient</a>|<a href="device.html#Device">Device</a>|<a href="location.html#Location">Location</a>)</span> <span style="color: navy">Subject of the measurement</span><span style="color: Gray"> --&gt;</span>&lt;/subject&gt;
 &lt;<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice" title="A medical-related subsystem of a medical device."><b>virtualDevice</b></a>&gt;  <span style="color: Gray">&lt;!-- <span style="color: brown"><b>0..*</b></span> A medical-related subsystem of a medical device --&gt;</span>
  &lt;<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.code" title="Describes the compartment."><b>code</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="http://hit-testing.nist.gov:13110/rtmms/index.htm.html" style="color: navy">Describes the compartment</a></span><span style="color: Gray"> --&gt;</span>&lt;/code&gt;
  &lt;<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel" title="Groups together physiological measurement data and derived data."><b>channel</b></a>&gt;  <span style="color: Gray">&lt;!-- <span style="color: brown"><b>0..*</b></span> Groups related data items --&gt;</span>
   &lt;<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel.code" title="Describes the channel."><b>code</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="http://hit-testing.nist.gov:13110/rtmms/index.htm.html" style="color: navy">Describes the channel</a></span><span style="color: Gray"> --&gt;</span>&lt;/code&gt;
   &lt;<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel.metric" title="A piece of measured or derived data that is reported by the machine."><b>metric</b></a>&gt;  <span style="color: Gray">&lt;!-- <span style="color: brown"><b>0..*</b></span> Piece of data reported by device --&gt;</span>
    &lt;<a class="dict" href="deviceobservationreport-definitions.html#DeviceObservationReport.virtualDevice.channel.metric.observ
        ation" title="The data for the metric."><b>observation</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="observation.html#Observation">Observation</a>)</span> <span style="color: navy">The data for the metric</span><span style="color: Gray"> --&gt;</span>&lt;/observation&gt;
   &lt;/metric&gt;
  &lt;/channel&gt;
 &lt;/virtualDevice&gt;
&lt;/DeviceObservationReport&gt;
</pre></div>
  </text>
  <name value="deviceobservationreport"/>
  <publisher value="FHIR Project"/>
  <description value="Basic Profile. Describes the data produced by a device at a point in time."/>
  <status value="draft"/>
  <date value="2014-09-30"/>
  <requirements value="Scope and Usage This resource carries a set of data from a device that is observing a
   subject. Most commonly, the subject is a patient, and the device is something like a vital
   signs monitor, or a glucose measurement device, but other kinds of subjects and devices
   are expected as well.   This resource does not cater for:   * Supporting real-time analytics
   and in particular, alarms that might be raised as a result of such analysis * Sending
   commands to a device This capability is expected to be subject of additional resources
   that are yet to be developed, and implmenter input on this is welcome."/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <structure>
    <type value="DeviceObservationReport"/>
    <publish value="true"/>
    <element>
      <path value="DeviceObservationReport"/>
      <definition>
        <short value="Describes the data produced by a device at a point in time"/>
        <formal value="Describes the data produced by a device at a point in time."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="Resource"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="Observation[classCode=OBS, moodCode=EVN, code &lt; DeviceObservation]"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.extension"/>
      <definition>
        <short value="Additional Content defined by implementations"/>
        <formal 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 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 simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.modifierExtension"/>
      <definition>
        <short value="Extensions that cannot be ignored"/>
        <formal 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 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 simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.text"/>
      <definition>
        <short value="Text summary of the resource, for human interpretation"/>
        <formal 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."/>
        <synonym value="narrative"/>
        <synonym value="html"/>
        <synonym value="xhtml"/>
        <synonym value="display"/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="Narrative"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.contained"/>
      <definition>
        <short value="Contained, inline Resources"/>
        <formal 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."/>
        <synonym value="inline resources"/>
        <synonym value="anonymous resources"/>
        <synonym value="contained resources"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Resource"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.instant"/>
      <definition>
        <short value="When the data values are reported"/>
        <formal value="The point in time that the values are reported."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="instant"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".effectiveTime"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.identifier"/>
      <definition>
        <short value="As assigned by the source device"/>
        <formal value="An identifier assigned to this observation bu the source device that made the observation."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="Identifier"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".id"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.source"/>
      <definition>
        <short value="Identifies/describes where the data came from"/>
        <formal value="Identification information for the device that is the source of the data."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="ResourceReference"/>
          <profile value="http://hl7.org/fhir/profiles/Device"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".participation[typeCode=PFM].role[player.classCode=DEV]"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.subject"/>
      <definition>
        <short value="Subject of the measurement"/>
        <formal value="The subject of the measurement."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="ResourceReference"/>
          <profile value="http://hl7.org/fhir/profiles/Patient"/>
        </type>
        <type>
          <code value="ResourceReference"/>
          <profile value="http://hl7.org/fhir/profiles/Device"/>
        </type>
        <type>
          <code value="ResourceReference"/>
          <profile value="http://hl7.org/fhir/profiles/Location"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".participation[typeCode=SBJ].role"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.virtualDevice"/>
      <definition>
        <short value="A medical-related subsystem of a medical device"/>
        <formal value="A medical-related subsystem of a medical device."/>
        <min value="0"/>
        <max value="*"/>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".outboundRelationship[typeCode='COMP'].target[classCode=OBS, moodCode=EVN, code &lt; &quot;virtual
           device compartment&quot;]"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.virtualDevice.extension"/>
      <definition>
        <short value="Additional Content defined by implementations"/>
        <formal 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 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 simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.virtualDevice.modifierExtension"/>
      <definition>
        <short value="Extensions that cannot be ignored"/>
        <formal 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 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 simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.virtualDevice.code"/>
      <definition>
        <short value="Describes the compartment"/>
        <formal value="Describes the compartment."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="CodeableConcept"/>
        </type>
        <isModifier value="false"/>
        <binding>
          <name value="VirtalDeviceKind"/>
          <isExtensible value="true"/>
          <conformance value="preferred"/>
          <referenceUri value="http://hit-testing.nist.gov:13110/rtmms/index.htm"/>
        </binding>
        <mapping>
          <identity value="rim"/>
          <map value=".code"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.virtualDevice.channel"/>
      <definition>
        <short value="Groups related data items"/>
        <formal value="Groups together physiological measurement data and derived data."/>
        <min value="0"/>
        <max value="*"/>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".outboundRelationship[typeCode='COMP'].target[classCode=OBS, moodCode=EVN, code &lt; &quot;channel&q
          uot;]"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.virtualDevice.channel.extension"/>
      <definition>
        <short value="Additional Content defined by implementations"/>
        <formal 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 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 simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.virtualDevice.channel.modifierExtension"/>
      <definition>
        <short value="Extensions that cannot be ignored"/>
        <formal 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 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 simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.virtualDevice.channel.code"/>
      <definition>
        <short value="Describes the channel"/>
        <formal value="Describes the channel."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="CodeableConcept"/>
        </type>
        <isModifier value="false"/>
        <binding>
          <name value="DeviceChannelKind1"/>
          <isExtensible value="true"/>
          <conformance value="preferred"/>
          <referenceUri value="http://hit-testing.nist.gov:13110/rtmms/index.htm"/>
        </binding>
        <mapping>
          <identity value="rim"/>
          <map value=".participation[typeCode=PFM].role.code"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.virtualDevice.channel.metric"/>
      <definition>
        <short value="Piece of data reported by device"/>
        <formal value="A piece of measured or derived data that is reported by the machine."/>
        <min value="0"/>
        <max value="*"/>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".code"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.virtualDevice.channel.metric.extension"/>
      <definition>
        <short value="Additional Content defined by implementations"/>
        <formal 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 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 simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.virtualDevice.channel.metric.modifierExtension"/>
      <definition>
        <short value="Extensions that cannot be ignored"/>
        <formal 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 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 simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="DeviceObservationReport.virtualDevice.channel.metric.observation"/>
      <definition>
        <short value="The data for the metric"/>
        <formal value="The data for the metric."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="ResourceReference"/>
          <profile value="http://hl7.org/fhir/profiles/Observation"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".value"/>
        </mapping>
      </definition>
    </element>
    <searchParam>
      <name value="_id"/>
      <type value="token"/>
      <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/>
    </searchParam>
    <searchParam>
      <name value="_language"/>
      <type value="token"/>
      <documentation value="The language of the resource"/>
    </searchParam>
    <searchParam>
      <name value="channel"/>
      <type value="token"/>
      <documentation value="The channel code"/>
      <xpath value="f:DeviceObservationReport/f:virtualDevice/f:channel/f:code"/>
    </searchParam>
    <searchParam>
      <name value="code"/>
      <type value="token"/>
      <documentation value="The compatment code"/>
      <xpath value="f:DeviceObservationReport/f:virtualDevice/f:code"/>
    </searchParam>
    <searchParam>
      <name value="observation"/>
      <type value="reference"/>
      <documentation value="The data for the metric"/>
      <xpath value="f:DeviceObservationReport/f:virtualDevice/f:channel/f:metric/f:observation"/>
    </searchParam>
    <searchParam>
      <name value="source"/>
      <type value="reference"/>
      <documentation value="Identifies/describes where the data came from"/>
      <xpath value="f:DeviceObservationReport/f:source"/>
    </searchParam>
    <searchParam>
      <name value="subject"/>
      <type value="reference"/>
      <documentation value="Subject of the measurement"/>
      <xpath value="f:DeviceObservationReport/f:subject"/>
    </searchParam>
  </structure>
</Profile>