Private OptionalamountSubstanceAmount.amount[x] Element
FHIR Specification
Private OptionalamountSubstanceAmount.amountType Element
FHIR Specification
CodeableConceptPrivate OptionalamountSubstanceAmount.amountText Element
Private OptionalreferenceSubstanceAmount.referenceRange Element
StaticparseParse the provided SubstanceAmount JSON to instantiate the SubstanceAmount data model.
JSON representing FHIR SubstanceAmount
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to SubstanceAmount
SubstanceAmount data model or undefined for SubstanceAmount
JsonError if the provided JSON is not a valid JSON object
the amount property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the amount property.
the amount object value
this
InvalidTypeError for invalid data types
true if the amount property exists and has a value; false otherwise
the amount property value as a Quantity object if defined; else undefined
true if the amount property exists as a Quantity and has a value; false otherwise
the amount property value as a Range object if defined; else undefined
true if the amount property exists as a Range and has a value; false otherwise
the amount property value as a StringType object if defined; else undefined
true if the amount property exists as a StringType and has a value; false otherwise
the amountType property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided AmountType object value to the amountType property.
the amountType object value
this
InvalidTypeError for invalid data types
true if the amountType property exists and has a value; false otherwise
the amountText property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the amountText property.
the amountText value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the amountText property exists and has a value; false otherwise
the amountText property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the amountText property.
the amountText value
this
PrimitiveTypeError for invalid primitive types
true if the amountText property exists and has a value; false otherwise
the referenceRange property value as a SubstanceAmountReferenceRangeComponent object if defined; else an empty SubstanceAmountReferenceRangeComponent object
Assigns the provided ReferenceRange object value to the referenceRange property.
the referenceRange object value
this
InvalidTypeError for invalid data types
true if the referenceRange property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
Creates a copy of the current instance.
the a new instance copied from the current instance
true if the instance is a FHIR complex datatype; false otherwise
the complex or primitive data model type name (e.g., 'Period", 'StringType', `UriType', etc.)
the JSON value or undefined if the instance is empty
the array of modifierExtension values
Assigns the provided array of Extension values to the modifierExtension property.
array of Extensions
this
Determines if modifierExtension property exists for the provided url
Optionalurl: stringthe url that identifies a specific Extension
true if the modifierExtension property exists and has at least one element; false otherwise
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the modifierExtension property array.
the Extension value to add to the modifierExtension property array
this
Removes the Extension having the provided url from the modifierExtension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
true if the instance is a FHIR complex or primitive datatype; false otherwise
the id property value
Assigns the provided value to the id property.
the id value
this
PrimitiveTypeError for invalid value
true if id exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url; false otherwise
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the extension property exists and has any values.
AssertionError for invalid url
Determines if the extension property exists.
the url that identifies a specific Extension
an Extension having the provided url
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the extension property exists and has any values.
AssertionError for invalid url
Adds the provided Extension to the extension property array.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
true if and only if the data model has required fields (min cardinality > 0)
and at least one of those required fields in the instance is empty; false otherwise
true if the instance is a FHIR resource; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
SubstanceAmount Class
Remarks
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.
FHIR Specification
See
FHIR SubstanceAmount