FHIR IG analytics| Package | openehr.base |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-DV-ORDERED.json |
| FHIR Version | R5 |
| Source | http://fhir.org/guides/openehr/base/0.1.0-snapshot/StructureDefinition-DV-ORDERED.html |
| URL | http://openehr.org/fhir/StructureDefinition/DV-ORDERED |
| Version | 0.1.0-snapshot |
| Status | active |
| Date | 2025-09-06T15:35:39+10:00 |
| Name | DV_ORDERED |
| Title | DV_ORDERED |
| Realm | uv |
| Authority | hl7 |
| Description | Abstract class defining the concept of ordered values, which includes ordinals as well as true quantities. It defines the functions `<` and `_is_strictly_comparable_to()_`, the latter of which must evaluate to `True` for instances being compared with the `<` function, or used as limits in the `DV_INTERVAL<T>` class. Data value types which are to be used as limits in the `DV_INTERVAL<T>` class must inherit from this class, and implement the function `_is_strictly_comparable_to()_` to ensure that instances compare meaningfully. For example, instances of `DV_QUANTITY` can only be compared if they measure the same kind of physical quantity. |
| Type | http://openehr.org/fhir/StructureDefinition/DV_ORDERED |
| Kind | logical |
| StructureDefinition | ||
| openehr.base#0.1.0-snapshot | DV-ORDINAL | DV_ORDINAL |
| openehr.base#0.1.0-snapshot | DV-QUANTIFIED | DV_QUANTIFIED |
| openehr.base#0.1.0-snapshot | DV-SCALE | DV_SCALE |
| StructureDefinition | ||
| openehr.base#0.1.0-snapshot | CODE-PHRASE | CODE_PHRASE |
| openehr.base#0.1.0-snapshot | DATA-VALUE | DATA_VALUE |
| openehr.base#0.1.0-snapshot | DV-INTERVAL | DV_INTERVAL |
| openehr.base#0.1.0-snapshot | REFERENCE-RANGE | REFERENCE_RANGE |
| ValueSet | ||
| openehr.base#0.1.0-snapshot | valueset-normal_statuses | Normal statuses |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition DV-ORDERED
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DV_ORDERED | C | 0..* | DATA_VALUE | This is an abstract type. Child types: DV_ORDINAL, DV_QUANTIFIED, DV_SCALE Abstract class defining the concept of ordered values, which includes ordinals as well as true quantities. Elements defined in Ancestors:CR, LF, Local_terminology_id Binding: Normal statuses (required) Constraints: Other_reference_ranges_validity, Is_simple_validity, Normal_range_and_status_consistency |
  normal_status | 0..1 | CODE_PHRASE | Optional normal status indicator of value with respect to normal range for this value. | |
| normal_range | 0..1 | DV_INTERVAL | Optional normal range. | |
 other_reference_ranges | 0..* | REFERENCE_RANGE<DV_ORDERED> | Optional tagged other reference ranges for this value in its particular measurement context. | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "DV-ORDERED",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"contained": [
{
"resourceType": "OperationDefinition",
"id": "is_strictly_comparable_to",
"name": "is_strictly_comparable_to",
"title": "is_strictly_comparable_to",
"status": "active",
"kind": "operation",
"description": "Test if two instances are strictly comparable. Effected in descendants.",
"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"
}
]
},
{
"resourceType": "OperationDefinition",
"id": "is_simple",
"name": "is_simple",
"title": "is_simple",
"status": "active",
"kind": "operation",
"description": "True if this quantity has no reference ranges.",
"code": "is_simple",
"system": false,
"instance": true,
"parameter": [
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"type": "boolean"
}
]
},
{
"resourceType": "OperationDefinition",
"id": "is_normal",
"name": "is_normal",
"title": "is_normal",
"status": "active",
"kind": "operation",
"description": "Value is in the normal range, determined by comparison of the value to `_normal_range_` if present, or by the `_normal_status_` marker if present. \n",
"code": "is_normal",
"system": false,
"instance": true,
"parameter": [
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"type": "boolean"
}
]
},
{
"resourceType": "OperationDefinition",
"id": "less_than",
"name": "less_than",
"title": "less_than",
"status": "active",
"kind": "operation",
"description": "True if this Ordered object is less than `_other_`. Redefined in descendants.",
"code": "less_than",
"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_ordered_class"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#is_strictly_comparable_to"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#is_simple"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#is_normal"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#less_than"
},
{
"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-ORDERED",
"version": "0.1.0-snapshot",
"name": "DV_ORDERED",
"title": "DV_ORDERED",
"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": "Abstract class defining the concept of ordered values, which includes ordinals as well as true quantities. It defines the functions `<` and `_is_strictly_comparable_to()_`, the latter of which must evaluate to `True` for instances being compared with the `<` function, or used as limits in the `DV_INTERVAL<T>` class. \n\nData value types which are to be used as limits in the `DV_INTERVAL<T>` class must inherit from this class, and implement the function `_is_strictly_comparable_to()_` to ensure that instances compare meaningfully. For example, instances of `DV_QUANTITY` can only be compared if they measure the same kind of physical quantity. \n",
"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": true,
"type": "http://openehr.org/fhir/StructureDefinition/DV_ORDERED",
"baseDefinition": "http://openehr.org/fhir/StructureDefinition/DATA-VALUE",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "0.1.0-snapshot"
}
],
"element": [
{
"id": "DV_ORDERED",
"path": "DV_ORDERED",
"short": "Abstract class defining the concept of ordered values, which includes ordinals as well as true quantities.",
"definition": "Abstract class defining the concept of ordered values, which includes ordinals as well as true quantities. It defines the functions `<` and `_is_strictly_comparable_to()_`, the latter of which must evaluate to `True` for instances being compared with the `<` function, or used as limits in the `DV_INTERVAL<T>` class. \n\nData value types which are to be used as limits in the `DV_INTERVAL<T>` class must inherit from this class, and implement the function `_is_strictly_comparable_to()_` to ensure that instances compare meaningfully. For example, instances of `DV_QUANTITY` can only be compared if they measure the same kind of physical quantity. \n",
"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()"
},
{
"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()"
},
{
"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))"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DV_ORDERED.CR",
"path": "DV_ORDERED.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_ORDERED.LF",
"path": "DV_ORDERED.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_ORDERED.Local-terminology-id",
"path": "DV_ORDERED.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_ORDERED.normal-status",
"path": "DV_ORDERED.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_ORDERED.normal-range",
"path": "DV_ORDERED.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_ORDERED.other-reference-ranges",
"path": "DV_ORDERED.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
}
]
},
"differential": {
"element": [
{
"id": "DV_ORDERED",
"path": "DV_ORDERED",
"short": "Abstract class defining the concept of ordered values, which includes ordinals as well as true quantities.",
"definition": "Abstract class defining the concept of ordered values, which includes ordinals as well as true quantities. It defines the functions `<` and `_is_strictly_comparable_to()_`, the latter of which must evaluate to `True` for instances being compared with the `<` function, or used as limits in the `DV_INTERVAL<T>` class. \n\nData value types which are to be used as limits in the `DV_INTERVAL<T>` class must inherit from this class, and implement the function `_is_strictly_comparable_to()_` to ensure that instances compare meaningfully. For example, instances of `DV_QUANTITY` can only be compared if they measure the same kind of physical quantity. \n",
"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()"
},
{
"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()"
},
{
"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))"
}
],
"isModifier": false,
"binding": {
"strength": "required",
"valueSet": "https://specifications.openehr.org/fhir/valueset-normal_statuses"
}
},
{
"id": "DV_ORDERED.normal-status",
"path": "DV_ORDERED.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",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
}
],
"isModifier": false
},
{
"id": "DV_ORDERED.normal-range",
"path": "DV_ORDERED.normal_range",
"short": "Optional normal range.",
"definition": "Optional normal range. ",
"min": 0,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-INTERVAL"
}
],
"isModifier": false
},
{
"id": "DV_ORDERED.other-reference-ranges",
"path": "DV_ORDERED.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-ORDERED"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
}
],
"code": "http://openehr.org/fhir/StructureDefinition/REFERENCE-RANGE"
}
],
"isModifier": false
}
]
}
}