EHDS openEHR data exchange
0.1.0 - ci-build

EHDS openEHR data exchange, published by Ian. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/freshehr/EHDS-openEHR-FHIR-IG/ and changes regularly. See the Directory of published versions

Logical Model: DvProportion - XML Profile

Draft as of 2026-03-25

XML representation of the DvProportion logical model.

Raw xml | Download


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="DvProportion"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureDefinition DvProportion</b></p><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 : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><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 style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><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 style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><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 style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px; width: 100px" class="hierarchy"><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 style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description &amp; 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 src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" 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 : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck0.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="StructureDefinition-DvProportion-definitions.html#DvProportion" title="openEHR Proportion">DvProportion</a><a name="DvProportion"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : var(--ig-left,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 : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_proportion_class">DV_PROPORTION</a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Proportion<br/><br/>Elements defined in Ancestors:<a href="http://hl7.org/fhir/R4/datatypes.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="http://hl7.org/fhir/R4/datatypes.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 manageable, 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>, <a href="http://hl7.org/fhir/R4/datatypes.html#string" title="Primitive value for string">@value</a>, <a href="http://hl7.org/fhir/R4/datatypes.html#code" title="Primitive value for code">@value</a>, <a href="https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_proportion_class" title="Numerator of ratio">numerator</a>, <a href="https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_proportion_class" title="Denominator of ratio.">denominator</a>, <a href="https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_proportion_class" title="Indicates semantic type of proportion, including percent, unitary etc.">type</a>, <a href="https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_proportion_class" title="Precision  to  which  the  `_numerator_` and `_denominator_` values of  the  proportion are expressed, in terms of number  of decimal places. The value 0 implies an integral quantity. The value -1 implies no limit, i.e. any number of decimal places. ">precision</a>, <a href="https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_proportion_class" title="Optional normal range. ">normal_range</a>, <a href="https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_proportion_class" title="Optional tagged other reference ranges for this value in its particular measurement context.">other_reference_ranges</a><br/><span style="font-weight:bold">Instances of this logical model are not marked to be the target of a Reference</span></td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
  </text>
  <extension url="http://hl7.org/fhir/tools/StructureDefinition/web-source">
    <valueUrl
              value="https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_proportion_class"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/type-operation">
    <valueCanonical value="#magnitude"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/type-operation">
    <valueCanonical value="#is_integral"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/type-operation">
    <valueCanonical value="#add"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/type-operation">
    <valueCanonical value="#subtract"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/type-operation">
    <valueCanonical value="#is_equal"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/type-operation">
    <valueCanonical value="#multiply"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/type-operation">
    <valueCanonical value="#less_than"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/type-operation">
    <valueCanonical value="#is_strictly_comparable_to"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics">
    <valueCode value="can-bind"/>
  </extension>
  <url
       value="https://ianbennett.github.io/ExampleIG_Ian/StructureDefinition/DvProportion"/>
  <version value="0.1.0"/>
  <name value="DvProportion"/>
  <status value="draft"/>
  <date value="2026-03-25T15:55:34+00:00"/>
  <publisher value="Ian"/>
  <contact>
    <name value="Ian"/>
    <telecom>
      <system value="url"/>
      <value value="http://example.org/example-publisher"/>
    </telecom>
  </contact>
  <fhirVersion value="4.0.1"/>
  <kind value="logical"/>
  <abstract value="false"/>
  <type
        value="https://ianbennett.github.io/ExampleIG_Ian/StructureDefinition/DvProportion"/>
  <baseDefinition
                  value="http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"/>
  <derivation value="specialization"/>
  <snapshot>
    <extension
               url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version">
      <valueString value="0.1.0-snapshot"/>
    </extension>
    <element id="DvProportion">
      <path value="DvProportion"/>
      <short value="Proportion"/>
      <definition value="openEHR Proportion"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="code"/>
        <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() &gt; id.count())"/>
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
      </constraint>
      <constraint>
        <key value="Type_validity"/>
        <severity value="error"/>
        <human value="Type validity"/>
        <expression value="null # TODO: manual translation needed"/>
        <source
                value="http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"/>
      </constraint>
      <constraint>
        <key value="Precision_validity"/>
        <severity value="error"/>
        <human
               value="Precision validity must satisfy conditional constraints"/>
        <expression value="precision = 0 implies is_integral()"/>
        <source
                value="http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"/>
      </constraint>
      <constraint>
        <key value="Is_integral_validity"/>
        <severity value="error"/>
        <human
               value="Is integral validity must satisfy conditional constraints"/>
        <expression
                    value="is_integral() implies (numerator.floor = numerator and denominator.floor = denominator)"/>
        <source
                value="http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"/>
      </constraint>
      <constraint>
        <key value="Fraction_validity"/>
        <severity value="error"/>
        <human
               value="Fraction validity must satisfy conditional constraints"/>
        <expression
                    value="(type = pk_fraction or type = pk_integer_fraction) implies is_integral()"/>
        <source
                value="http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"/>
      </constraint>
      <constraint>
        <key value="Unitary_validity"/>
        <severity value="error"/>
        <human value="Unitary validity must satisfy conditional constraints"/>
        <expression value="null # TODO: manual translation needed"/>
        <source
                value="http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"/>
      </constraint>
      <constraint>
        <key value="Percent_validity"/>
        <severity value="error"/>
        <human value="Percent validity must satisfy conditional constraints"/>
        <expression value="null # TODO: manual translation needed"/>
        <source
                value="http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"/>
      </constraint>
      <constraint>
        <key value="Valid_denominator"/>
        <severity value="error"/>
        <human value="Valid denominator"/>
        <expression value="null # TODO: manual translation needed"/>
        <source
                value="http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"/>
      </constraint>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="DvProportion.id">
      <path value="DvProportion.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="1"/>
      </base>
      <type>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="string"/>
        </extension>
        <code value="http://hl7.org/fhirpath/System.String"/>
      </type>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="DvProportion.extension">
      <path value="DvProportion.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 resource. 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() &gt; id.count())"/>
        <source value="http://hl7.org/fhir/StructureDefinition/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()"/>
        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
      </constraint>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="DvProportion.value">
      <path value="DvProportion.value"/>
      <representation value="xmlAttr"/>
      <short value="Primitive value for code"/>
      <definition value="Primitive value for code"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="string.value"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="code"/>
        </extension>
        <extension url="http://hl7.org/fhir/StructureDefinition/regex">
          <valueString value="[^\s]+( [^\s]+)*"/>
        </extension>
        <code value="http://hl7.org/fhirpath/System.String"/>
      </type>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="DvProportion.numerator">
      <path value="DvProportion.numerator"/>
      <short value="Numerator of ratio"/>
      <definition value="Numerator of ratio"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="DV_PROPORTION.numerator"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="decimal"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element id="DvProportion.denominator">
      <path value="DvProportion.denominator"/>
      <short value="Denominator of ratio."/>
      <definition value="Denominator of ratio."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="DV_PROPORTION.denominator"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="decimal"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element id="DvProportion.type">
      <path value="DvProportion.type"/>
      <short
             value="Indicates semantic type of proportion, including percent, unitary etc."/>
      <definition
                  value="Indicates semantic type of proportion, including percent, unitary etc."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="DV_PROPORTION.type"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="integer"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element id="DvProportion.precision">
      <path value="DvProportion.precision"/>
      <short
             value="Precision  to  which  the  `_numerator_` and `_denominator_` values of  the  proportion are expressed, in terms of number  of decimal places."/>
      <definition
                  value="Precision  to  which  the  `_numerator_` and `_denominator_` values of  the  proportion are expressed, in terms of number  of decimal places. The value 0 implies an integral quantity. The value -1 implies no limit, i.e. any number of decimal places."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="DV_PROPORTION.precision"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="integer"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element id="DvProportion.normal-range">
      <path value="DvProportion.normal_range"/>
      <short value="Optional normal range."/>
      <definition value="Optional normal range."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="DV_PROPORTION.normal_range"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <extension
                   url="http://hl7.org/fhir/tools/StructureDefinition/type-parameter">
          <extension url="name">
            <valueCode value="T"/>
          </extension>
          <extension url="type">
            <valueUri
                      value="http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"/>
          </extension>
        </extension>
        <code
              value="http://openehr.org/fhir/StructureDefinition/DV-INTERVAL"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element id="DvProportion.other-reference-ranges">
      <path value="DvProportion.other_reference_ranges"/>
      <short
             value="Optional tagged other reference ranges for this value in its particular measurement context."/>
      <definition
                  value="Optional tagged other reference ranges for this value in its particular measurement context."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="DV_PROPORTION.other_reference_ranges"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <extension
                   url="http://hl7.org/fhir/tools/StructureDefinition/type-parameter">
          <extension url="name">
            <valueCode value="T"/>
          </extension>
          <extension url="type">
            <valueUri
                      value="http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"/>
          </extension>
        </extension>
        <code
              value="http://openehr.org/fhir/StructureDefinition/REFERENCE-RANGE"/>
      </type>
      <isModifier value="false"/>
    </element>
  </snapshot>
  <differential>
    <element id="DvProportion">
      <path value="DvProportion"/>
      <short value="Proportion"/>
      <definition value="openEHR Proportion"/>
    </element>
  </differential>
</StructureDefinition>