SubstanceAmount.xml 1 <?xml version="1.0" encoding="utf-8"?> 2 <StructureDefinition xmlns="http://hl7.org/fhir"> 3 <id value="SubstanceAmount" /> 4 <meta> 5 <lastUpdated value="2019-10-31T23:29:23.356+01:00" /> 6 </meta> 7 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 8 <valueCode value="draft" /> 9 </extension> 10 <url value="http://hl7.org/fhir/StructureDefinition/SubstanceAmount" /> 11 <version value="4.0.1" /> 12 <name value="SubstanceAmount" /> 13 <status value="draft" /> 14 <date value="2019-10-31T23:29:23.0000000+01:00" /> 15 <publisher value="HL7 FHIR Standard" /> 16 <contact> 17 <telecom> 18 <system value="url" /> 19 <value value="http://hl7.org/fhir" /> 20 </telecom> 21 </contact> 22 <description value="Base StructureDefinition for SubstanceAmount Type: Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID." /> 23 <fhirVersion value="4.0.1" /> 24 <mapping> 25 <identity value="rim" /> 26 <uri value="http://hl7.org/v3" /> 27 <name value="RIM Mapping" /> 28 </mapping> 29 <kind value="complex-type" /> 30 <abstract value="false" /> 31 <type value="SubstanceAmount" /> 32 <baseDefinition value="http://hl7.org/fhir/StructureDefinition/BackboneElement" /> 33 <derivation value="specialization" /> 34 <snapshot> 35 <element id="SubstanceAmount"> 36 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 37 <valueCode value="draft" /> 38 </extension> 39 <path value="SubstanceAmount" /> 40 <short value="Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID" /> 41 <definition value="Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID." /> 42 <min value="0" /> 43 <max value="*" /> 44 <base> 45 <path value="SubstanceAmount" /> 46 <min value="0" /> 47 <max value="*" /> 48 </base> 49 <constraint> 50 <key value="ele-1" /> 51 <severity value="error" /> 52 <human value="All FHIR elements must have a @value or children" /> 53 <expression value="hasValue() or (children().count() > id.count())" /> 54 <xpath value="@value|f:*|h:div" /> 55 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 56 </constraint> 57 <isModifier value="false" /> 58 <mapping> 59 <identity value="rim" /> 60 <map value="n/a" /> 61 </mapping> 62 </element> 63 <element id="SubstanceAmount.id"> 64 <path value="SubstanceAmount.id" /> 65 <representation value="xmlAttr" /> 66 <short value="Unique id for inter-element referencing" /> 67 <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> 68 <min value="0" /> 69 <max value="1" /> 70 <base> 71 <path value="Element.id" /> 72 <min value="0" /> 73 <max value="1" /> 74 </base> 75 <type> 76 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> 77 <valueUrl value="string" /> 78 </extension> 79 <code value="http://hl7.org/fhirpath/System.String" /> 80 </type> 81 <isModifier value="false" /> 82 <isSummary value="false" /> 83 <mapping> 84 <identity value="rim" /> 85 <map value="n/a" /> 86 </mapping> 87 </element> 88 <element id="SubstanceAmount.extension"> 89 <path value="SubstanceAmount.extension" /> 90 <slicing> 91 <discriminator> 92 <type value="value" /> 93 <path value="url" /> 94 </discriminator> 95 <description value="Extensions are always sliced by (at least) url" /> 96 <rules value="open" /> 97 </slicing> 98 <short value="Additional content defined by implementations" /> 99 <definition value="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." /> 100 <comment value="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." /> 101 <alias value="extensions" /> 102 <alias value="user content" /> 103 <min value="0" /> 104 <max value="*" /> 105 <base> 106 <path value="Element.extension" /> 107 <min value="0" /> 108 <max value="*" /> 109 </base> 110 <type> 111 <code value="Extension" /> 112 </type> 113 <constraint> 114 <key value="ele-1" /> 115 <severity value="error" /> 116 <human value="All FHIR elements must have a @value or children" /> 117 <expression value="hasValue() or (children().count() > id.count())" /> 118 <xpath value="@value|f:*|h:div" /> 119 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 120 </constraint> 121 <constraint> 122 <key value="ext-1" /> 123 <severity value="error" /> 124 <human value="Must have either extensions or value[x], not both" /> 125 <expression value="extension.exists() != value.exists()" /> 126 <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> 127 <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> 128 </constraint> 129 <isModifier value="false" /> 130 <isSummary value="false" /> 131 <mapping> 132 <identity value="rim" /> 133 <map value="n/a" /> 134 </mapping> 135 </element> 136 <element id="SubstanceAmount.modifierExtension"> 137 <path value="SubstanceAmount.modifierExtension" /> 138 <short value="Extensions that cannot be ignored even if unrecognized" /> 139 <definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." /> 140 <comment value="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." /> 141 <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." /> 142 <alias value="extensions" /> 143 <alias value="user content" /> 144 <alias value="modifiers" /> 145 <min value="0" /> 146 <max value="*" /> 147 <base> 148 <path value="BackboneElement.modifierExtension" /> 149 <min value="0" /> 150 <max value="*" /> 151 </base> 152 <type> 153 <code value="Extension" /> 154 </type> 155 <constraint> 156 <key value="ele-1" /> 157 <severity value="error" /> 158 <human value="All FHIR elements must have a @value or children" /> 159 <expression value="hasValue() or (children().count() > id.count())" /> 160 <xpath value="@value|f:*|h:div" /> 161 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 162 </constraint> 163 <constraint> 164 <key value="ext-1" /> 165 <severity value="error" /> 166 <human value="Must have either extensions or value[x], not both" /> 167 <expression value="extension.exists() != value.exists()" /> 168 <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> 169 <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> 170 </constraint> 171 <isModifier value="true" /> 172 <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" /> 173 <isSummary value="true" /> 174 <mapping> 175 <identity value="rim" /> 176 <map value="N/A" /> 177 </mapping> 178 </element> 179 <element id="SubstanceAmount.amount[x]"> 180 <path value="SubstanceAmount.amount[x]" /> 181 <short value="Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field" /> 182 <definition value="Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field." /> 183 <min value="0" /> 184 <max value="1" /> 185 <base> 186 <path value="SubstanceAmount.amount[x]" /> 187 <min value="0" /> 188 <max value="1" /> 189 </base> 190 <type> 191 <code value="Quantity" /> 192 </type> 193 <type> 194 <code value="Range" /> 195 </type> 196 <type> 197 <code value="string" /> 198 </type> 199 <constraint> 200 <key value="ele-1" /> 201 <severity value="error" /> 202 <human value="All FHIR elements must have a @value or children" /> 203 <expression value="hasValue() or (children().count() > id.count())" /> 204 <xpath value="@value|f:*|h:div" /> 205 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 206 </constraint> 207 <isModifier value="false" /> 208 <isSummary value="true" /> 209 </element> 210 <element id="SubstanceAmount.amountType"> 211 <path value="SubstanceAmount.amountType" /> 212 <short value="Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because the actual value of the amount is often dependent on it. EXAMPLE: In capturing the actual relative amounts of substances or molecular fragments it is essential to indicate whether the amount refers to a mole ratio or weight ratio. For any given element an effort should be made to use same the amount type for all related definitional elements" /> 213 <definition value="Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because the actual value of the amount is often dependent on it. EXAMPLE: In capturing the actual relative amounts of substances or molecular fragments it is essential to indicate whether the amount refers to a mole ratio or weight ratio. For any given element an effort should be made to use same the amount type for all related definitional elements." /> 214 <min value="0" /> 215 <max value="1" /> 216 <base> 217 <path value="SubstanceAmount.amountType" /> 218 <min value="0" /> 219 <max value="1" /> 220 </base> 221 <type> 222 <code value="CodeableConcept" /> 223 </type> 224 <constraint> 225 <key value="ele-1" /> 226 <severity value="error" /> 227 <human value="All FHIR elements must have a @value or children" /> 228 <expression value="hasValue() or (children().count() > id.count())" /> 229 <xpath value="@value|f:*|h:div" /> 230 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 231 </constraint> 232 <isModifier value="false" /> 233 <isSummary value="true" /> 234 </element> 235 <element id="SubstanceAmount.amountText"> 236 <path value="SubstanceAmount.amountText" /> 237 <short value="A textual comment on a numeric value" /> 238 <definition value="A textual comment on a numeric value." /> 239 <min value="0" /> 240 <max value="1" /> 241 <base> 242 <path value="SubstanceAmount.amountText" /> 243 <min value="0" /> 244 <max value="1" /> 245 </base> 246 <type> 247 <code value="string" /> 248 </type> 249 <constraint> 250 <key value="ele-1" /> 251 <severity value="error" /> 252 <human value="All FHIR elements must have a @value or children" /> 253 <expression value="hasValue() or (children().count() > id.count())" /> 254 <xpath value="@value|f:*|h:div" /> 255 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 256 </constraint> 257 <isModifier value="false" /> 258 <isSummary value="true" /> 259 </element> 260 <element id="SubstanceAmount.referenceRange"> 261 <path value="SubstanceAmount.referenceRange" /> 262 <short value="Reference range of possible or expected values" /> 263 <definition value="Reference range of possible or expected values." /> 264 <min value="0" /> 265 <max value="1" /> 266 <base> 267 <path value="SubstanceAmount.referenceRange" /> 268 <min value="0" /> 269 <max value="1" /> 270 </base> 271 <type> 272 <code value="Element" /> 273 </type> 274 <constraint> 275 <key value="ele-1" /> 276 <severity value="error" /> 277 <human value="All FHIR elements must have a @value or children" /> 278 <expression value="hasValue() or (children().count() > id.count())" /> 279 <xpath value="@value|f:*|h:div" /> 280 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 281 </constraint> 282 <isModifier value="false" /> 283 <isSummary value="true" /> 284 </element> 285 <element id="SubstanceAmount.referenceRange.id"> 286 <path value="SubstanceAmount.referenceRange.id" /> 287 <representation value="xmlAttr" /> 288 <short value="Unique id for inter-element referencing" /> 289 <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> 290 <min value="0" /> 291 <max value="1" /> 292 <base> 293 <path value="Element.id" /> 294 <min value="0" /> 295 <max value="1" /> 296 </base> 297 <type> 298 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> 299 <valueUrl value="string" /> 300 </extension> 301 <code value="http://hl7.org/fhirpath/System.String" /> 302 </type> 303 <isModifier value="false" /> 304 <isSummary value="false" /> 305 <mapping> 306 <identity value="rim" /> 307 <map value="n/a" /> 308 </mapping> 309 </element> 310 <element id="SubstanceAmount.referenceRange.extension"> 311 <path value="SubstanceAmount.referenceRange.extension" /> 312 <slicing> 313 <discriminator> 314 <type value="value" /> 315 <path value="url" /> 316 </discriminator> 317 <description value="Extensions are always sliced by (at least) url" /> 318 <rules value="open" /> 319 </slicing> 320 <short value="Additional content defined by implementations" /> 321 <definition value="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." /> 322 <comment value="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." /> 323 <alias value="extensions" /> 324 <alias value="user content" /> 325 <min value="0" /> 326 <max value="*" /> 327 <base> 328 <path value="Element.extension" /> 329 <min value="0" /> 330 <max value="*" /> 331 </base> 332 <type> 333 <code value="Extension" /> 334 </type> 335 <constraint> 336 <key value="ele-1" /> 337 <severity value="error" /> 338 <human value="All FHIR elements must have a @value or children" /> 339 <expression value="hasValue() or (children().count() > id.count())" /> 340 <xpath value="@value|f:*|h:div" /> 341 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 342 </constraint> 343 <constraint> 344 <key value="ext-1" /> 345 <severity value="error" /> 346 <human value="Must have either extensions or value[x], not both" /> 347 <expression value="extension.exists() != value.exists()" /> 348 <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> 349 <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> 350 </constraint> 351 <isModifier value="false" /> 352 <isSummary value="false" /> 353 <mapping> 354 <identity value="rim" /> 355 <map value="n/a" /> 356 </mapping> 357 </element> 358 <element id="SubstanceAmount.referenceRange.lowLimit"> 359 <path value="SubstanceAmount.referenceRange.lowLimit" /> 360 <short value="Lower limit possible or expected" /> 361 <definition value="Lower limit possible or expected." /> 362 <min value="0" /> 363 <max value="1" /> 364 <base> 365 <path value="SubstanceAmount.referenceRange.lowLimit" /> 366 <min value="0" /> 367 <max value="1" /> 368 </base> 369 <type> 370 <code value="Quantity" /> 371 </type> 372 <constraint> 373 <key value="ele-1" /> 374 <severity value="error" /> 375 <human value="All FHIR elements must have a @value or children" /> 376 <expression value="hasValue() or (children().count() > id.count())" /> 377 <xpath value="@value|f:*|h:div" /> 378 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 379 </constraint> 380 <isModifier value="false" /> 381 <isSummary value="true" /> 382 </element> 383 <element id="SubstanceAmount.referenceRange.highLimit"> 384 <path value="SubstanceAmount.referenceRange.highLimit" /> 385 <short value="Upper limit possible or expected" /> 386 <definition value="Upper limit possible or expected." /> 387 <min value="0" /> 388 <max value="1" /> 389 <base> 390 <path value="SubstanceAmount.referenceRange.highLimit" /> 391 <min value="0" /> 392 <max value="1" /> 393 </base> 394 <type> 395 <code value="Quantity" /> 396 </type> 397 <constraint> 398 <key value="ele-1" /> 399 <severity value="error" /> 400 <human value="All FHIR elements must have a @value or children" /> 401 <expression value="hasValue() or (children().count() > id.count())" /> 402 <xpath value="@value|f:*|h:div" /> 403 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 404 </constraint> 405 <isModifier value="false" /> 406 <isSummary value="true" /> 407 </element> 408 </snapshot> 409 <differential> 410 <element id="SubstanceAmount"> 411 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 412 <valueCode value="draft" /> 413 </extension> 414 <path value="SubstanceAmount" /> 415 <short value="Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID" /> 416 <definition value="Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID." /> 417 <min value="0" /> 418 <max value="*" /> 419 </element> 420 <element id="SubstanceAmount.amount[x]"> 421 <path value="SubstanceAmount.amount[x]" /> 422 <short value="Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field" /> 423 <definition value="Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field." /> 424 <min value="0" /> 425 <max value="1" /> 426 <type> 427 <code value="Quantity" /> 428 </type> 429 <type> 430 <code value="Range" /> 431 </type> 432 <type> 433 <code value="string" /> 434 </type> 435 <isSummary value="true" /> 436 </element> 437 <element id="SubstanceAmount.amountType"> 438 <path value="SubstanceAmount.amountType" /> 439 <short value="Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because the actual value of the amount is often dependent on it. EXAMPLE: In capturing the actual relative amounts of substances or molecular fragments it is essential to indicate whether the amount refers to a mole ratio or weight ratio. For any given element an effort should be made to use same the amount type for all related definitional elements" /> 440 <definition value="Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because the actual value of the amount is often dependent on it. EXAMPLE: In capturing the actual relative amounts of substances or molecular fragments it is essential to indicate whether the amount refers to a mole ratio or weight ratio. For any given element an effort should be made to use same the amount type for all related definitional elements." /> 441 <min value="0" /> 442 <max value="1" /> 443 <type> 444 <code value="CodeableConcept" /> 445 </type> 446 <isSummary value="true" /> 447 </element> 448 <element id="SubstanceAmount.amountText"> 449 <path value="SubstanceAmount.amountText" /> 450 <short value="A textual comment on a numeric value" /> 451 <definition value="A textual comment on a numeric value." /> 452 <min value="0" /> 453 <max value="1" /> 454 <type> 455 <code value="string" /> 456 </type> 457 <isSummary value="true" /> 458 </element> 459 <element id="SubstanceAmount.referenceRange"> 460 <path value="SubstanceAmount.referenceRange" /> 461 <short value="Reference range of possible or expected values" /> 462 <definition value="Reference range of possible or expected values." /> 463 <min value="0" /> 464 <max value="1" /> 465 <type> 466 <code value="Element" /> 467 </type> 468 <isSummary value="true" /> 469 </element> 470 <element id="SubstanceAmount.referenceRange.lowLimit"> 471 <path value="SubstanceAmount.referenceRange.lowLimit" /> 472 <short value="Lower limit possible or expected" /> 473 <definition value="Lower limit possible or expected." /> 474 <min value="0" /> 475 <max value="1" /> 476 <type> 477 <code value="Quantity" /> 478 </type> 479 <isSummary value="true" /> 480 </element> 481 <element id="SubstanceAmount.referenceRange.highLimit"> 482 <path value="SubstanceAmount.referenceRange.highLimit" /> 483 <short value="Upper limit possible or expected" /> 484 <definition value="Upper limit possible or expected." /> 485 <min value="0" /> 486 <max value="1" /> 487 <type> 488 <code value="Quantity" /> 489 </type> 490 <isSummary value="true" /> 491 </element> 492 </differential> 493 </StructureDefinition>