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 GroupMaturity Level: 3Standards 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAmountΣDBackBoneElementChemical 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..1Used 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
.... amountQuantityQuantity
.... amountRangeRange
.... amountStringstring
... amountTypeΣ0..1CodeableConceptMost 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..1stringA textual comment on a numeric value
... referenceRangeΣ0..1ElementReference range of possible or expected values
.... lowLimitΣ0..1QuantityLower limit possible or expected
.... highLimitΣ0..1QuantityUpper limit possible or expected

doco Documentation for this format

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

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAmountΣDBackBoneElementChemical 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..1Used 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
.... amountQuantityQuantity
.... amountRangeRange
.... amountStringstring
... amountTypeΣ0..1CodeableConceptMost 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..1stringA textual comment on a numeric value
... referenceRangeΣ0..1ElementReference range of possible or expected values
.... lowLimitΣ0..1QuantityLower limit possible or expected
.... highLimitΣ0..1QuantityUpper limit possible or expected

doco Documentation for this format

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

Constraints

SubstanceAmount is used in the following places: SubstancePolymer