| Package | openehr.base |
| Type | StructureDefinition |
| Id | DV-QUANTITY |
| FHIR Version | R5 |
| Source | http://openehr.org/fhir/https://build.fhir.org/ig/FHIR/openehr-base-ig/StructureDefinition-DV-QUANTITY.html |
| URL | http://openehr.org/fhir/StructureDefinition/DV-QUANTITY |
| Version | 0.1.0 |
| Status | active |
| Date | 2023-06-27T18:45:58+10:00 |
| Name | DV_QUANTITY |
| Title | DV_QUANTITY |
| Realm | uv |
| Authority | hl7 |
| Description | Quantitified type representing scientific quantities, i.e. quantities expressed as a magnitude and units. Units are expressed in the UCUM syntax (Unified Code for Units of Measure (UCUM), by Gunther Schadow and Clement J. McDonald of The Regenstrief Institute) (case-sensitive form) by default, or another system if units_system is set. Can also be used for time durations, where it is more convenient to treat these as simply a number of seconds rather than days, months, years (in the latter case, DV_DURATION may be used). |
| Type | http://openehr.org/fhir/StructureDefinition/DV_QUANTITY |
| Kind | logical |
No resources found
| StructureDefinition | |
| DV-AMOUNT | DV_AMOUNT |
| DV-INTERVAL | DV_INTERVAL |
| REFERENCE-RANGE | REFERENCE_RANGE |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition DV-QUANTITY
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DV_QUANTITY | 0..* | DV_AMOUNT | Elements defined in Ancestors:normal_status, normal_range, other_reference_ranges, magnitude_status, accuracy, accuracy_is_percent, accuracy Quantitified type representing scientific quantities, i.e. quantities expressed as a magnitude and units | |
  magnitude | 1..1 | decimal | Numeric magnitude of the quantity | |
| precision | 0..1 | integer | Precision to which the value of the quantity is 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 | |
| units | 1..1 | string | Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in units_system, when set | |
| units_system | 0..1 | string | URI identifying a terminology containing units concepts (from the FHIR terminologies list). UCUM is default | |
| units_display_name | 0..1 | string | Optional field containing the displayable form of the units field, e.g. '°C' | |
 normal_range | 0..1 | DV_INTERVAL<DV_PROPORTION> | Optional normal range | |
 other_reference_ranges | 0..* | REFERENCE_RANGE<DV_PROPORTION> | Optional tagged other reference ranges for this value in its particular measurement context | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "DV-QUANTITY",
"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_quantity_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-QUANTITY",
"version": "0.1.0",
"name": "DV_QUANTITY",
"title": "DV_QUANTITY",
"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": "Quantitified type representing scientific quantities, i.e. quantities expressed as a magnitude and units. Units are expressed in the UCUM syntax (Unified Code for Units of Measure (UCUM), by Gunther Schadow and Clement J. McDonald of The Regenstrief Institute) (case-sensitive form) by default, or another system if units_system is set.\r\n\r\nCan also be used for time durations, where it is more convenient to treat these as simply a number of seconds rather than days, months, years (in the latter case, DV_DURATION may be used).",
"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_QUANTITY",
"baseDefinition": "http://openehr.org/fhir/StructureDefinition/DV-AMOUNT",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "0.1.0"
}
],
"element": [
{
"id": "DV_QUANTITY",
"path": "DV_QUANTITY",
"short": "Quantitified type representing scientific quantities, i.e. quantities expressed as a magnitude and units",
"definition": "Quantitified type representing scientific quantities, i.e. quantities expressed as a magnitude and units. Units are expressed in the UCUM syntax (Unified Code for Units of Measure (UCUM), by Gunther Schadow and Clement J. McDonald of The Regenstrief Institute) (case-sensitive form) by default, or another system if units_system is set.\r\n\r\nCan also be used for time durations, where it is more convenient to treat these as simply a number of seconds rather than days, months, years (in the latter case, DV_DURATION may be used).",
"comment": "For scores that include only Integers, DV_QUANTIFIED may also be used, but DV_ORDINAL should be supported to accommodate existing data instances of that type.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DV_QUANTITY.normal-status",
"path": "DV_QUANTITY.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_QUANTITY.normal-range",
"path": "DV_QUANTITY.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-PROPORTION"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
}
],
"code": "http://openehr.org/fhir/StructureDefinition/DV-INTERVAL"
}
],
"isModifier": false
},
{
"id": "DV_QUANTITY.other-reference-ranges",
"path": "DV_QUANTITY.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-PROPORTION"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
}
],
"code": "http://openehr.org/fhir/StructureDefinition/REFERENCE-RANGE"
}
],
"isModifier": false
},
{
"id": "DV_QUANTITY.magnitude-status",
"path": "DV_QUANTITY.magnitude_status",
"short": "Optional status of magnitude: =, <, >, <=, >=, ~",
"definition": "Optional status of magnitude with values:\r\n* '=' : magnitude is a point value\r\n* '<' : value is < magnitude\r\n* '>' : value is > magnitude\r\n* '<=' : value is <= magnitude\r\n* '>=' : value is >= magnitude\r\n* '~' : value is approximately magnitude\r\n\r\nIf not present, assumed meaning is '=' .",
"min": 0,
"max": "1",
"base": {
"path": "DV_QUANTIFIED.magnitude_status",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"id": "DV_QUANTITY.accuracy",
"path": "DV_QUANTITY.accuracy",
"short": "Accuracy of measurement, expressed either as a half-range percent value (accuracy_is_percent = True) or a half-range quantity",
"definition": "Accuracy of measurement, expressed either as a half-range percent value (accuracy_is_percent = True) or a half-range quantity. A value of 0 means that accuracy is 100%, i.e. no error.\r\n\r\nA value of unknown_accuracy_value means that accuracy was not recorded.",
"min": 0,
"max": "1",
"base": {
"path": "DV_QUANTIFIED.accuracy",
"min": 0,
"max": "1"
},
"type": [
{
"code": "decimal"
}
],
"isModifier": false
},
{
"id": "DV_QUANTITY.accuracy-is-percent",
"path": "DV_QUANTITY.accuracy_is_percent",
"short": "If True, indicates that when this object was created, accuracy was recorded as a percent value; if False, as an absolute quantity value",
"definition": "If True, indicates that when this object was created, accuracy was recorded as a percent value; if False, as an absolute quantity value.",
"min": 0,
"max": "1",
"base": {
"path": "DV_AMOUNT.accuracy_is_percent",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false
},
{
"id": "DV_QUANTITY.magnitude",
"path": "DV_QUANTITY.magnitude",
"short": "Numeric magnitude of the quantity",
"definition": "Numeric magnitude of the quantity.",
"min": 1,
"max": "1",
"base": {
"path": "DV_QUANTITY.magnitude",
"min": 1,
"max": "1"
},
"type": [
{
"code": "decimal"
}
],
"isModifier": false
},
{
"id": "DV_QUANTITY.precision",
"path": "DV_QUANTITY.precision",
"short": "Precision to which the value of the quantity is 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",
"definition": "Precision to which the value of the quantity is 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_QUANTITY.precision",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
],
"isModifier": false
},
{
"id": "DV_QUANTITY.units",
"path": "DV_QUANTITY.units",
"short": "Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in units_system, when set",
"definition": "Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in units_system, when set.\r\n\r\nIn either case, the value is the code or syntax - normally formed of standard ASCII - which is in principal not the same as the display string, although in simple cases such as 'm' (for meters) it will be.\r\n\r\nIf the units_display_name field is set, this may be used for display. If not, the implementations must effect the resolution of the units value to a display form locally, e.g. by lookup of reference tables, request to a terminology service etc.\r\n\r\n\r\nExample values from UCUM: 'kg/m^2', 'mm[Hg]', 'ms-1', 'km/h'",
"min": 1,
"max": "1",
"base": {
"path": "DV_QUANTITY.units",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"id": "DV_QUANTITY.units-system",
"path": "DV_QUANTITY.units_system",
"short": "URI identifying a terminology containing units concepts (from the FHIR terminologies list). UCUM is default",
"definition": "Optional field used to specify a units system from which codes in units are defined. Value is a URI identifying a terminology containing units concepts from the (HL7 FHIR terminologies list).\r\n\r\nIf not set, the UCUM standard (case-sensitive codes) is assumed as the units system.",
"min": 0,
"max": "1",
"base": {
"path": "DV_QUANTITY.units_system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"id": "DV_QUANTITY.units-display-name",
"path": "DV_QUANTITY.units_display_name",
"short": "Optional field containing the displayable form of the units field, e.g. '°C'",
"definition": "Optional field containing the displayable form of the units field, e.g. '°C'.\r\n\r\nIf not set, the application environment needs to determine the displayable form.",
"comment": "The display name may be language-dependent for various older and non-systematic units. For this reason, it is not recommended to add unit display names to archetypes, only to templates (for localisation purposes).",
"min": 0,
"max": "1",
"base": {
"path": "DV_QUANTITY.units_display_name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false
}
]
},
"differential": {
"element": [
{
"id": "DV_QUANTITY",
"path": "DV_QUANTITY",
"short": "Quantitified type representing scientific quantities, i.e. quantities expressed as a magnitude and units",
"definition": "Quantitified type representing scientific quantities, i.e. quantities expressed as a magnitude and units. Units are expressed in the UCUM syntax (Unified Code for Units of Measure (UCUM), by Gunther Schadow and Clement J. McDonald of The Regenstrief Institute) (case-sensitive form) by default, or another system if units_system is set.\r\n\r\nCan also be used for time durations, where it is more convenient to treat these as simply a number of seconds rather than days, months, years (in the latter case, DV_DURATION may be used).",
"min": 0,
"max": "*",
"isModifier": false
},
{
"id": "DV_QUANTITY.magnitude",
"path": "DV_QUANTITY.magnitude",
"short": "Numeric magnitude of the quantity",
"definition": "Numeric magnitude of the quantity.",
"min": 1,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isModifier": false
},
{
"id": "DV_QUANTITY.precision",
"path": "DV_QUANTITY.precision",
"short": "Precision to which the value of the quantity is 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",
"definition": "Precision to which the value of the quantity is 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",
"type": [
{
"code": "integer"
}
],
"isModifier": false
},
{
"id": "DV_QUANTITY.units",
"path": "DV_QUANTITY.units",
"short": "Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in units_system, when set",
"definition": "Quantity units, expressed as a code or syntax string from either UCUM (the default) or the units system specified in units_system, when set.\r\n\r\nIn either case, the value is the code or syntax - normally formed of standard ASCII - which is in principal not the same as the display string, although in simple cases such as 'm' (for meters) it will be.\r\n\r\nIf the units_display_name field is set, this may be used for display. If not, the implementations must effect the resolution of the units value to a display form locally, e.g. by lookup of reference tables, request to a terminology service etc.\r\n\r\n\r\nExample values from UCUM: 'kg/m^2', 'mm[Hg]', 'ms-1', 'km/h'",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"id": "DV_QUANTITY.units-system",
"path": "DV_QUANTITY.units_system",
"short": "URI identifying a terminology containing units concepts (from the FHIR terminologies list). UCUM is default",
"definition": "Optional field used to specify a units system from which codes in units are defined. Value is a URI identifying a terminology containing units concepts from the (HL7 FHIR terminologies list).\r\n\r\nIf not set, the UCUM standard (case-sensitive codes) is assumed as the units system.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"id": "DV_QUANTITY.units-display-name",
"path": "DV_QUANTITY.units_display_name",
"short": "Optional field containing the displayable form of the units field, e.g. '°C'",
"definition": "Optional field containing the displayable form of the units field, e.g. '°C'.\r\n\r\nIf not set, the application environment needs to determine the displayable form.",
"comment": "The display name may be language-dependent for various older and non-systematic units. For this reason, it is not recommended to add unit display names to archetypes, only to templates (for localisation purposes).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"id": "DV_QUANTITY.normal-range",
"path": "DV_QUANTITY.normal_range",
"short": "Optional normal range",
"definition": "Optional 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": "DV_QUANTITY.other-reference-ranges",
"path": "DV_QUANTITY.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-PROPORTION"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
}
],
"code": "http://openehr.org/fhir/StructureDefinition/REFERENCE-RANGE"
}
],
"isModifier": false
}
]
}
}