FHIR CI-Build
FoundationThis is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
| Modeling and Methodology Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw XML (canonical form + also see XML Format Specification)
StructureDefinition for RatioRange
<?xml version="1.0" encoding="UTF-8"?> <StructureDefinition xmlns="http://hl7.org/fhir"> <id value="RatioRange"/> <text> <status value="generated"/> <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 class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the element can appear in the instance">Card.</a> </th> <th class="hierarchy" style="width: 100px"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description & Constraints</a> <span style="float: right"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"> <img alt="doco" src="data:(snipped in html view)" style="background-color: inherit"/> </a> </span> </th> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"> <td class="hierarchy" 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(data:image/png;bas e64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAJUlEQVR4Xu3IIQEAAAgDsHd9/w4EQIOamFnaBgAA4M MKAACAKwNp30CqZFfFmwAAAABJRU5ErkJggg==)"> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Element"/> <a href="datatypes-definitions.html#RatioRange" title="RatioRange : A range of ratios expressed as a low and high numerator and a denominator.">RatioRange</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="versions.html#std-process" style="padding-left: 3px; padding-right: 3px; border: 1px grey solid; font-weight: bold; color: black; background-color: #fff5e6" title="Standards Status = Trial Use">TU</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"/> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="types.html#Element">Element</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Range of ratio values <br/> <span style="font-style: italic" title="ratrng-1">+ Rule: One of lowNumerator or highNumerator and denominator SHALL be present, or all are absent. If all are absent, there SHALL be some extension present</span> <br/> <span style="font-style: italic" title="ratrng-2">+ Rule: If present, lowNumerator SHALL have a lower value than highNumerator</span> <br/> <br/> Elements defined in Ancestors: <a href="types.html#Element" title="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.">id</a> , <a href="types.html#Element" title="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.">extension</a> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"> <td class="hierarchy" 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(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)"> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Data Type"/> <a href="datatypes-definitions.html#RatioRange.lowNumerator" title="RatioRange.lowNumerator : The value of the low limit numerator.">lowNumerator</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="conformance-rules.html#constraints" style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" title="This element has or is affected by some invariants">C</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="datatypes.html#SimpleQuantity">SimpleQuantity</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Low Numerator limit <br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"> <td class="hierarchy" 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(data:image/png;bas e64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAwEwfT6/ddA0GBAxO3NrLlKUj 9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)"> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Data Type"/> <a href="datatypes-definitions.html#RatioRange.highNumerator" title="RatioRange.highNumerator : The value of the high limit numerator.">highNumerator</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="conformance-rules.html#constraints" style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" title="This element has or is affected by some invariants">C</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="datatypes.html#SimpleQuantity">SimpleQuantity</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">High Numerator limit <br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"> <td class="hierarchy" 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(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAJUlEQVR4Xu3IIQEAAAg DsHd9/w4EQIOamFnaBgAA4MMKAACAKwNp30CqZFfFmwAAAABJRU5ErkJggg==)"> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Data Type"/> <a href="datatypes-definitions.html#RatioRange.denominator" title="RatioRange.denominator : The value of the denominator.">denominator</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="conformance-rules.html#constraints" style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" title="This element has or is affected by some invariants">C</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"> <a href="datatypes.html#SimpleQuantity">SimpleQuantity</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Denominator value <br/> </td> </tr> <tr> <td class="hierarchy" colspan="5"> <br/> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"> <img alt="doco" src="data:(snipped in html view)" style="background-color: inherit"/> Documentation for this format </a> </td> </tr> </table> </div> </text> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="trial-use"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics"> <valueCode value="can-bind"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="fhir"/> </extension> <url value="http://hl7.org/fhir/StructureDefinition/RatioRange"/> <version value="6.0.0-ballot2"/> <name value="RatioRange"/> <status value="draft"/> <experimental value="false"/> <date value="2024-11-07T14:43:37+00:00"/> <publisher value="HL7 International / FHIR Infrastructure"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/fiwg"/> </telecom> </contact> <description value="RatioRange Type: A range of ratios expressed as a low and high numerator and a denominator."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <purpose value="Need to be able to specify ranges of ratios."/> <fhirVersion value="6.0.0-ballot2"/> <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="RatioRange"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DataType"/> <derivation value="specialization"/> <snapshot> <element id="RatioRange"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="trial-use"/> </extension> <path value="RatioRange"/> <short value="Range of ratio values"/> <definition value="A range of ratios expressed as a low and high numerator and a denominator."/> <comment value="The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3."/> <min value="0"/> <max value="*"/> <base> <path value="RatioRange"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <constraint> <key value="ratrng-1"/> <severity value="error"/> <human value="One of lowNumerator or highNumerator and denominator SHALL be present, or all are absent. If all are absent, there SHALL be some extension present"/> <expression value="((lowNumerator.exists() or highNumerator.exists()) and denominator.exists()) or (lowNumerator.empty() and highNumerator.empty() and denominator.empty() and extension.exists( ))"/> <source value="http://hl7.org/fhir/StructureDefinition/RatioRange"/> </constraint> <constraint> <key value="ratrng-2"/> <severity value="error"/> <human value="If present, lowNumerator SHALL have a lower value than highNumerator"/> <expression value="lowNumerator.hasValue().not() or highNumerator.hasValue().not() or (lowNumerator.lowBoundary () <= highNumerator.highBoundary())"/> <source value="http://hl7.org/fhir/StructureDefinition/RatioRange"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="n/a,IVL<RTO<QTY[not(type="TS")]>> [lowClosed="true" and highClosed="true"]or URG<<RTO<QTY[not(type="TS")]>>"/> </mapping> <mapping> <identity value="v2"/> <map value="NR and also possibly SN (but see also quantity)"/> </mapping> </element> <element id="RatioRange.id"> <path value="RatioRange.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <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> <!-- Note: special primitive values have a FHIRPath system type. e.g. this is compiler magic (j) --> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="id"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <condition value="ele-1"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="RatioRange.extension"> <path value="RatioRange.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. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="RatioRange.lowNumerator"> <path value="RatioRange.lowNumerator"/> <short value="Low Numerator limit"/> <definition value="The value of the low limit numerator."/> <comment value="If the low element is missing, the low boundary is not known."/> <min value="0"/> <max value="1"/> <base> <path value="RatioRange.lowNumerator"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Quantity"/> <profile value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity"/> </type> <condition value="ratrng-1"/> <condition value="ratrng-2"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="NR.1"/> </mapping> <mapping> <identity value="rim"/> <map value="./low"/> </mapping> </element> <element id="RatioRange.highNumerator"> <path value="RatioRange.highNumerator"/> <short value="High Numerator limit"/> <definition value="The value of the high limit numerator."/> <comment value="If the high element is missing, the high boundary is not known."/> <min value="0"/> <max value="1"/> <base> <path value="RatioRange.highNumerator"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Quantity"/> <profile value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity"/> </type> <condition value="ratrng-1"/> <condition value="ratrng-2"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="NR.2"/> </mapping> <mapping> <identity value="rim"/> <map value="./high"/> </mapping> </element> <element id="RatioRange.denominator"> <path value="RatioRange.denominator"/> <short value="Denominator value"/> <definition value="The value of the denominator."/> <min value="0"/> <max value="1"/> <base> <path value="RatioRange.denominator"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Quantity"/> <profile value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity"/> </type> <condition value="ratrng-1"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> </element> </snapshot> <differential> <element id="RatioRange"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="trial-use"/> </extension> <path value="RatioRange"/> <short value="Range of ratio values"/> <definition value="A range of ratios expressed as a low and high numerator and a denominator."/> <comment value="The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3."/> <min value="0"/> <max value="*"/> <constraint> <key value="ratrng-1"/> <severity value="error"/> <human value="One of lowNumerator or highNumerator and denominator SHALL be present, or all are absent. If all are absent, there SHALL be some extension present"/> <expression value="((lowNumerator.exists() or highNumerator.exists()) and denominator.exists()) or (lowNumerator.empty() and highNumerator.empty() and denominator.empty() and extension.exists( ))"/> <source value="http://hl7.org/fhir/StructureDefinition/RatioRange"/> </constraint> <constraint> <key value="ratrng-2"/> <severity value="error"/> <human value="If present, lowNumerator SHALL have a lower value than highNumerator"/> <expression value="lowNumerator.hasValue().not() or highNumerator.hasValue().not() or (lowNumerator.lowBoundary () <= highNumerator.highBoundary())"/> <source value="http://hl7.org/fhir/StructureDefinition/RatioRange"/> </constraint> <mapping> <identity value="v2"/> <map value="NR and also possibly SN (but see also quantity)"/> </mapping> <mapping> <identity value="rim"/> <map value="IVL<RTO<QTY[not(type="TS")]>> [lowClosed="true" and highClosed="true"]or URG<<RTO<QTY[not(type="TS")]>>"/> </mapping> </element> <element id="RatioRange.lowNumerator"> <path value="RatioRange.lowNumerator"/> <short value="Low Numerator limit"/> <definition value="The value of the low limit numerator."/> <comment value="If the low element is missing, the low boundary is not known."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> <profile value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity"/> </type> <condition value="ratrng-1"/> <condition value="ratrng-2"/> <mapping> <identity value="v2"/> <map value="NR.1"/> </mapping> <mapping> <identity value="rim"/> <map value="./low"/> </mapping> </element> <element id="RatioRange.highNumerator"> <path value="RatioRange.highNumerator"/> <short value="High Numerator limit"/> <definition value="The value of the high limit numerator."/> <comment value="If the high element is missing, the high boundary is not known."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> <profile value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity"/> </type> <condition value="ratrng-1"/> <condition value="ratrng-2"/> <mapping> <identity value="v2"/> <map value="NR.2"/> </mapping> <mapping> <identity value="rim"/> <map value="./high"/> </mapping> </element> <element id="RatioRange.denominator"> <path value="RatioRange.denominator"/> <short value="Denominator value"/> <definition value="The value of the denominator."/> <min value="0"/> <max value="1"/> <type> <code value="Quantity"/> <profile value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity"/> </type> <condition value="ratrng-1"/> </element> </differential> </StructureDefinition>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-ballot2 generated on Thu, Nov 7, 2024 14:49+0000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change