R4
Ballot
#1
#2
(Mixed
Normative/Trial
use)
Foundation
This
page
is
part
of
the
FHIR
Specification
(v3.3.0:
(v3.5.0:
R4
Ballot
2).
#2).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
| Modeling and Methodology Work Group | Maturity Level : N/A | Ballot Status : Informative |
Raw JSON ( canonical form + also see JSON Format Specification )
StructureDefinition for Ratio
{
"resourceType": "StructureDefinition",
"id": "Ratio",
"meta": {
"lastUpdated": "2018-04-03T12:05:46.262+10:00"
"resourceType" : "StructureDefinition",
"id" : "Ratio",
"meta" : {
"lastUpdated" : "2018-08-19T21:48:56.559+10:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
"valueString": "Normative"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/Ratio",
"name": "Ratio",
"status": "draft",
"date": "2018-04-03T12:05:46+10:00",
"publisher": "HL7 FHIR Standard",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
],
"description": "Base StructureDefinition for Ratio Type: A relationship of two Quantity values - expressed as a numerator and a denominator.",
"purpose": "Need to able to capture ratios for some measurements (titers) and some rates (costs).",
"fhirVersion": "3.3.0",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"type": "Ratio",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "Ratio",
"path": "Ratio",
"short": "A ratio of two Quantity values - a numerator and a denominator",
"definition": "A relationship of two Quantity values - expressed as a numerator and a denominator.",
"comment": "The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to \"1\", Quantity should be used instead of Ratio.",
"min": 0,
"max": "*",
"base": {
"path": "Ratio",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "rat-1",
"severity": "error",
"human": "Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present",
"expression": "(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())",
"xpath": "(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) > 0) or (count(f:extension) > 0))"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "RTO"
}
]
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueString" : "Normative"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Ratio",
"name" : "Ratio",
"status" : "draft",
"date" : "2018-08-19T21:48:56+10:00",
"publisher" : "HL7 FHIR Standard",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
}],
"description" : "Base StructureDefinition for Ratio Type: A relationship of two Quantity values - expressed as a numerator and a denominator.",
"purpose" : "Need to able to capture ratios for some measurements (titers) and some rates (costs).",
"fhirVersion" : "3.5.0",
"mapping" : [{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "complex-type",
"abstract" : false,
"type" : "Ratio",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Element",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Ratio",
"path" : "Ratio",
"short" : "A ratio of two Quantity values - a numerator and a denominator",
"definition" : "A relationship of two Quantity values - expressed as a numerator and a denominator.",
"comment" : "The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to \"1\", Quantity should be used instead of Ratio.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Ratio",
"min" : 0,
"max" : "*"
},
{
"id": "Ratio.id",
"path": "Ratio.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"condition" : ["ele-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"id": "Ratio.extension",
"path": "Ratio.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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 manageable, 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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"key" : "rat-1",
"severity" : "error",
"human" : "Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present",
"expression" : "(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())",
"xpath" : "(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) > 0) or (count(f:extension) > 0))"
}],
"isModifier" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
},
{
"id": "Ratio.numerator",
"path": "Ratio.numerator",
"short": "Numerator value",
"definition": "The value of the numerator.",
"min": 0,
"max": "1",
"base": {
"path": "Ratio.numerator",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".numerator"
}
]
"identity" : "v2",
"map" : "N/A"
},
{
"id": "Ratio.denominator",
"path": "Ratio.denominator",
"short": "Denominator value",
"definition": "The value of the denominator.",
"min": 0,
"max": "1",
"base": {
"path": "Ratio.denominator",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".denominator"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Ratio",
"path": "Ratio",
"short": "A ratio of two Quantity values - a numerator and a denominator",
"definition": "A relationship of two Quantity values - expressed as a numerator and a denominator.",
"comment": "The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to \"1\", Quantity should be used instead of Ratio.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "rat-1",
"severity": "error",
"human": "Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present",
"expression": "(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())",
"xpath": "(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) > 0) or (count(f:extension) > 0))"
}
],
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "RTO"
}
]
"identity" : "rim",
"map" : "RTO"
}]
},
{
"id" : "Ratio.id",
"path" : "Ratio.id",
"representation" : ["xmlAttr"],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
{
"id": "Ratio.numerator",
"path": "Ratio.numerator",
"short": "Numerator value",
"definition": "The value of the numerator.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".numerator"
}
]
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Ratio.extension",
"path" : "Ratio.extension",
"slicing" : {
"discriminator" : [{
"type" : "value",
"path" : "url"
}],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"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 manageable, 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.",
"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.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Ratio.numerator",
"path" : "Ratio.numerator",
"short" : "Numerator value",
"definition" : "The value of the numerator.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Ratio.numerator",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".numerator"
}]
},
{
"id" : "Ratio.denominator",
"path" : "Ratio.denominator",
"short" : "Denominator value",
"definition" : "The value of the denominator.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Ratio.denominator",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".denominator"
}]
}]
},
"differential" : {
"element" : [{
"id" : "Ratio",
"path" : "Ratio",
"short" : "A ratio of two Quantity values - a numerator and a denominator",
"definition" : "A relationship of two Quantity values - expressed as a numerator and a denominator.",
"comment" : "The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to \"1\", Quantity should be used instead of Ratio.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "rat-1",
"severity" : "error",
"human" : "Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present",
"expression" : "(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())",
"xpath" : "(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) > 0) or (count(f:extension) > 0))"
}],
"mapping" : [{
"identity" : "v2",
"map" : "N/A"
},
{
"id": "Ratio.denominator",
"path": "Ratio.denominator",
"short": "Denominator value",
"definition": "The value of the denominator.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".denominator"
}
]
}
]
"identity" : "rim",
"map" : "RTO"
}]
},
{
"id" : "Ratio.numerator",
"path" : "Ratio.numerator",
"short" : "Numerator value",
"definition" : "The value of the numerator.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".numerator"
}]
},
{
"id" : "Ratio.denominator",
"path" : "Ratio.denominator",
"short" : "Denominator value",
"definition" : "The value of the denominator.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : ".denominator"
}]
}]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®©
HL7.org
2011+.
FHIR
Mixed
Nomative/Trial
Use
Ballot
(v3.3.0-13671)
#2
(v3.5.0-14907)
generated
on
Tue,
Apr
3,
Sun,
Aug
19,
2018
12:13+1000.
21:52+1000.
QA
Page
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
|
Compare
to
DSTU3
|
Ballot
Comparison
|
|
Propose
a
change