OpenEHR Base package
0.1.0 - First Draft
OpenEHR Base package
0.1.0 - First Draft
OpenEHR Base package, published by openEHR + HL7. 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/openehr-fhir/base-spec/ and changes regularly. See the Directory of published versions
| Page standards status: Informative | Maturity Level: 3 |
JSON representation of the DV-PROPORTION logical model.
{
"resourceType" : "StructureDefinition",
"id" : "DV-PROPORTION",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition DV-PROPORTION</b></p><a name=\"DV-PROPORTION\"> </a><a name=\"hcDV-PROPORTION\"> </a><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 & 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_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=\"StructureDefinition-DV-PROPORTION-definitions.html#DV_PROPORTION\" title=\"Models a ratio of values, i.e. where the numerator and denominator are both pure numbers. The `_valid_proportion_kind_` property of the `PROPORTION_KIND` class is used to control the type attribute to be one of a defined set.\n\nUsed for recording titers (e.g. 1:128), concentration ratios, e.g. Na:K (unitary denominator), albumin:creatinine ratio, and percentages, e.g. red cell distirbution width (RDW). \n \nMisuse: Should not be used to represent things like blood pressure which are often written using a '/' character, giving the misleading impression that the item is a ratio, when in fact it is a structured value. Similarly, visual acuity, often written as (e.g.) "6/24" in clinical notes is not a ratio but an ordinal (which includes non-numeric symbols like CF = count fingers etc). Should not be used for formulations. \">DV_PROPORTION</a><a name=\"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\"><a style=\"padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;\" href=\"http://hl7.org/fhir/R5/conformance-rules.html#constraints\" title=\"This element has or is affected by constraints ( Type_validity, Precision_validity, Is_integral_validity, Fraction_validity, Unitary_validity, Percent_validity, Valid_denominator )\">C</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\">0..*</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=\"StructureDefinition-PROPORTION-KIND.html\">PROPORTION_KIND</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\">Models a ratio of values, i.<br/><br/>Elements defined in Ancestors:<a href=\"http://hl7.org/fhir/R5/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=\"http://hl7.org/fhir/R5/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>, <a href=\"http://hl7.org/fhir/R5/datatypes.html#string\" title=\"Primitive value for string\">@value</a>, <a href=\"http://hl7.org/fhir/R5/datatypes.html#code\" title=\"Primitive value for code\">@value</a><br/><span style=\"font-weight:bold\">Instances of this logical model are not marked to be the target of a Reference</span><br class=\"constraint\"/><span title=\"null\" class=\"constraint\">Constraints: </span><span style=\"font-weight:bold\" title=\"Type validity\" class=\"constraint\">Type_validity</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"Precision validity must satisfy conditional constraints\" class=\"constraint\">Precision_validity</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"Is integral validity must satisfy conditional constraints\" class=\"constraint\">Is_integral_validity</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"Fraction validity must satisfy conditional constraints\" class=\"constraint\">Fraction_validity</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"Unitary validity must satisfy conditional constraints\" class=\"constraint\">Unitary_validity</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"Percent validity must satisfy conditional constraints\" class=\"constraint\">Percent_validity</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"Valid denominator\" class=\"constraint\">Valid_denominator</span><br/></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,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_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-DV-PROPORTION-definitions.html#DV_PROPORTION.numerator\" title=\"Numerator of ratio\">numerator</a><a name=\"DV_PROPORTION.numerator\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#decimal\">decimal</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Numerator of ratio</td></tr>\r\n<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_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_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-DV-PROPORTION-definitions.html#DV_PROPORTION.denominator\" title=\"Denominator of ratio.\">denominator</a><a name=\"DV_PROPORTION.denominator\"> </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\">1..1</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=\"http://hl7.org/fhir/R5/datatypes.html#decimal\">decimal</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\">Denominator of ratio.</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,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_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-DV-PROPORTION-definitions.html#DV_PROPORTION.type\" title=\"Indicates semantic type of proportion, including percent, unitary etc.\">type</a><a name=\"DV_PROPORTION.type\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#integer\">integer</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Indicates semantic type of proportion, including percent, unitary etc.</td></tr>\r\n<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_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_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-DV-PROPORTION-definitions.html#DV_PROPORTION.precision\" 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 name=\"DV_PROPORTION.precision\"> </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\">0..1</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=\"http://hl7.org/fhir/R5/datatypes.html#integer\">integer</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\">Precision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places.</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,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_resource.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-DV-PROPORTION-definitions.html#DV_PROPORTION.normal-range\" title=\"Optional normal range. \">normal_range</a><a name=\"DV_PROPORTION.normal_range\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-DV-INTERVAL.html\">DV_INTERVAL</a><<a href=\"StructureDefinition-DV-PROPORTION.html\">DV_PROPORTION</a>></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Optional normal range.</td></tr>\r\n<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_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_resource.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-DV-PROPORTION-definitions.html#DV_PROPORTION.other-reference-ranges\" title=\"Optional tagged other reference ranges for this value in its particular measurement context.\">other_reference_ranges</a><a name=\"DV_PROPORTION.other_reference_ranges\"> </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\">0..*</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=\"StructureDefinition-REFERENCE-RANGE.html\">REFERENCE_RANGE</a><<a href=\"StructureDefinition-DV-PROPORTION.html\">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\">Optional tagged other reference ranges for this value in its particular measurement context.<br/></td></tr>\r\n<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>"
},
"contained" : [
{
"resourceType" : "OperationDefinition",
"id" : "magnitude",
"name" : "magnitude",
"title" : "magnitude",
"status" : "active",
"kind" : "operation",
"description" : "Effective magnitude represented by ratio.",
"code" : "magnitude",
"system" : false,
"instance" : true,
"parameter" : [
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"type" : "decimal"
}
]
},
{
"resourceType" : "OperationDefinition",
"id" : "is_integral",
"name" : "is_integral",
"title" : "is_integral",
"status" : "active",
"kind" : "operation",
"description" : "True if the `_numerator_` and `_denominator_` values are integers, i.e. if `_precision_` is 0.",
"code" : "is_integral",
"system" : false,
"instance" : true,
"parameter" : [
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"type" : "boolean"
}
]
},
{
"resourceType" : "OperationDefinition",
"id" : "add",
"name" : "add",
"title" : "add",
"status" : "active",
"kind" : "operation",
"description" : "Sum of two strictly comparable proportions.",
"code" : "add",
"system" : false,
"instance" : true,
"parameter" : [
{
"name" : "other",
"use" : "in",
"min" : 1,
"max" : "1",
"type" : "decimal"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"type" : "decimal"
}
]
},
{
"resourceType" : "OperationDefinition",
"id" : "subtract",
"name" : "subtract",
"title" : "subtract",
"status" : "active",
"kind" : "operation",
"description" : "Difference between two strictly comparable proportions.",
"code" : "subtract",
"system" : false,
"instance" : true,
"parameter" : [
{
"name" : "other",
"use" : "in",
"min" : 1,
"max" : "1",
"type" : "decimal"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"type" : "decimal"
}
]
},
{
"resourceType" : "OperationDefinition",
"id" : "is_equal",
"name" : "is_equal",
"title" : "is_equal",
"status" : "active",
"kind" : "operation",
"description" : "Return True if this `DV_AMOUNT` is considered equal to `_other_`.",
"code" : "is_equal",
"system" : false,
"instance" : true,
"parameter" : [
{
"name" : "other",
"use" : "in",
"min" : 1,
"max" : "1",
"type" : "decimal"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"type" : "boolean"
}
]
},
{
"resourceType" : "OperationDefinition",
"id" : "multiply",
"name" : "multiply",
"title" : "multiply",
"status" : "active",
"kind" : "operation",
"description" : "Product of this Proportion and `_factor_`.",
"code" : "multiply",
"system" : false,
"instance" : true,
"parameter" : [
{
"name" : "factor",
"use" : "in",
"min" : 1,
"max" : "1",
"type" : "decimal"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"type" : "decimal"
}
]
},
{
"resourceType" : "OperationDefinition",
"id" : "less_than",
"name" : "less_than",
"title" : "less_than",
"status" : "active",
"kind" : "operation",
"description" : "True if this Proportion is less than `_other_`. Only valid if `_is_strictly_comparable_to()_` is True.",
"code" : "less_than",
"system" : false,
"instance" : true,
"parameter" : [
{
"name" : "other",
"use" : "in",
"min" : 1,
"max" : "1",
"type" : "decimal"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"type" : "boolean"
}
]
},
{
"resourceType" : "OperationDefinition",
"id" : "is_strictly_comparable_to",
"name" : "is_strictly_comparable_to",
"title" : "is_strictly_comparable_to",
"status" : "active",
"kind" : "operation",
"description" : "Return True if the `_type_` of this proportion is the same as the `_type_` of `_other_`.",
"code" : "is_strictly_comparable_to",
"system" : false,
"instance" : true,
"parameter" : [
{
"name" : "other",
"use" : "in",
"min" : 1,
"max" : "1",
"type" : "Parameters"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"type" : "boolean"
}
]
}
],
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/web-source",
"valueUrl" : "https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_dv_proportion_class"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical" : "#magnitude"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical" : "#is_integral"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical" : "#add"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical" : "#subtract"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical" : "#is_equal"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical" : "#multiply"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical" : "#less_than"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical" : "#is_strictly_comparable_to"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode" : "can-bind"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3,
"_valueInteger" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://openehr.org/fhir/ImplementationGuide/openehr.base"
}
]
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "informative",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://openehr.org/fhir/ImplementationGuide/openehr.base"
}
]
}
}
],
"url" : "http://openehr.org/fhir/StructureDefinition/DV-PROPORTION",
"version" : "0.1.0",
"name" : "DV_PROPORTION",
"title" : "DV_PROPORTION",
"status" : "active",
"experimental" : false,
"date" : "2025-09-06T15:35:39+10:00",
"publisher" : "openEHR + HL7",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.openehr.org"
}
]
}
],
"description" : "Models a ratio of values, i.e. where the numerator and denominator are both pure numbers. The `_valid_proportion_kind_` property of the `PROPORTION_KIND` class is used to control the type attribute to be one of a defined set.\n\nUsed for recording titers (e.g. 1:128), concentration ratios, e.g. Na:K (unitary denominator), albumin:creatinine ratio, and percentages, e.g. red cell distirbution width (RDW). \n \nMisuse: Should not be used to represent things like blood pressure which are often written using a '/' character, giving the misleading impression that the item is a ratio, when in fact it is a structured value. Similarly, visual acuity, often written as (e.g.) \"6/24\" in clinical notes is not a ratio but an ordinal (which includes non-numeric symbols like CF = count fingers etc). Should not be used for formulations. ",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"fhirVersion" : "5.0.0",
"kind" : "logical",
"abstract" : false,
"type" : "http://openehr.org/fhir/StructureDefinition/DV_PROPORTION",
"baseDefinition" : "http://openehr.org/fhir/StructureDefinition/PROPORTION-KIND",
"derivation" : "specialization",
"snapshot" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString" : "0.1.0"
}
],
"element" : [
{
"id" : "DV_PROPORTION",
"path" : "DV_PROPORTION",
"short" : "Models a ratio of values, i.",
"definition" : "Models a ratio of values, i.e. where the numerator and denominator are both pure numbers. The `_valid_proportion_kind_` property of the `PROPORTION_KIND` class is used to control the type attribute to be one of a defined set.\n\nUsed for recording titers (e.g. 1:128), concentration ratios, e.g. Na:K (unitary denominator), albumin:creatinine ratio, and percentages, e.g. red cell distirbution width (RDW). \n \nMisuse: Should not be used to represent things like blood pressure which are often written using a '/' character, giving the misleading impression that the item is a ratio, when in fact it is a structured value. Similarly, visual acuity, often written as (e.g.) \"6/24\" in clinical notes is not a ratio but an ordinal (which includes non-numeric symbols like CF = count fingers etc). Should not be used for formulations. ",
"min" : 0,
"max" : "*",
"base" : {
"path" : "code",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "Type_validity",
"severity" : "error",
"human" : "Type validity",
"expression" : "null # TODO: manual translation needed"
},
{
"key" : "Precision_validity",
"severity" : "error",
"human" : "Precision validity must satisfy conditional constraints",
"expression" : "precision = 0 implies is_integral()"
},
{
"key" : "Is_integral_validity",
"severity" : "error",
"human" : "Is integral validity must satisfy conditional constraints",
"expression" : "is_integral() implies (numerator.floor = numerator and denominator.floor = denominator)"
},
{
"key" : "Fraction_validity",
"severity" : "error",
"human" : "Fraction validity must satisfy conditional constraints",
"expression" : "(type = pk_fraction or type = pk_integer_fraction) implies is_integral()"
},
{
"key" : "Unitary_validity",
"severity" : "error",
"human" : "Unitary validity must satisfy conditional constraints",
"expression" : "null # TODO: manual translation needed"
},
{
"key" : "Percent_validity",
"severity" : "error",
"human" : "Percent validity must satisfy conditional constraints",
"expression" : "null # TODO: manual translation needed"
},
{
"key" : "Valid_denominator",
"severity" : "error",
"human" : "Valid denominator",
"expression" : "null # TODO: manual translation needed"
}
],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "DV_PROPORTION.id",
"path" : "DV_PROPORTION.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "DV_PROPORTION.extension",
"path" : "DV_PROPORTION.extension",
"short" : "Additional content defined by implementations",
"definition" : "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" : "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" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "DV_PROPORTION.value",
"path" : "DV_PROPORTION.value",
"representation" : [
"xmlAttr"
],
"short" : "Primitive value for code",
"definition" : "Primitive value for code",
"min" : 0,
"max" : "1",
"base" : {
"path" : "string.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "code"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/regex",
"valueString" : "[^\\s]+( [^\\s]+)*"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "DV_PROPORTION.numerator",
"path" : "DV_PROPORTION.numerator",
"short" : "Numerator of ratio",
"definition" : "Numerator of ratio",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DV_PROPORTION.numerator",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "decimal"
}
],
"isModifier" : false
},
{
"id" : "DV_PROPORTION.denominator",
"path" : "DV_PROPORTION.denominator",
"short" : "Denominator of ratio.",
"definition" : "Denominator of ratio.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DV_PROPORTION.denominator",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "decimal"
}
],
"isModifier" : false
},
{
"id" : "DV_PROPORTION.type",
"path" : "DV_PROPORTION.type",
"short" : "Indicates semantic type of proportion, including percent, unitary etc.",
"definition" : "Indicates semantic type of proportion, including percent, unitary etc.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DV_PROPORTION.type",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "integer"
}
],
"isModifier" : false
},
{
"id" : "DV_PROPORTION.precision",
"path" : "DV_PROPORTION.precision",
"short" : "Precision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places.",
"definition" : "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" : 0,
"max" : "1",
"base" : {
"path" : "DV_PROPORTION.precision",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "integer"
}
],
"isModifier" : false
},
{
"id" : "DV_PROPORTION.normal-range",
"path" : "DV_PROPORTION.normal_range",
"short" : "Optional normal range.",
"definition" : "Optional normal range.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DV_PROPORTION.normal_range",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"extension" : [
{
"url" : "name",
"valueCode" : "T"
},
{
"url" : "type",
"valueUri" : "http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
}
],
"code" : "http://openehr.org/fhir/StructureDefinition/DV-INTERVAL"
}
],
"isModifier" : false
},
{
"id" : "DV_PROPORTION.other-reference-ranges",
"path" : "DV_PROPORTION.other_reference_ranges",
"short" : "Optional tagged other reference ranges for this value in its particular measurement context.",
"definition" : "Optional tagged other reference ranges for this value in its particular measurement context.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "DV_PROPORTION.other_reference_ranges",
"min" : 0,
"max" : "*"
},
"type" : [
{
"extension" : [
{
"extension" : [
{
"url" : "name",
"valueCode" : "T"
},
{
"url" : "type",
"valueUri" : "http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
}
],
"code" : "http://openehr.org/fhir/StructureDefinition/REFERENCE-RANGE"
}
],
"isModifier" : false
}
]
},
"differential" : {
"element" : [
{
"id" : "DV_PROPORTION",
"path" : "DV_PROPORTION",
"short" : "Models a ratio of values, i.",
"definition" : "Models a ratio of values, i.e. where the numerator and denominator are both pure numbers. The `_valid_proportion_kind_` property of the `PROPORTION_KIND` class is used to control the type attribute to be one of a defined set.\n\nUsed for recording titers (e.g. 1:128), concentration ratios, e.g. Na:K (unitary denominator), albumin:creatinine ratio, and percentages, e.g. red cell distirbution width (RDW). \n \nMisuse: Should not be used to represent things like blood pressure which are often written using a '/' character, giving the misleading impression that the item is a ratio, when in fact it is a structured value. Similarly, visual acuity, often written as (e.g.) \"6/24\" in clinical notes is not a ratio but an ordinal (which includes non-numeric symbols like CF = count fingers etc). Should not be used for formulations. ",
"min" : 0,
"max" : "*",
"constraint" : [
{
"key" : "Type_validity",
"severity" : "error",
"human" : "Type validity",
"expression" : "null # TODO: manual translation needed"
},
{
"key" : "Precision_validity",
"severity" : "error",
"human" : "Precision validity must satisfy conditional constraints",
"expression" : "precision = 0 implies is_integral()"
},
{
"key" : "Is_integral_validity",
"severity" : "error",
"human" : "Is integral validity must satisfy conditional constraints",
"expression" : "is_integral() implies (numerator.floor = numerator and denominator.floor = denominator)"
},
{
"key" : "Fraction_validity",
"severity" : "error",
"human" : "Fraction validity must satisfy conditional constraints",
"expression" : "(type = pk_fraction or type = pk_integer_fraction) implies is_integral()"
},
{
"key" : "Unitary_validity",
"severity" : "error",
"human" : "Unitary validity must satisfy conditional constraints",
"expression" : "null # TODO: manual translation needed"
},
{
"key" : "Percent_validity",
"severity" : "error",
"human" : "Percent validity must satisfy conditional constraints",
"expression" : "null # TODO: manual translation needed"
},
{
"key" : "Valid_denominator",
"severity" : "error",
"human" : "Valid denominator",
"expression" : "null # TODO: manual translation needed"
}
],
"isModifier" : false
},
{
"id" : "DV_PROPORTION.numerator",
"path" : "DV_PROPORTION.numerator",
"short" : "Numerator of ratio",
"definition" : "Numerator of ratio",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "decimal"
}
],
"isModifier" : false
},
{
"id" : "DV_PROPORTION.denominator",
"path" : "DV_PROPORTION.denominator",
"short" : "Denominator of ratio.",
"definition" : "Denominator of ratio.",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "decimal"
}
],
"isModifier" : false
},
{
"id" : "DV_PROPORTION.type",
"path" : "DV_PROPORTION.type",
"short" : "Indicates semantic type of proportion, including percent, unitary etc.",
"definition" : "Indicates semantic type of proportion, including percent, unitary etc.",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "integer"
}
],
"isModifier" : false
},
{
"id" : "DV_PROPORTION.precision",
"path" : "DV_PROPORTION.precision",
"short" : "Precision to which the `_numerator_` and `_denominator_` values of the proportion are expressed, in terms of number of decimal places.",
"definition" : "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" : 0,
"max" : "1",
"type" : [
{
"code" : "integer"
}
],
"isModifier" : false
},
{
"id" : "DV_PROPORTION.normal-range",
"path" : "DV_PROPORTION.normal_range",
"short" : "Optional normal range.",
"definition" : "Optional normal range. ",
"min" : 0,
"max" : "1",
"type" : [
{
"extension" : [
{
"extension" : [
{
"url" : "name",
"valueCode" : "T"
},
{
"url" : "type",
"valueUri" : "http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
}
],
"code" : "http://openehr.org/fhir/StructureDefinition/DV-INTERVAL"
}
],
"isModifier" : false
},
{
"id" : "DV_PROPORTION.other-reference-ranges",
"path" : "DV_PROPORTION.other_reference_ranges",
"short" : "Optional tagged other reference ranges for this value in its particular measurement context.",
"definition" : "Optional tagged other reference ranges for this value in its particular measurement context.",
"min" : 0,
"max" : "*",
"type" : [
{
"extension" : [
{
"extension" : [
{
"url" : "name",
"valueCode" : "T"
},
{
"url" : "type",
"valueUri" : "http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
}
],
"code" : "http://openehr.org/fhir/StructureDefinition/REFERENCE-RANGE"
}
],
"isModifier" : false
}
]
}
}