3.79.9 StructureDefinition: PrescribeIT® Unit Price Quantity - XML Profile
XML representation of the dtprofile-quantity-unit-price Profile.
Narrative view of the profile
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="dtprofile-quantity-unit-price"/>
<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 & 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-quantity-unit-price-definitions.html#Quantity" title="A cost in dollars for a single unit of a particular drug or other prescribable product">Quantity</a><a name="Quantity"> </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#SimpleQuantity">SimpleQuantity</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Unit Price of a prescribable item</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_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="dtprofile-quantity-unit-price-definitions.html#Quantity.value">value</a><a name="Quantity.value"> </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 style="opacity: 0.5" href="http://hl7.org/fhir/2016may/datatypes.html#decimal">decimal</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">Numerical value (with implicit precision)</span></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_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_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="dtprofile-quantity-unit-price-definitions.html#Quantity.unit">unit</a><a name="Quantity.unit"> </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 style="opacity: 0.5" href="http://hl7.org/fhir/2016may/datatypes.html#string">string</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Human-readable unit cost</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_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="dtprofile-quantity-unit-price-definitions.html#Quantity.system">system</a><a name="Quantity.system"> </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"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><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 style="opacity: 0.5" href="http://hl7.org/fhir/2016may/datatypes.html#uri">uri</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">System that defines coded unit form</span></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_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="dtprofile-quantity-unit-price-definitions.html#Quantity.code">code</a><a name="Quantity.code"> </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"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><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 style="opacity: 0.5" href="http://hl7.org/fhir/2016may/datatypes.html#code">code</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">Coded form of the unit</span></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-quantity-unit-price"/>
<version value="5.0"/>
<name value="PrescribeIT® Unit Price Quantity"/>
<status value="draft"/>
<date value="2016-03-30T17:01:25-04:00"/>
<description
value="Profile for representing unit prices of prescribable items"/>
<fhirVersion value="1.4.0"/>
<kind value="datatype"/>
<abstract value="false"/>
<baseType value="Quantity"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity"/>
<derivation value="constraint"/>
<snapshot>
<element id="Quantity">
<path value="Quantity"/>
<short value="Unit Price of a prescribable item"/>
<definition
value="A cost in dollars for a single unit of a particular drug or other prescribable product"/>
<comments
value="The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Quantity"/>
<min value="0"/>
<max value="*"/>
</base>
<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="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="v2"/>
<map value="SN (see also Range) or CQ"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="PQ, IVL<PQ>, MO, CO, depending on the values"/>
</mapping>
</element>
<element id="Quantity.id">
<path value="Quantity.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="Quantity.extension">
<path value="Quantity.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="Quantity.value">
<path value="Quantity.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."/>
<comments
value="This will always be expressed in dollars/unit, even if the value is fraction of a sent. E.g. 0.0023"/>
<requirements
value="Precision is handled implicitly in almost all cases of measurement."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Quantity.value"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="decimal"/>
</type>
<maxLength value="0"/>
<mustSupport value="true"/>
<isModifier value="false"/>
<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="Quantity.comparator">
<path value="Quantity.comparator"/>
<short value="< | <= | >= | > - how to understand the value"/>
<definition value="Not allowed to be used in this context"/>
<comments
value="This is labeled as "Is Modifier" 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 <5ug/L or >400mg/L due to the limitations of measuring methodology."/>
<min value="0"/>
<max value="0"/>
<base>
<path value="Quantity.comparator"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<meaningWhenMissing
value="If there is no comparator, then there is no modification of the value"/>
<maxLength value="0"/>
<mustSupport value="false"/>
<isModifier value="true"/>
<isSummary value="true"/>
<binding>
<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="Quantity.unit">
<path value="Quantity.unit"/>
<short value="Human-readable unit cost"/>
<definition value="A human-readable form of the unit."/>
<comments value="This should be expressed as $/tablet, $/mL, $/mg, etc."/>
<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="1"/>
<max value="1"/>
<base>
<path value="Quantity.unit"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<maxLength value="0"/>
<mustSupport value="true"/>
<isModifier value="false"/>
<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="Quantity.system">
<path value="Quantity.system"/>
<short value="System that defines coded unit form"/>
<definition
value="The identification of the system that provides the coded form of the unit."/>
<comments value="This will generally be UCUM."/>
<requirements
value="Need to know the system that defines the coded form of the unit."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Quantity.system"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</type>
<maxLength value="0"/>
<condition value="qty-3"/>
<mustSupport value="true"/>
<isModifier value="false"/>
<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="Quantity.code">
<path value="Quantity.code"/>
<short value="Coded form of the unit"/>
<definition
value="A computer processable form of the unit in some unit representation system."/>
<comments
value="If expressed as UCUM, this will be expressed as 1/mL, 1/mg, etc. The fact that the numerator is a dollar amount or the form of the drug will not be conveyed (though it will in the human-readable representation)"/>
<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"/>
<base>
<path value="Quantity.code"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<maxLength value="0"/>
<mustSupport value="true"/>
<isModifier value="false"/>
<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="Quantity">
<path value="Quantity"/>
<short value="Unit Price of a prescribable item"/>
<definition
value="A cost in dollars for a single unit of a particular drug or other prescribable product"/>
</element>
<element id="Quantity.value">
<path value="Quantity.value"/>
<comments
value="This will always be expressed in dollars/unit, even if the value is fraction of a sent. E.g. 0.0023"/>
<min value="1"/>
<mustSupport value="true"/>
</element>
<element id="Quantity.unit">
<path value="Quantity.unit"/>
<short value="Human-readable unit cost"/>
<comments value="This should be expressed as $/tablet, $/mL, $/mg, etc."/>
<min value="1"/>
<mustSupport value="true"/>
</element>
<element id="Quantity.system">
<path value="Quantity.system"/>
<comments value="This will generally be UCUM."/>
<mustSupport value="true"/>
</element>
<element id="Quantity.code">
<path value="Quantity.code"/>
<comments
value="If expressed as UCUM, this will be expressed as 1/mL, 1/mg, etc. The fact that the numerator is a dollar amount or the form of the drug will not be conveyed (though it will in the human-readable representation)"/>
<mustSupport value="true"/>
</element>
</differential>
</StructureDefinition>