HL7 FHIR® Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment)

This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.1.0: STU 1 Draft) based on FHIR R3. . For a full list of available versions, see the Directory of published versions

RatioProfile


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="shr-core-Ratio"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>BC Ratio Profile</b></p>
  <p>A unit of measurement for the quotient of the amount of one entity to another.</p>
  <p><b>BC Mapping Summary</b></p>
  <p><pre>shr.core.Ratio maps to Ratio:
  Numerator maps to numerator
  Denominator maps to denominator
</pre></p>
</div>
  </text>
  <url
       value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Ratio"/>
  <identifier>
    <system value="http://hl7.org/fhir/us/breastcancer"/>
    <value value="shr.core.Ratio"/>
  </identifier>
  <version value="0.1.0"/>
  <name value="RatioProfile"/>
  <title value="BC Ratio Profile"/>
  <status value="draft"/>
  <date value="2018-04-01T00:00:00+11:00"/>
  <publisher
             value="The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://standardhealthrecord.org"/>
    </telecom>
  </contact>
  <description
               value="A unit of measurement for the quotient of the amount of one entity to another."/>
  <purpose
           value="Need to able to capture ratios for some measurements (titers) and some rates (costs)."/>
  <fhirVersion value="3.0.1"/>
  <mapping>
    <identity value="v2"/>
    <uri value="http://hl7.org/v2"/>
    <name value="HL7 v2 Mapping"/>
  </mapping>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <kind value="complex-type"/>
  <abstract value="false"/>
  <type value="Ratio"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Ratio"/>
  <derivation value="constraint"/>
  <snapshot>
    <element id="Ratio:shr-core-Ratio">
      <path value="Ratio"/>
      <short value="BC Ratio Profile"/>
      <definition
                  value="A unit of measurement for the quotient of the amount of one entity to another."/>
      <min value="0"/>
      <max value="*"/>
      <condition value="ele-1"/>
      <constraint>
        <key value="ele-1"/>
        <severity value="error"/>
        <human value="All FHIR elements must have a @value or children"/>
        <expression value="hasValue() | (children().count() &gt; id.count())"/>
        <xpath value="@value|f:*|h:div"/>
        <source value="Element"/>
      </constraint>
      <constraint>
        <key value="rat-1"/>
        <severity value="error"/>
        <human
               value="Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present"/>
        <expression
                    value="(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())"/>
        <xpath
               value="(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) &gt; 0) or (count(f:extension) &gt; 0))"/>
      </constraint>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
      <mapping>
        <identity value="v2"/>
        <map value="N/A"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="RTO"/>
      </mapping>
    </element>
    <element id="Ratio:shr-core-Ratio.id">
      <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). This may be any string value that does not contain spaces."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Element.id"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="Ratio:shr-core-Ratio.extension">
      <path value="Ratio.extension"/>
      <slicing>
        <discriminator>
          <type value="value"/>
          <path value="url"/>
        </discriminator>
        <description value="Extensions are always sliced by (at least) url"/>
        <rules value="open"/>
      </slicing>
      <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."/>
      <comment
               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="*"/>
      <base>
        <path value="Element.extension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="Ratio:shr-core-Ratio.numerator">
      <path value="Ratio.numerator"/>
      <short value="Numerator value"/>
      <definition value="The value of the numerator."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Quantity"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".numerator"/>
      </mapping>
    </element>
    <element id="Ratio:shr-core-Ratio.denominator">
      <path value="Ratio.denominator"/>
      <short value="Denominator value"/>
      <definition value="The value of the denominator."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Quantity"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value=".denominator"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element id="Ratio:shr-core-Ratio">
      <path value="Ratio"/>
      <short value="BC Ratio Profile"/>
      <definition
                  value="A unit of measurement for the quotient of the amount of one entity to another."/>
    </element>
    <element id="Ratio:shr-core-Ratio.numerator">
      <path value="Ratio.numerator"/>
      <min value="1"/>
      <max value="1"/>
    </element>
    <element id="Ratio:shr-core-Ratio.denominator">
      <path value="Ratio.denominator"/>
      <min value="1"/>
      <max value="1"/>
    </element>
  </differential>
</StructureDefinition>