{
"description": "RatioRange Type: A range of ratios expressed as a low and high numerator and a denominator.",
"_filename": "StructureDefinition-RatioRange.json",
"package_name": "hl7.fhir.r5.examples",
"date": "2023-03-01T23:03:57+11:00",
"derivation": "specialization",
"publisher": "HL7 FHIR Standard",
"fhirVersion": "5.0.0-draft-final",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"purpose": "Need to be able to specify ranges of ratios.",
"name": "RatioRange",
"mapping": [ {
"uri": "http://hl7.org/v2",
"name": "HL7 V2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "RatioRange",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": null,
"package_version": "5.0.0-draft-final",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ratrng-1",
"human": "One of lowNumerator or highNumerator and denominator SHALL be present, or all are absent. If all are absent, there SHALL be some extension present",
"source": "http://hl7.org/fhir/StructureDefinition/RatioRange",
"severity": "error",
"expression": "((lowNumerator.exists() or highNumerator.exists()) and denominator.exists()) or (lowNumerator.empty() and highNumerator.empty() and denominator.empty() and extension.exists())"
}, {
"key": "ratrng-2",
"human": "If present, lowNumerator SHALL have a lower value than highNumerator",
"source": "http://hl7.org/fhir/StructureDefinition/RatioRange",
"severity": "error",
"expression": "lowNumerator.hasValue().not() or highNumerator.hasValue().not() or (lowNumerator.lowBoundary() <= highNumerator.highBoundary())"
} ],
"path": "RatioRange",
"min": 0,
"definition": "A range of ratios expressed as a low and high numerator and a denominator.",
"isModifier": false,
"short": "Range of ratio values",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "NR and also possibly SN (but see also quantity)",
"identity": "v2"
}, {
"map": "IVL> [lowClosed=\"true\" and highClosed=\"true\"]or URG<>",
"identity": "rim"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "*",
"id": "RatioRange",
"comment": "The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.",
"base": {
"max": "*",
"min": 0,
"path": "RatioRange"
}
}, {
"path": "RatioRange.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "RatioRange.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "RatioRange.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "RatioRange.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RatioRange.lowNumerator",
"min": 0,
"definition": "The value of the low limit numerator.",
"isModifier": false,
"short": "Low Numerator limit",
"mapping": [ {
"map": "NR.1",
"identity": "v2"
}, {
"map": "./low",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"max": "1",
"id": "RatioRange.lowNumerator",
"condition": [ "ratrng-1", "ratrng-2" ],
"comment": "If the low element is missing, the low boundary is not known.",
"base": {
"max": "1",
"min": 0,
"path": "RatioRange.lowNumerator"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RatioRange.highNumerator",
"min": 0,
"definition": "The value of the high limit numerator.",
"isModifier": false,
"short": "High Numerator limit",
"mapping": [ {
"map": "NR.2",
"identity": "v2"
}, {
"map": "./high",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"max": "1",
"id": "RatioRange.highNumerator",
"condition": [ "ratrng-1", "ratrng-2" ],
"comment": "If the high element is missing, the high boundary is not known.",
"base": {
"max": "1",
"min": 0,
"path": "RatioRange.highNumerator"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "RatioRange.denominator",
"min": 0,
"definition": "The value of the denominator.",
"isModifier": false,
"short": "Denominator value",
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"max": "1",
"id": "RatioRange.denominator",
"condition": [ "ratrng-1" ],
"base": {
"max": "1",
"min": 0,
"path": "RatioRange.denominator"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "2119a8b2-2177-4be7-8bf5-f0c5f6025b43",
"kind": "complex-type",
"url": "http://hl7.org/fhir/StructureDefinition/RatioRange",
"version": "5.0.0-draft-final",
"differential": {
"element": [ {
"constraint": [ {
"key": "ratrng-1",
"human": "One of lowNumerator or highNumerator and denominator SHALL be present, or all are absent. If all are absent, there SHALL be some extension present",
"source": "http://hl7.org/fhir/StructureDefinition/RatioRange",
"severity": "error",
"expression": "((lowNumerator.exists() or highNumerator.exists()) and denominator.exists()) or (lowNumerator.empty() and highNumerator.empty() and denominator.empty() and extension.exists())"
}, {
"key": "ratrng-2",
"human": "If present, lowNumerator SHALL have a lower value than highNumerator",
"source": "http://hl7.org/fhir/StructureDefinition/RatioRange",
"severity": "error",
"expression": "lowNumerator.hasValue().not() or highNumerator.hasValue().not() or (lowNumerator.lowBoundary() <= highNumerator.highBoundary())"
} ],
"path": "RatioRange",
"min": 0,
"definition": "A range of ratios expressed as a low and high numerator and a denominator.",
"short": "Range of ratio values",
"mapping": [ {
"map": "NR and also possibly SN (but see also quantity)",
"identity": "v2"
}, {
"map": "IVL> [lowClosed=\"true\" and highClosed=\"true\"]or URG<>",
"identity": "rim"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "*",
"id": "RatioRange",
"comment": "The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3."
}, {
"path": "RatioRange.lowNumerator",
"min": 0,
"definition": "The value of the low limit numerator.",
"short": "Low Numerator limit",
"mapping": [ {
"map": "NR.1",
"identity": "v2"
}, {
"map": "./low",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"max": "1",
"id": "RatioRange.lowNumerator",
"condition": [ "ratrng-1", "ratrng-2" ],
"comment": "If the low element is missing, the low boundary is not known.",
"isSummary": true
}, {
"path": "RatioRange.highNumerator",
"min": 0,
"definition": "The value of the high limit numerator.",
"short": "High Numerator limit",
"mapping": [ {
"map": "NR.2",
"identity": "v2"
}, {
"map": "./high",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"max": "1",
"id": "RatioRange.highNumerator",
"condition": [ "ratrng-1", "ratrng-2" ],
"comment": "If the high element is missing, the high boundary is not known.",
"isSummary": true
}, {
"path": "RatioRange.denominator",
"min": 0,
"definition": "The value of the denominator.",
"short": "Denominator value",
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"max": "1",
"id": "RatioRange.denominator",
"condition": [ "ratrng-1" ],
"isSummary": true
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType"
}