Ratio.profile.xml

StructureDefinition for Ratio

Raw XML

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Ratio"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/StructureDefinition/Ratio"/>
  <name value="Ratio"/>
  <publisher value="HL7 FHIR Standard"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <description value="Base StructureDefinition for Ratio Resource"/>
  <requirements value="Need to able to capture ratios for some measurements (titers) and some rates (costs)."/>
  <status value="draft"/>
  <date value="2015-03-27T00:13:00+11:00"/>
  <mapping>
    <identity value="v2"/>
    <uri value="http://hl7.org/v2"/>
    <name value="HL7 v2"/>
  </mapping>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <type value="type"/>
  <abstract value="false"/>
  <base value="http://hl7.org/fhir/StructureDefinition/Element"/>
  <snapshot>
    <element>
      <path value="Ratio"/>
      <short value="A ratio of two Quantity values - a numerator and a denominator"/>
      <definition value="A relationship of two Quantity values - expressed as a numerator and a denominator."/>
      <requirements value="Need to able to capture ratios for some measurements (titers) and some rates (costs)."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Ratio"/>
      </type>
      <constraint>
        <key value="rat-1"/>
        <name value="both numerator and denominator"/>
        <severity value="error"/>
        <human value="numerator and denominator SHALL both be present, or both be absent. If both are absent,
         there SHALL be some extension present"/>
        <xpath value="(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) &gt; 0) or (count(f:extension)
         &gt; 0))"/>
      </constraint>
      <mapping>
        <identity value="v2"/>
        <map value="N/A"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="RTO"/>
      </mapping>
    </element>
    <element>
      <path value="Ratio.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="Ratio.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="Ratio.numerator"/>
      <short value="Numerator value"/>
      <definition value="The value of the numerator."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Quantity"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value=".numerator"/>
      </mapping>
    </element>
    <element>
      <path value="Ratio.denominator"/>
      <short value="Denominator value"/>
      <definition value="The value of the denominator."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Quantity"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value=".denominator"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="Ratio"/>
      <short value="A ratio of two Quantity values - a numerator and a denominator"/>
      <definition value="A relationship of two Quantity values - expressed as a numerator and a denominator."/>
      <requirements value="Need to able to capture ratios for some measurements (titers) and some rates (costs)."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Element"/>
      </type>
      <constraint>
        <key value="rat-1"/>
        <name value="both numerator and denominator"/>
        <severity value="error"/>
        <human value="numerator and denominator SHALL both be present, or both be absent. If both are absent,
         there SHALL be some extension present"/>
        <xpath value="(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) &gt; 0) or (count(f:extension)
         &gt; 0))"/>
      </constraint>
      <mapping>
        <identity value="v2"/>
        <map value="N/A"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="RTO"/>
      </mapping>
    </element>
    <element>
      <path value="Ratio.numerator"/>
      <short value="Numerator value"/>
      <definition value="The value of the numerator."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Quantity"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value=".numerator"/>
      </mapping>
    </element>
    <element>
      <path value="Ratio.denominator"/>
      <short value="Denominator value"/>
      <definition value="The value of the denominator."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Quantity"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value=".denominator"/>
      </mapping>
    </element>
  </differential>
</StructureDefinition>