FHIR IG analytics| Package | openehr.base |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-DV-ORDINAL.json |
| FHIR Version | R5 |
| Source | http://fhir.org/guides/openehr/base/0.1.0-snapshot/StructureDefinition-DV-ORDINAL.html |
| URL | http://openehr.org/fhir/StructureDefinition/DV-ORDINAL |
| Version | 0.1.0-snapshot |
| Status | active |
| Date | 2025-09-06T15:35:39+10:00 |
| Name | DV_ORDINAL |
| Title | DV_ORDINAL |
| Realm | uv |
| Authority | hl7 |
| Description | A data type that represents integral score values, e.g. pain, Apgar values, etc, where there is: a) implied ordering, b) no implication that the distance between each value is constant, and c) the total number of values is finite; d) integer values only. Note 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: * -3, -2, -1, 0, 1, 2, 3 -- reflex response values * 0, 1, 2 -- Apgar values This 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}`. For 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. |
| Type | http://openehr.org/fhir/StructureDefinition/DV_ORDINAL |
| Kind | logical |
No resources found
| StructureDefinition | ||
| openehr.base#0.1.0-snapshot | DV-CODED-TEXT | DV_CODED_TEXT |
| openehr.base#0.1.0-snapshot | DV-ORDERED | DV_ORDERED |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition DV-ORDINAL
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DV_ORDINAL | C | 0..* | DV_ORDERED | A data type that represents integral score values, e. Elements defined in Ancestors:CR, LF, Local_terminology_id, normal_status, normal_range, other_reference_ranges Constraints: Limits_valid, Reference_range_valid |
  symbol | 1..1 | DV_CODED_TEXT | 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. | |
  value | 1..1 | integer | Value in ordered enumeration of values. | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "DV-ORDINAL",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"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-snapshot",
"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-snapshot"
}
],
"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
}
]
}
}