| Package | openehr.base |
| Type | StructureDefinition |
| Id | DV-ORDINAL |
| FHIR Version | R5 |
| Source | http://openehr.org/fhir/https://build.fhir.org/ig/FHIR/openehr-base-ig/StructureDefinition-DV-ORDINAL.html |
| URL | http://openehr.org/fhir/StructureDefinition/DV-ORDINAL |
| Version | 0.1.0 |
| Status | active |
| Date | 2023-06-27T18:45:58+10:00 |
| Name | DV_ORDINAL |
| Title | DV_ORDINAL |
| Realm | uv |
| Authority | hl7 |
| Description | Generic class defining an interval (i.e. range) of a comparable type. An interval is a contiguous subrange of a comparable base type. Used to define intervals of dates, times, quantities (whose units match) and so on. The type parameter, T, must be a descendant of the type DV_ORDERED, which is necessary (but not sufficient) for instances to be compared (strictly_comparable is also needed). Without the DV_ORDINAL class, quite a few more DV_ classes would be needed to express logical intervals, namely interval versions of all the date/time classes, and of quantity classes. Further, it allows the semantics of intervals to be stated in one place unequivocally, including the conditions for strict comparison. |
| Type | http://openehr.org/fhir/StructureDefinition/DV_ORDINAL |
| Kind | logical |
No resources found
| StructureDefinition | |
| DV-CODED-TEXT | DV_CODED_TEXT |
| 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 | 0..* | DV_ORDERED | Elements defined in Ancestors:normal_status, normal_range, other_reference_ranges 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 | |
  symbol | 1..1 | DV_CODED_TEXT | Coded textual representation of this value in the enumeration | |
  value | 1..1 | integer | Value in ordered enumeration of values | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "DV-ORDINAL",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"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/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/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": "2023-06-27T18:45:58+10:00",
"publisher": "openEHR + HL7",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://www.openehr.org"
}
]
}
],
"description": "Generic class defining an interval (i.e. range) of a comparable type. An interval is a contiguous subrange of a comparable base type. Used to define intervals of dates, times, quantities (whose units match) and so on. The type parameter, T, must be a descendant of the type DV_ORDERED, which is necessary (but not sufficient) for instances to be compared (strictly_comparable is also needed).\r\n\r\nWithout the DV_ORDINAL class, quite a few more DV_ classes would be needed to express logical intervals, namely interval versions of all the date/time classes, and of quantity classes. Further, it allows the semantics of intervals to be stated in one place unequivocally, including the conditions for strict comparison.",
"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.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",
"definition": "A data type that represents integral score values, e.g. pain, Apgar values, etc, where there is:\r\n\r\na) 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.\r\n\r\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:\r\n\r\n-3, -2, -1, 0, 1, 2, 3 — reflex response values\r\n0, 1, 2 — Apgar values\r\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}.",
"comment": "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.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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,
"binding": {
"strength": "required",
"valueSet": "https://specifications.openehr.org/fhir/valueset-normal_statuses"
}
},
{
"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": [
{
"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/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",
"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.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",
"definition": "A data type that represents integral score values, e.g. pain, Apgar values, etc, where there is:\r\n\r\na) 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.\r\n\r\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:\r\n\r\n-3, -2, -1, 0, 1, 2, 3 — reflex response values\r\n0, 1, 2 — Apgar values\r\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}.",
"comment": "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.",
"min": 0,
"max": "*",
"isModifier": false
},
{
"id": "DV_ORDINAL.symbol",
"path": "DV_ORDINAL.symbol",
"short": "Coded textual representation of this value in the enumeration",
"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.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false
}
]
}
}