HS.FHIRModel.R4.SubstanceAmount
class HS.FHIRModel.R4.SubstanceAmount extends HS.FHIRModel.FHIRClassSuper
******************************************* SubstanceAmount generated class schema
*****************************************
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
- _amountString
- _amountText
- amountQuantity
- amountRange
- amountString
- amountText
- amountType
- extension
- fhirID
- modifierExtension
- referenceRange
Method Inventory
- IncludeAmountQuantity()
- IncludeAmountRange()
- IncludeAmountType()
- IncludeExtension()
- IncludeModifierExtension()
- IncludeReferenceRange()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_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 _amountString as HS.FHIRModel.R4.Element;
Extensions for amountString
Property methods: _amountStringGet(), _amountStringGetSwizzled(), _amountStringIsValid(), _amountStringNewObject(), _amountStringSet()
property _amountText as HS.FHIRModel.R4.Element;
Extensions for amountText
Property methods: _amountTextGet(), _amountTextGetSwizzled(), _amountTextIsValid(), _amountTextNewObject(), _amountTextSet()
property amountQuantity as HS.FHIRModel.R4.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.FHIRModel.R4.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;
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;
A textual comment on a numeric value.
Property methods: amountTextDisplayToLogical(), amountTextGet(), amountTextIsValid(), amountTextLogicalToDisplay(), amountTextLogicalToOdbc(), amountTextNormalize(), amountTextSet()
property amountType as HS.FHIRModel.R4.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.
Property methods: amountTypeGet(), amountTypeGetSwizzled(), amountTypeIsValid(), amountTypeNewObject(), amountTypeSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
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.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
Unique id for the element within a resource (for internal references).
This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
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).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property referenceRange as HS.FHIRModel.R4.SubstanceAmountX.ReferenceRange;
Reference range of possible or expected values.
Property methods: referenceRangeGet(), referenceRangeGetSwizzled(), referenceRangeIsValid(), referenceRangeNewObject(), referenceRangeSet()
Methods
method IncludeAmountQuantity()
method IncludeAmountRange()
method IncludeAmountType()
method IncludeExtension()
method IncludeModifierExtension()
method IncludeReferenceRange()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class
in the definition order that they were discovered in the
the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.SubstanceAmount
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()