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-ORDINAL logical model.
{
"resourceType" : "StructureDefinition",
"id" : "DV-ORDINAL",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition DV-ORDINAL</b></p><a name=\"DV-ORDINAL\"> </a><a name=\"hcDV-ORDINAL\"> </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-ORDINAL-definitions.html#DV_ORDINAL\" title=\"A data type that represents integral score values, e.g. pain, Apgar values, etc, where there is:\n\na) implied ordering, \nb) no implication that the distance between each value is constant, and \nc) the total number of values is finite;\nd) integer values only.\n\nNote that although the term 'ordinal' in mathematics means natural numbers only, here any integer is allowed, since negative and zero values are often used by medical professionals for values around a neutral point. Examples of sets of ordinal values: \n\n* -3, -2, -1, 0, 1, 2, 3 -- reflex response values \n* 0, 1, 2 -- Apgar values \n\nThis class is used for recording any clinical datum which is customarily recorded using symbolic values. Example: the results on a urinalysis strip, e.g. `{neg, trace, +, ++, +++}` are used for leucocytes, protein, nitrites etc; for non-haemolysed blood `{neg, trace, moderate}`; for haemolysed blood `{small, moderate, large}`.\n\nFor scores or scales that include Real numbers (or might in the future, i.e. not fixed for all time, such as Apgar), use `DV_SCALE`. `DV_SCALE` may also be used in future for representing purely Integer-based scales, however, the `DV_ORDINAL` type should continue to be supported in software implementations in order to accommodate existing data that are instances of this type.\">DV_ORDINAL</a><a name=\"DV_ORDINAL\"> </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 ( Limits_valid, Reference_range_valid )\">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-DV-ORDERED.html\">DV_ORDERED</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 data type that represents integral score values, e.<br/><br/>Elements defined in Ancestors:<a href=\"StructureDefinition-BASIC-DEFINITIONS.html\" title=\"Carriage return character.\">CR</a>, <a href=\"StructureDefinition-BASIC-DEFINITIONS.html\" title=\"Line feed character.\">LF</a>, <a href=\"StructureDefinition-OPENEHR-DEFINITIONS.html\" title=\"Predefined terminology identifier to indicate it is local to the knowledge resource in which it occurs, e.g. an archetype\">Local_terminology_id</a>, <a href=\"StructureDefinition-DV-ORDERED.html\" title=\"Optional normal status indicator of value with respect to normal range for this value. Often included by lab, even if the normal range itself is not included. Coded by ordinals in series HHH, HH, H, (nothing), L, LL, LLL; see openEHR terminology group `normal_status`. \">normal_status</a>, <a href=\"StructureDefinition-DV-ORDERED.html\" title=\"Optional normal range. \">normal_range</a>, <a href=\"StructureDefinition-DV-ORDERED.html\" title=\"Optional tagged other reference ranges for this value in its particular measurement context.\">other_reference_ranges</a><br class=\"constraint\"/><span title=\"null\" class=\"constraint\">Constraints: </span><span style=\"font-weight:bold\" title=\"Limits valid\" class=\"constraint\">Limits_valid</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"Reference range valid\" class=\"constraint\">Reference_range_valid</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_resource.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-DV-ORDINAL-definitions.html#DV_ORDINAL.symbol\" title=\"Coded textual representation of this value in the enumeration, which may be strings made from + symbols, or other enumerations of terms such as `mild`, `moderate`, `severe`, or even the same number series as the values, e.g. 1, 2, 3.\">symbol</a><a name=\"DV_ORDINAL.symbol\"> </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=\"StructureDefinition-DV-CODED-TEXT.html\">DV_CODED_TEXT</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\">Coded textual representation of this value in the enumeration, which may be strings made from + symbols, or other enumerations of terms such as `mild`, `moderate`, `severe`, or even the same number series as the values, e.</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_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-DV-ORDINAL-definitions.html#DV_ORDINAL.value\" title=\"Value in ordered enumeration of values. Any integer value can be used. \n\">value</a><a name=\"DV_ORDINAL.value\"> </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#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\">Value in ordered enumeration of values.</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" : "less_than",
"name" : "less_than",
"title" : "less_than",
"status" : "active",
"kind" : "operation",
"description" : "True if this Ordinal value is less than `_other_`.",
"code" : "less_than",
"system" : false,
"instance" : true,
"parameter" : [
{
"name" : "other",
"use" : "in",
"min" : 1,
"max" : "1",
"type" : "integer"
},
{
"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" : "Test if this Ordinal is strictly comparable to `_other_`.",
"code" : "is_strictly_comparable_to",
"system" : false,
"instance" : true,
"parameter" : [
{
"name" : "other",
"use" : "in",
"min" : 1,
"max" : "1",
"type" : "integer"
},
{
"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_ordinal_class"
},
{
"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/tools/StructureDefinition/view-hint",
"valueCode" : "element-view-as-leaf"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
"valueCode" : "element-view-defns-parent"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
"valueCode" : "element-view-replace-cardinality"
},
{
"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-ORDINAL",
"version" : "0.1.0",
"name" : "DV_ORDINAL",
"title" : "DV_ORDINAL",
"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" : "A data type that represents integral score values, e.g. pain, Apgar values, etc, where there is:\n\na) implied ordering, \nb) no implication that the distance between each value is constant, and \nc) the total number of values is finite;\nd) integer values only.\n\nNote that although the term 'ordinal' in mathematics means natural numbers only, here any integer is allowed, since negative and zero values are often used by medical professionals for values around a neutral point. Examples of sets of ordinal values: \n\n* -3, -2, -1, 0, 1, 2, 3 -- reflex response values \n* 0, 1, 2 -- Apgar values \n\nThis class is used for recording any clinical datum which is customarily recorded using symbolic values. Example: the results on a urinalysis strip, e.g. `{neg, trace, +, ++, +++}` are used for leucocytes, protein, nitrites etc; for non-haemolysed blood `{neg, trace, moderate}`; for haemolysed blood `{small, moderate, large}`.\n\nFor scores or scales that include Real numbers (or might in the future, i.e. not fixed for all time, such as Apgar), use `DV_SCALE`. `DV_SCALE` may also be used in future for representing purely Integer-based scales, however, the `DV_ORDINAL` type should continue to be supported in software implementations in order to accommodate existing data that are instances of this type.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"fhirVersion" : "5.0.0",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "logical",
"abstract" : false,
"type" : "http://openehr.org/fhir/StructureDefinition/DV_ORDINAL",
"baseDefinition" : "http://openehr.org/fhir/StructureDefinition/DV-ORDERED",
"derivation" : "specialization",
"snapshot" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString" : "0.1.0"
}
],
"element" : [
{
"id" : "DV_ORDINAL",
"path" : "DV_ORDINAL",
"short" : "A data type that represents integral score values, e.",
"definition" : "A data type that represents integral score values, e.g. pain, Apgar values, etc, where there is:\n\na) implied ordering, \nb) no implication that the distance between each value is constant, and \nc) the total number of values is finite;\nd) integer values only.\n\nNote that although the term 'ordinal' in mathematics means natural numbers only, here any integer is allowed, since negative and zero values are often used by medical professionals for values around a neutral point. Examples of sets of ordinal values: \n\n* -3, -2, -1, 0, 1, 2, 3 -- reflex response values \n* 0, 1, 2 -- Apgar values \n\nThis class is used for recording any clinical datum which is customarily recorded using symbolic values. Example: the results on a urinalysis strip, e.g. `{neg, trace, +, ++, +++}` are used for leucocytes, protein, nitrites etc; for non-haemolysed blood `{neg, trace, moderate}`; for haemolysed blood `{small, moderate, large}`.\n\nFor scores or scales that include Real numbers (or might in the future, i.e. not fixed for all time, such as Apgar), use `DV_SCALE`. `DV_SCALE` may also be used in future for representing purely Integer-based scales, however, the `DV_ORDINAL` type should continue to be supported in software implementations in order to accommodate existing data that are instances of this type.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "Other_reference_ranges_validity",
"severity" : "error",
"human" : "Other reference ranges validity must be present",
"expression" : "other_reference_ranges.exists() implies other_reference_ranges.empty().not()",
"source" : "http://openehr.org/fhir/StructureDefinition/DV-ORDERED"
},
{
"key" : "Is_simple_validity",
"severity" : "error",
"human" : "Is simple validity must satisfy conditional constraints",
"expression" : "(normal_range .empty() and other_reference_ranges .empty()) implies is_simple()",
"source" : "http://openehr.org/fhir/StructureDefinition/DV-ORDERED"
},
{
"key" : "Normal_range_and_status_consistency",
"severity" : "error",
"human" : "Normal range and status consistency must be present",
"expression" : "(normal_range.exists() and normal_status.exists()) implies (normal_status.code_string.is_equal (“N”) xor normal_range.not().has (self))",
"source" : "http://openehr.org/fhir/StructureDefinition/DV-ORDERED"
},
{
"key" : "Limits_valid",
"severity" : "error",
"human" : "Limits valid",
"expression" : "null # TODO: manual translation needed"
},
{
"key" : "Reference_range_valid",
"severity" : "error",
"human" : "Reference range valid",
"expression" : "null # TODO: manual translation needed"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "DV_ORDINAL.CR",
"path" : "DV_ORDINAL.CR",
"short" : "Carriage return character.",
"definition" : "Carriage return character.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "BASIC_DEFINITIONS.CR",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false
},
{
"id" : "DV_ORDINAL.LF",
"path" : "DV_ORDINAL.LF",
"short" : "Line feed character.",
"definition" : "Line feed character.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "BASIC_DEFINITIONS.LF",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false
},
{
"id" : "DV_ORDINAL.Local-terminology-id",
"path" : "DV_ORDINAL.Local_terminology_id",
"short" : "Predefined terminology identifier",
"definition" : "Predefined terminology identifier to indicate it is local to the knowledge resource in which it occurs, e.g. an archetype",
"min" : 1,
"max" : "1",
"base" : {
"path" : "OPENEHR_DEFINITIONS.Local_terminology_id",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false
},
{
"id" : "DV_ORDINAL.normal-status",
"path" : "DV_ORDINAL.normal_status",
"short" : "Optional normal status indicator of value with respect to normal range for this value.",
"definition" : "Optional normal status indicator of value with respect to normal range for this value. Often included by lab, even if the normal range itself is not included. Coded by ordinals in series HHH, HH, H, (nothing), L, LL, LLL; see openEHR terminology group `normal_status`.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DV_ORDERED.normal_status",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
}
],
"isModifier" : false
},
{
"id" : "DV_ORDINAL.normal-range",
"path" : "DV_ORDINAL.normal_range",
"short" : "Optional normal range.",
"definition" : "Optional normal range.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "DV_ORDERED.normal_range",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/DV-INTERVAL"
}
],
"isModifier" : false
},
{
"id" : "DV_ORDINAL.other-reference-ranges",
"path" : "DV_ORDINAL.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_ORDERED.other_reference_ranges",
"min" : 0,
"max" : "*"
},
"type" : [
{
"extension" : [
{
"extension" : [
{
"url" : "name",
"valueCode" : "T"
},
{
"url" : "type",
"valueUri" : "http://openehr.org/fhir/StructureDefinition/DV-ORDERED"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
}
],
"code" : "http://openehr.org/fhir/StructureDefinition/REFERENCE-RANGE"
}
],
"isModifier" : false
},
{
"id" : "DV_ORDINAL.symbol",
"path" : "DV_ORDINAL.symbol",
"short" : "Coded textual representation of this value in the enumeration, which may be strings made from + symbols, or other enumerations of terms such as `mild`, `moderate`, `severe`, or even the same number series as the values, e.",
"definition" : "Coded textual representation of this value in the enumeration, which may be strings made from + symbols, or other enumerations of terms such as `mild`, `moderate`, `severe`, or even the same number series as the values, e.g. 1, 2, 3.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DV_ORDINAL.symbol",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT"
}
],
"isModifier" : false
},
{
"id" : "DV_ORDINAL.value",
"path" : "DV_ORDINAL.value",
"short" : "Value in ordered enumeration of values.",
"definition" : "Value in ordered enumeration of values. Any integer value can be used.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "DV_ORDINAL.value",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "integer"
}
],
"isModifier" : false
}
]
},
"differential" : {
"element" : [
{
"id" : "DV_ORDINAL",
"path" : "DV_ORDINAL",
"short" : "A data type that represents integral score values, e.",
"definition" : "A data type that represents integral score values, e.g. pain, Apgar values, etc, where there is:\n\na) implied ordering, \nb) no implication that the distance between each value is constant, and \nc) the total number of values is finite;\nd) integer values only.\n\nNote that although the term 'ordinal' in mathematics means natural numbers only, here any integer is allowed, since negative and zero values are often used by medical professionals for values around a neutral point. Examples of sets of ordinal values: \n\n* -3, -2, -1, 0, 1, 2, 3 -- reflex response values \n* 0, 1, 2 -- Apgar values \n\nThis class is used for recording any clinical datum which is customarily recorded using symbolic values. Example: the results on a urinalysis strip, e.g. `{neg, trace, +, ++, +++}` are used for leucocytes, protein, nitrites etc; for non-haemolysed blood `{neg, trace, moderate}`; for haemolysed blood `{small, moderate, large}`.\n\nFor scores or scales that include Real numbers (or might in the future, i.e. not fixed for all time, such as Apgar), use `DV_SCALE`. `DV_SCALE` may also be used in future for representing purely Integer-based scales, however, the `DV_ORDINAL` type should continue to be supported in software implementations in order to accommodate existing data that are instances of this type.",
"min" : 0,
"max" : "*",
"constraint" : [
{
"key" : "Limits_valid",
"severity" : "error",
"human" : "Limits valid",
"expression" : "null # TODO: manual translation needed"
},
{
"key" : "Reference_range_valid",
"severity" : "error",
"human" : "Reference range valid",
"expression" : "null # TODO: manual translation needed"
}
],
"isModifier" : false
},
{
"id" : "DV_ORDINAL.symbol",
"path" : "DV_ORDINAL.symbol",
"short" : "Coded textual representation of this value in the enumeration, which may be strings made from + symbols, or other enumerations of terms such as `mild`, `moderate`, `severe`, or even the same number series as the values, e.",
"definition" : "Coded textual representation of this value in the enumeration, which may be strings made from + symbols, or other enumerations of terms such as `mild`, `moderate`, `severe`, or even the same number series as the values, e.g. 1, 2, 3.",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT"
}
],
"isModifier" : false
},
{
"id" : "DV_ORDINAL.value",
"path" : "DV_ORDINAL.value",
"short" : "Value in ordered enumeration of values.",
"definition" : "Value in ordered enumeration of values. Any integer value can be used. \n",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "integer"
}
],
"isModifier" : false
}
]
}
}