Release 4

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

11.31.0 SubstanceAmount

Pharmacy

Work Group

Maturity Level: 3

Standards Status: Trial Use

This type is still undergoing development and review by the appropriate Workgroups. At this time, is considered only as a draft design not suitable for production implementation

The SubstanceAmount structure defines TODO.

Note: the SubstanceAmount structure allows modifier extensions.

Structure

Name	Flags	Card.	Type	Description & Constraints
SubstanceAmount	Σ D		BackBoneElement	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 Elements defined in Ancestors: id, extension, modifierExtension
amount[x]	Σ	0..1		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
amountQuantity			Quantity
amountRange			Range
amountString			string
amountType	Σ	0..1	CodeableConcept	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
amountText	Σ	0..1	string	A textual comment on a numeric value
referenceRange	Σ	0..1	Element	Reference range of possible or expected values
lowLimit	Σ	0..1	Quantity	Lower limit possible or expected
highLimit	Σ	0..1	Quantity	Upper limit possible or expected
Documentation for this format

UML Diagram (Legend)

XML Template

<SubstanceAmount xmlns="http://hl7.org/fhir">
 <!-- from BackboneElement: extension, modifierExtension -->
 <amount[x]><!-- 0..1 Quantity|Range|string 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 --></amount[x]>
 <amountType><!-- 0..1 CodeableConcept 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 --></amountType>
 <amountText value="[string]"/><!-- 0..1 A textual comment on a numeric value -->
 <referenceRange>  <!-- 0..1 Reference range of possible or expected values -->
  <lowLimit><!-- 0..1 Quantity Lower limit possible or expected --></lowLimit>
  <highLimit><!-- 0..1 Quantity Upper limit possible or expected --></highLimit>
 </referenceRange>
</SubstanceAmount>

JSON Template

{
  // from BackboneElement: extension, modifierExtension
  // amount[x]: 
     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. One of these 3:
  "amountQuantity" : { Quantity },
  "amountRange" : { Range },
  "amountString" : "<string>",
  "amountType" : { CodeableConcept }, // 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
  "amountText" : "<string>", // A textual comment on a numeric value
  "referenceRange" : { // Reference range of possible or expected values
    "lowLimit" : { Quantity }, // Lower limit possible or expected
    "highLimit" : { Quantity } // Upper limit possible or expected
  }
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from BackboneElement: Element.extension, BackboneElement.modifierextension
  # SubstanceAmount.amount[x] : 0..1 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. One of these 3
    fhir:SubstanceAmount.amountQuantity [ Quantity ]
    fhir:SubstanceAmount.amountRange [ Range ]
    fhir:SubstanceAmount.amountString [ string ]
  fhir:SubstanceAmount.amountType [ CodeableConcept ]; # 0..1 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
  fhir:SubstanceAmount.amountText [ string ]; # 0..1 A textual comment on a numeric value
  fhir:SubstanceAmount.referenceRange [ # 0..1 Reference range of possible or expected values
    fhir:SubstanceAmount.referenceRange.lowLimit [ Quantity ]; # 0..1 Lower limit possible or expected
    fhir:SubstanceAmount.referenceRange.highLimit [ Quantity ]; # 0..1 Upper limit possible or expected
  ];
]

Changes since Release 3

This complex-type did not exist in Release 2