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 - JSON Profile

Draft as of 2026-03-25

JSON representation of the DvProportion logical model.

Raw json | Download

{
  "resourceType" : "StructureDefinition",
  "id" : "DvProportion",
  "text" : {
    "status" : "extensions",
    "div" : "<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>\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>"
  },
  "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-type-characteristics",
      "valueCode" : "can-bind"
    }
  ],
  "url" : "https://ianbennett.github.io/ExampleIG_Ian/StructureDefinition/DvProportion",
  "version" : "0.1.0",
  "name" : "DvProportion",
  "status" : "draft",
  "date" : "2026-03-25T15:55:34+00:00",
  "publisher" : "Ian",
  "contact" : [
    {
      "name" : "Ian",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://example.org/example-publisher"
        }
      ]
    }
  ],
  "fhirVersion" : "4.0.1",
  "kind" : "logical",
  "abstract" : false,
  "type" : "https://ianbennett.github.io/ExampleIG_Ian/StructureDefinition/DvProportion",
  "baseDefinition" : "http://openehr.org/fhir/StructureDefinition/DV-PROPORTION",
  "derivation" : "specialization",
  "snapshot" : {
    "extension" : [
      {
        "url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString" : "0.1.0-snapshot"
      }
    ],
    "element" : [
      {
        "id" : "DvProportion",
        "path" : "DvProportion",
        "short" : "Proportion",
        "definition" : "openEHR Proportion",
        "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",
            "source" : "http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"
          },
          {
            "key" : "Precision_validity",
            "severity" : "error",
            "human" : "Precision validity must satisfy conditional constraints",
            "expression" : "precision = 0 implies is_integral()",
            "source" : "http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"
          },
          {
            "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)",
            "source" : "http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"
          },
          {
            "key" : "Fraction_validity",
            "severity" : "error",
            "human" : "Fraction validity must satisfy conditional constraints",
            "expression" : "(type = pk_fraction or type = pk_integer_fraction) implies is_integral()",
            "source" : "http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"
          },
          {
            "key" : "Unitary_validity",
            "severity" : "error",
            "human" : "Unitary validity must satisfy conditional constraints",
            "expression" : "null # TODO: manual translation needed",
            "source" : "http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"
          },
          {
            "key" : "Percent_validity",
            "severity" : "error",
            "human" : "Percent validity must satisfy conditional constraints",
            "expression" : "null # TODO: manual translation needed",
            "source" : "http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"
          },
          {
            "key" : "Valid_denominator",
            "severity" : "error",
            "human" : "Valid denominator",
            "expression" : "null # TODO: manual translation needed",
            "source" : "http://openehr.org/fhir/StructureDefinition/DV-PROPORTION"
          }
        ],
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "DvProportion.id",
        "path" : "DvProportion.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" : "DvProportion.extension",
        "path" : "DvProportion.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" : "DvProportion.value",
        "path" : "DvProportion.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" : "DvProportion.numerator",
        "path" : "DvProportion.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" : "DvProportion.denominator",
        "path" : "DvProportion.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" : "DvProportion.type",
        "path" : "DvProportion.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" : "DvProportion.precision",
        "path" : "DvProportion.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" : "DvProportion.normal-range",
        "path" : "DvProportion.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" : "DvProportion.other-reference-ranges",
        "path" : "DvProportion.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" : "DvProportion",
        "path" : "DvProportion",
        "short" : "Proportion",
        "definition" : "openEHR Proportion"
      }
    ]
  }
}