Skip to main content

HS.FHIR.DTL.vR4.Model.Datatype.SubstanceAmount

class HS.FHIR.DTL.vR4.Model.Datatype.SubstanceAmount extends HS.FHIR.DTL.vR4.Model.Base.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.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = HS.FHIR.DTL.vR4.Model.Datatype.SubstanceAmount;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = HS.FHIR.DTL.vR4.Model.Datatype.SubstanceAmount;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type. The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property amountQuantity as HS.FHIR.DTL.vR4.Model.Datatype.Quantity (XMLNAME = "amountQuantity", XMLPROJECTION = "ELEMENT");
Quantity

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.

Property methods: amountQuantityGet(), amountQuantityGetSwizzled(), amountQuantityIsValid(), amountQuantityNewObject(), amountQuantitySet()
property amountRange as HS.FHIR.DTL.vR4.Model.Datatype.Range (XMLNAME = "amountRange", XMLPROJECTION = "ELEMENT");
Range

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.

Property methods: amountRangeGet(), amountRangeGetSwizzled(), amountRangeIsValid(), amountRangeNewObject(), amountRangeSet()
property amountString as %String (MAXLEN = 1000000, XMLNAME = "amountString", XMLPROJECTION = "ATTRIBUTE");
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.

Property methods: amountStringDisplayToLogical(), amountStringGet(), amountStringIsValid(), amountStringLogicalToDisplay(), amountStringLogicalToOdbc(), amountStringNormalize(), amountStringSet()
property amountText as %String (MAXLEN = 1000000, XMLNAME = "amountText", XMLPROJECTION = "ATTRIBUTE");
string

A textual comment on a numeric value.

Property methods: amountTextDisplayToLogical(), amountTextGet(), amountTextIsValid(), amountTextLogicalToDisplay(), amountTextLogicalToOdbc(), amountTextNormalize(), amountTextSet()
property amountType as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "amountType", XMLPROJECTION = "ELEMENT");
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.

any FHIR4 code from any ValueSet may be used.

Property methods: amountTypeGet(), amountTypeGetSwizzled(), amountTypeIsValid(), amountTypeNewObject(), amountTypeSet()
property referenceRange as HS.FHIR.DTL.vR4.Model.Element.SubstanceAmount.referenceRange (XMLNAME = "referenceRange", XMLPROJECTION = "ELEMENT");
Element

Reference range of possible or expected values.

Property methods: referenceRangeGet(), referenceRangeGetSwizzled(), referenceRangeIsValid(), referenceRangeNewObject(), referenceRangeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab