PrescribeIT® Specification and Guide Version 5.0

 

XML representation of the dtprofile-range-drug Profile.

Narrative view of the profile



<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="dtprofile-range-drug"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Additional information about the element">Description &amp; Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/2016may/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="dtprofile-range-drug-definitions.html#Range" title="A quantity of medication expressed as being between a minimum and maximum value">Range</a><a name="Range"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/datatypes.html#Range">Range</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Variable range for a medication</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_datatype.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Data Type" class="hierarchy"/> <a href="dtprofile-range-drug-definitions.html#Range.low">low</a><a name="Range.low"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..<span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="dtprofile-quantity-drug-admin.html" title="Quantity">PrescribeIT® Drug Quantity for Administration</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">Quantity of a medication</span><br/><span style="font-weight:bold">Binding: </span><a href="https://tgateway.infoway-inforoute.ca/vs/prescriptiondosequantityunit?versionid=20220331">PrescriptionDoseQuantityUnit (20220331)</a> (<a href="http://hl7.org/fhir/2016may/terminologies.html#extensible" title="To be conformant, the concept in this element SHALL be from the specified value set if any of the codes within the value set can apply to the concept being communicated.  If the value set does not cover the concept (based on human review), alternate codings (or, data type allowing, text) may be included instead.">extensible</a>)</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_datatype.gif" alt="." style="background-color: white; background-color: inherit" title="Data Type" class="hierarchy"/> <a href="dtprofile-range-drug-definitions.html#Range.high">high</a><a name="Range.high"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..<span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="dtprofile-quantity-drug-admin.html" title="Quantity">PrescribeIT® Drug Quantity for Administration</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">Quantity of a medication</span><br/><span style="font-weight:bold">Binding: </span><a href="https://tgateway.infoway-inforoute.ca/vs/prescriptiondosequantityunit?versionid=20220331">PrescriptionDoseQuantityUnit (20220331)</a> (<a href="http://hl7.org/fhir/2016may/terminologies.html#extensible" title="To be conformant, the concept in this element SHALL be from the specified value set if any of the codes within the value set can apply to the concept being communicated.  If the value set does not cover the concept (based on human review), alternate codings (or, data type allowing, text) may be included instead.">extensible</a>)</td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/2016may/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
  </text>
  <url
       value="http://prescribeit.ca/fhir/StructureDefinition/dtprofile-range-drug"/>
  <version value="5.0"/>
  <name value="PrescribeIT® Drug Range"/>
  <status value="draft"/>
  <date value="2016-03-30T17:01:25-04:00"/>
  <description value="Profile for representing ranges of medication quantities"/>
  <fhirVersion value="1.4.0"/>
  <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>
  <kind value="datatype"/>
  <abstract value="false"/>
  <baseType value="Range"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Range"/>
  <derivation value="constraint"/>
  <snapshot>
    <element id="Range">
      <path value="Range"/>
      <short value="Variable range for a medication"/>
      <definition
                  value="A quantity of medication expressed as being between a minimum and maximum value"/>
      <comments
                value="Conformance Rule: Only used when both a low and high value are specified"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="Range"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <maxLength value="0"/>
      <constraint>
        <key value="rng-2"/>
        <severity value="error"/>
        <human value="If present, low SHALL have a lower value than high"/>
        <expression value="low.empty() or high.empty() or (low &lt;= high)"/>
        <xpath
               value="not(exists(f:low/f:value/@value)) or not(exists(f:high/f:value/@value)) or (number(f:low/f:value/@value) &lt;= number(f:high/f:value/@value))"/>
      </constraint>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <mapping>
        <identity value="v2"/>
        <map value="NR and also possibly SN (but see also quantity)"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map
             value="IVL&lt;QTY[not(type=&quot;TS&quot;)]&gt; [lowClosed=&quot;true&quot; and highClosed=&quot;true&quot;]or URG&lt;QTY[not(type=&quot;TS&quot;)]&gt;"/>
      </mapping>
    </element>
    <element id="Range.id">
      <path value="Range.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"/>
      <base>
        <path value="Element.id"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="id"/>
      </type>
      <maxLength value="0"/>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="Range.extension">
      <path value="Range.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="*"/>
      <base>
        <path value="Element.extension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
      </type>
      <maxLength value="0"/>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="Range.low">
      <path value="Range.low"/>
      <short value="Quantity of a medication"/>
      <definition
                  value="A measured or counted amount of a medication expressed as a value and human-readable string with optional coded units expressed in a local coding system"/>
      <comments
                value="Usage Note: Quantity is used throughout the messages. It may be a drug form (e.g. TAB) an administrable drug (e.g. PUFF) form or a unit of measure (e.g. mg)."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="Range.low"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Quantity"/>
        <profile
                 value="http://prescribeit.ca/fhir/StructureDefinition/dtprofile-quantity-drug-admin"/>
      </type>
      <maxLength value="0"/>
      <constraint>
        <key value="qty-3"/>
        <severity value="error"/>
        <human
               value="If a code for the unit is present, the system SHALL also be present"/>
        <expression value="code.empty() or system.exists()"/>
        <xpath value="not(exists(f:code)) or exists(f:system)"/>
      </constraint>
      <constraint>
        <key value="sqty-1"/>
        <severity value="error"/>
        <human value="The comparator is not used on a SimpleQuantity"/>
        <expression value="comparator.empty()"/>
        <xpath value="not(exists(f:comparator))"/>
      </constraint>
      <mustSupport value="true"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <binding>
        <strength value="extensible"/>
        <valueSetReference>
          <reference
                     value="https://fhir.infoway-inforoute.ca/ValueSet/prescriptiondosequantityunit|20220331"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="SN (see also Range) or CQ"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="PQ, IVL&lt;PQ&gt;, MO, CO, depending on the values"/>
      </mapping>
    </element>
    <element id="Range.high">
      <path value="Range.high"/>
      <short value="Quantity of a medication"/>
      <definition
                  value="A measured or counted amount of a medication expressed as a value and human-readable string with optional coded units expressed in a local coding system"/>
      <comments
                value="Usage Note: Quantity is used throughout the messages. It may be a drug form (e.g. TAB) an administrable drug (e.g. PUFF) form or a unit of measure (e.g. mg)."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="Range.high"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Quantity"/>
        <profile
                 value="http://prescribeit.ca/fhir/StructureDefinition/dtprofile-quantity-drug-admin"/>
      </type>
      <maxLength value="0"/>
      <constraint>
        <key value="qty-3"/>
        <severity value="error"/>
        <human
               value="If a code for the unit is present, the system SHALL also be present"/>
        <expression value="code.empty() or system.exists()"/>
        <xpath value="not(exists(f:code)) or exists(f:system)"/>
      </constraint>
      <constraint>
        <key value="sqty-1"/>
        <severity value="error"/>
        <human value="The comparator is not used on a SimpleQuantity"/>
        <expression value="comparator.empty()"/>
        <xpath value="not(exists(f:comparator))"/>
      </constraint>
      <mustSupport value="true"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <binding>
        <strength value="extensible"/>
        <valueSetReference>
          <reference
                     value="https://fhir.infoway-inforoute.ca/ValueSet/prescriptiondosequantityunit|20220331"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="SN (see also Range) or CQ"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="PQ, IVL&lt;PQ&gt;, MO, CO, depending on the values"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element id="Range">
      <path value="Range"/>
      <short value="Variable range for a medication"/>
      <definition
                  value="A quantity of medication expressed as being between a minimum and maximum value"/>
      <comments
                value="Conformance Rule: Only used when both a low and high value are specified"/>
    </element>
    <element id="Range.low">
      <path value="Range.low"/>
      <min value="1"/>
      <type>
        <code value="Quantity"/>
        <profile
                 value="http://prescribeit.ca/fhir/StructureDefinition/dtprofile-quantity-drug-admin"/>
      </type>
      <mustSupport value="true"/>
      <binding>
        <strength value="extensible"/>
        <valueSetReference>
          <reference
                     value="https://fhir.infoway-inforoute.ca/ValueSet/prescriptiondosequantityunit|20220331"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="Range.high">
      <path value="Range.high"/>
      <min value="1"/>
      <type>
        <code value="Quantity"/>
        <profile
                 value="http://prescribeit.ca/fhir/StructureDefinition/dtprofile-quantity-drug-admin"/>
      </type>
      <mustSupport value="true"/>
      <binding>
        <strength value="extensible"/>
        <valueSetReference>
          <reference
                     value="https://fhir.infoway-inforoute.ca/ValueSet/prescriptiondosequantityunit|20220331"/>
        </valueSetReference>
      </binding>
    </element>
  </differential>
</StructureDefinition>