This page is part of the International Patient Summary Implementation Guide (v0.2.0: STU 1 Ballot 2) based on FHIR v3.5.0. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions 
JSON Format: StructureDefinition-ratio-uv-ips
Raw json
{
"resourceType" : "StructureDefinition",
"id" : "ratio-uv-ips",
"text" : {
"status" : "generated",
"div" : "<div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-ratio-uv-ips-definitions.html#Ratio" title="null">Ratio</a><a name="Ratio"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck11.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-ratio-uv-ips-definitions.html#Ratio.numerator" title="null">numerator</a><a name="Ratio.numerator"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/datatypes.html#Quantity">Quantity</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck110.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-ratio-uv-ips-definitions.html#Ratio.numerator.system" title="null">system</a><a name="Ratio.numerator.system"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/datatypes.html#uri">uri</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Fixed Value: </span><span style="color: darkgreen">http://unitsofmeasure.org</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck100.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-ratio-uv-ips-definitions.html#Ratio.numerator.code" title="null">code</a><a name="Ratio.numerator.code"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/datatypes.html#code">code</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck01.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-ratio-uv-ips-definitions.html#Ratio.denominator" title="null">denominator</a><a name="Ratio.denominator"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/datatypes.html#Quantity">Quantity</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck010.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_blank.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-ratio-uv-ips-definitions.html#Ratio.denominator.system" title="null">system</a><a name="Ratio.denominator.system"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/datatypes.html#uri">uri</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Fixed Value: </span><span style="color: darkgreen">http://unitsofmeasure.org</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck000.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_blank.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-ratio-uv-ips-definitions.html#Ratio.denominator.code" title="null">code</a><a name="Ratio.denominator.code"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/datatypes.html#code">code</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>"
},
"url" : "http://hl7.org/fhir/uv/ips/StructureDefinition/ratio-uv-ips",
"version" : "0.2.0",
"name" : "Ratio-uv-ips",
"title" : "Ratio",
"status" : "draft",
"date" : "2018-03-21T14:49:16.166+01:00",
"contact" : [
{
"name" : "Christof Gessner"
}
],
"description" : "Ratio data type, constrained to use UCUM as a codesystem.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"purpose" : "allow only UCUM as a codesystem.",
"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/Ratio",
"derivation" : "constraint",
"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() or (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))",
"source" : "Ratio"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"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"
},
"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.numerator.id",
"path" : "Ratio.numerator.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"
}
]
},
{
"id" : "Ratio.numerator.extension",
"path" : "Ratio.numerator.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.value",
"path" : "Ratio.numerator.value",
"short" : "Numerical value (with implicit precision)",
"definition" : "The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
"comment" : "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).",
"requirements" : "Precision is handled implicitly in almost all cases of measurement.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Quantity.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "decimal"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "SN.2 / CQ - N/A"
},
{
"identity" : "rim",
"map" : "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value"
}
]
},
{
"id" : "Ratio.numerator.comparator",
"path" : "Ratio.numerator.comparator",
"short" : "< | <= | >= | > - how to understand the value",
"definition" : "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.",
"requirements" : "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Quantity.comparator",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"meaningWhenMissing" : "If there is no comparator, then there is no modification of the value",
"isModifier" : true,
"isModifierReason" : "This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value",
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuantityComparator"
}
],
"strength" : "required",
"description" : "How the Quantity should be understood and represented.",
"valueSet" : "http://hl7.org/fhir/ValueSet/quantity-comparator"
},
"mapping" : [
{
"identity" : "v2",
"map" : "SN.1 / CQ.1"
},
{
"identity" : "rim",
"map" : "IVL properties"
}
]
},
{
"id" : "Ratio.numerator.unit",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Ratio.numerator.unit",
"short" : "Unit representation",
"definition" : "A human-readable form of the unit.",
"requirements" : "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Quantity.unit",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "(see OBX.6 etc.) / CQ.2"
},
{
"identity" : "rim",
"map" : "PQ.unit"
}
]
},
{
"id" : "Ratio.numerator.system",
"path" : "Ratio.numerator.system",
"short" : "System that defines coded unit form",
"definition" : "The identification of the system that provides the coded form of the unit.",
"requirements" : "Need to know the system that defines the coded form of the unit.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Quantity.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"fixedUri" : "http://unitsofmeasure.org",
"condition" : [
"qty-3"
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "(see OBX.6 etc.) / CQ.2"
},
{
"identity" : "rim",
"map" : "CO.codeSystem, PQ.translation.codeSystem"
}
]
},
{
"id" : "Ratio.numerator.code",
"path" : "Ratio.numerator.code",
"short" : "Coded form of the unit",
"definition" : "A computer processable form of the unit in some unit representation system.",
"comment" : "The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.",
"requirements" : "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Quantity.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "(see OBX.6 etc.) / CQ.2"
},
{
"identity" : "rim",
"map" : "PQ.code, MO.currency, PQ.translation.code"
}
]
},
{
"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"
}
]
},
{
"id" : "Ratio.denominator.id",
"path" : "Ratio.denominator.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"
}
]
},
{
"id" : "Ratio.denominator.extension",
"path" : "Ratio.denominator.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.denominator.value",
"path" : "Ratio.denominator.value",
"short" : "Numerical value (with implicit precision)",
"definition" : "The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
"comment" : "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).",
"requirements" : "Precision is handled implicitly in almost all cases of measurement.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Quantity.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "decimal"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "SN.2 / CQ - N/A"
},
{
"identity" : "rim",
"map" : "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value"
}
]
},
{
"id" : "Ratio.denominator.comparator",
"path" : "Ratio.denominator.comparator",
"short" : "< | <= | >= | > - how to understand the value",
"definition" : "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.",
"requirements" : "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Quantity.comparator",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"meaningWhenMissing" : "If there is no comparator, then there is no modification of the value",
"isModifier" : true,
"isModifierReason" : "This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value",
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "QuantityComparator"
}
],
"strength" : "required",
"description" : "How the Quantity should be understood and represented.",
"valueSet" : "http://hl7.org/fhir/ValueSet/quantity-comparator"
},
"mapping" : [
{
"identity" : "v2",
"map" : "SN.1 / CQ.1"
},
{
"identity" : "rim",
"map" : "IVL properties"
}
]
},
{
"id" : "Ratio.denominator.unit",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Ratio.denominator.unit",
"short" : "Unit representation",
"definition" : "A human-readable form of the unit.",
"requirements" : "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Quantity.unit",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "(see OBX.6 etc.) / CQ.2"
},
{
"identity" : "rim",
"map" : "PQ.unit"
}
]
},
{
"id" : "Ratio.denominator.system",
"path" : "Ratio.denominator.system",
"short" : "System that defines coded unit form",
"definition" : "The identification of the system that provides the coded form of the unit.",
"requirements" : "Need to know the system that defines the coded form of the unit.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Quantity.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"fixedUri" : "http://unitsofmeasure.org",
"condition" : [
"qty-3"
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "(see OBX.6 etc.) / CQ.2"
},
{
"identity" : "rim",
"map" : "CO.codeSystem, PQ.translation.codeSystem"
}
]
},
{
"id" : "Ratio.denominator.code",
"path" : "Ratio.denominator.code",
"short" : "Coded form of the unit",
"definition" : "A computer processable form of the unit in some unit representation system.",
"comment" : "The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.",
"requirements" : "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Quantity.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "(see OBX.6 etc.) / CQ.2"
},
{
"identity" : "rim",
"map" : "PQ.code, MO.currency, PQ.translation.code"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "Ratio",
"path" : "Ratio"
},
{
"id" : "Ratio.numerator",
"path" : "Ratio.numerator"
},
{
"id" : "Ratio.numerator.system",
"path" : "Ratio.numerator.system",
"min" : 1,
"fixedUri" : "http://unitsofmeasure.org"
},
{
"id" : "Ratio.numerator.code",
"path" : "Ratio.numerator.code",
"min" : 1
},
{
"id" : "Ratio.denominator",
"path" : "Ratio.denominator"
},
{
"id" : "Ratio.denominator.system",
"path" : "Ratio.denominator.system",
"min" : 1,
"fixedUri" : "http://unitsofmeasure.org"
},
{
"id" : "Ratio.denominator.code",
"path" : "Ratio.denominator.code",
"min" : 1
}
]
}
}
