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

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

DistanceFromBreastSiteToNippleExtension


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="oncology-DistanceFromBreastSiteToNipple-extension"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>BC DistanceFromBreastSiteToNipple Extension</b></p>
  <p>Distance between the feature of interest (e.g., the tumor) and the nipple.</p>
</div>
  </text>
  <url
       value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-DistanceFromBreastSiteToNipple-extension"/>
  <identifier>
    <system value="http://hl7.org/fhir/us/breastcancer"/>
    <value value="oncology.DistanceFromBreastSiteToNipple"/>
  </identifier>
  <version value="0.2.0"/>
  <name value="DistanceFromBreastSiteToNippleExtension"/>
  <title value="BC DistanceFromBreastSiteToNipple Extension"/>
  <status value="draft"/>
  <date value="2018-08-17T00:00:00+10:00"/>
  <publisher
             value="The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cic/index.cfm"/>
    </telecom>
  </contact>
  <description
               value="Distance between the feature of interest (e.g., the tumor) and the nipple."/>
  <fhirVersion value="3.0.1"/>
  <kind value="complex-type"/>
  <abstract value="false"/>
  <contextType value="resource"/>
  <context value="*"/>
  <type value="Extension"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/>
  <derivation value="constraint"/>
  <snapshot>
    <element id="Extension:distancefrombreastsitetonipple">
      <path value="Extension"/>
      <short value="BC DistanceFromBreastSiteToNipple Extension"/>
      <definition
                  value="Distance between the feature of interest (e.g., the tumor) and the nipple."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="Extension"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <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="children().count() &gt; id.count()"/>
        <xpath value="@value|f:*|h:div"/>
        <source value="Element"/>
      </constraint>
      <constraint>
        <key value="ext-1"/>
        <severity value="error"/>
        <human value="Must have either extensions or value[x], not both"/>
        <expression value="extension.exists() != value.exists()"/>
        <xpath
               value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &#39;value&#39;)])"/>
        <source value="Extension"/>
      </constraint>
    </element>
    <element id="Extension:distancefrombreastsitetonipple.id">
      <path value="Extension.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="Extension:distancefrombreastsitetonipple.extension:extension">
      <path value="Extension.extension"/>
      <sliceName value="extension"/>
      <short value="Extension"/>
      <definition value="An Extension"/>
      <min value="0"/>
      <max value="0"/>
      <base>
        <path value="Element.extension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
      </type>
    </element>
    <element id="Extension:distancefrombreastsitetonipple.url">
      <path value="Extension.url"/>
      <representation value="xmlAttr"/>
      <short value="identifies the meaning of the extension"/>
      <definition
                  value="Source of the definition for the extension code - a logical name or a URL."/>
      <comment
               value="The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="Extension.url"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="uri"/>
      </type>
      <fixedUri
                value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-DistanceFromBreastSiteToNipple-extension"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element id="Extension:distancefrombreastsitetonipple.valueQuantity">
      <path value="Extension.valueQuantity"/>
      <short value="Value of extension"/>
      <definition
                  value="Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list)."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="Extension.value[x]"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Quantity"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element id="Extension:distancefrombreastsitetonipple.valueQuantity.id">
      <path value="Extension.valueQuantity.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="Extension:distancefrombreastsitetonipple.valueQuantity.extension">
      <path value="Extension.valueQuantity.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="Extension:distancefrombreastsitetonipple.valueQuantity.value">
      <path value="Extension.valueQuantity.value"/>
      <short value="Numerical value (with implicit precision)"/>
      <definition
                  value="The value of the measured amount. The value includes an implicit precision in the presentation of the value."/>
      <comment
               value="The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books)."/>
      <requirements
                    value="Precision is handled implicitly in almost all cases of measurement."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="decimal"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="SN.2  / CQ - N/A"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map
             value="PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value"/>
      </mapping>
    </element>
    <element
             id="Extension:distancefrombreastsitetonipple.valueQuantity.comparator">
      <path value="Extension.valueQuantity.comparator"/>
      <short value="&lt; | &lt;= | &gt;= | &gt; - how to understand the value"/>
      <definition
                  value="How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is &quot;&lt;&quot; , then the real value is &lt; stated value."/>
      <comment
               value="This is labeled as &quot;Is Modifier&quot; because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value."/>
      <requirements
                    value="Need a framework for handling measures where the value is &lt;5ug/L or &gt;400mg/L due to the limitations of measuring methodology."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <meaningWhenMissing
                          value="If there is no comparator, then there is no modification of the value"/>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <binding>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="QuantityComparator"/>
        </extension>
        <strength value="required"/>
        <description
                     value="How the Quantity should be understood and represented."/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/quantity-comparator"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="SN.1  / CQ.1"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="IVL properties"/>
      </mapping>
    </element>
    <element id="Extension:distancefrombreastsitetonipple.valueQuantity.unit">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
        <valueBoolean value="true"/>
      </extension>
      <path value="Extension.valueQuantity.unit"/>
      <short value="Unit representation"/>
      <definition value="A human-readable form of the unit."/>
      <requirements
                    value="There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="(see OBX.6 etc.) / CQ.2"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="PQ.unit"/>
      </mapping>
    </element>
    <element id="Extension:distancefrombreastsitetonipple.valueQuantity.system">
      <path value="Extension.valueQuantity.system"/>
      <short value="System that defines coded unit form"/>
      <definition
                  value="The identification of the system that provides the coded form of the unit."/>
      <requirements
                    value="Need to know the system that defines the coded form of the unit."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
      <fixedUri value="http://unitsofmeasure.org"/>
      <condition value="qty-3"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="(see OBX.6 etc.) / CQ.2"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="CO.codeSystem, PQ.translation.codeSystem"/>
      </mapping>
    </element>
    <element id="Extension:distancefrombreastsitetonipple.valueQuantity.code">
      <path value="Extension.valueQuantity.code"/>
      <short value="Coded form of the unit"/>
      <definition
                  value="A computer processable form of the unit in some unit representation system."/>
      <comment
               value="The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency.  The context of use may additionally require a code from a particular system."/>
      <requirements
                    value="Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <fixedCode value="cm"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="(see OBX.6 etc.) / CQ.2"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="PQ.code, MO.currency, PQ.translation.code"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element id="Extension:distancefrombreastsitetonipple">
      <path value="Extension"/>
      <short value="BC DistanceFromBreastSiteToNipple Extension"/>
      <definition
                  value="Distance between the feature of interest (e.g., the tumor) and the nipple."/>
      <min value="0"/>
      <max value="*"/>
    </element>
    <element id="Extension:distancefrombreastsitetonipple.extension:extension">
      <path value="Extension.extension"/>
      <sliceName value="extension"/>
      <max value="0"/>
    </element>
    <element id="Extension:distancefrombreastsitetonipple.url">
      <path value="Extension.url"/>
      <type>
        <code value="uri"/>
      </type>
      <fixedUri
                value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-DistanceFromBreastSiteToNipple-extension"/>
    </element>
    <element id="Extension:distancefrombreastsitetonipple.valueQuantity">
      <path value="Extension.valueQuantity"/>
      <min value="1"/>
      <type>
        <code value="Quantity"/>
      </type>
    </element>
    <element id="Extension:distancefrombreastsitetonipple.valueQuantity.system">
      <path value="Extension.valueQuantity.system"/>
      <fixedUri value="http://unitsofmeasure.org"/>
    </element>
    <element id="Extension:distancefrombreastsitetonipple.valueQuantity.code">
      <path value="Extension.valueQuantity.code"/>
      <fixedCode value="cm"/>
    </element>
  </differential>
</StructureDefinition>