Private OptionalidentifierSubstanceSpecification.identifier Element
Private Optionaltype_SubstanceSpecification.type Element
Private OptionalstatusSubstanceSpecification.status Element
Private OptionaldomainSubstanceSpecification.domain Element
Private OptionaldescriptionSubstanceSpecification.description Element
Private OptionalsourceSubstanceSpecification.source Element
FHIR Specification
Reference
Private OptionalcommentSubstanceSpecification.comment Element
Private OptionalmoietySubstanceSpecification.moiety Element
Private OptionalpropertySubstanceSpecification.property Element
FHIR Specification
BackboneElementPrivate OptionalreferenceSubstanceSpecification.referenceInformation Element
FHIR Specification
Reference
Private OptionalstructureSubstanceSpecification.structure Element
Private OptionalcodeSubstanceSpecification.code Element
Private OptionalnameSubstanceSpecification.name Element
Private OptionalmolecularSubstanceSpecification.molecularWeight Element
Private OptionalrelationshipSubstanceSpecification.relationship Element
Private OptionalnucleicSubstanceSpecification.nucleicAcid Element
FHIR Specification
Reference
Private OptionalpolymerSubstanceSpecification.polymer Element
FHIR Specification
Reference
Private OptionalproteinSubstanceSpecification.protein Element
FHIR Specification
Reference
Private OptionalsourceSubstanceSpecification.sourceMaterial Element
FHIR Specification
Reference
StaticparseParse the provided SubstanceSpecification JSON to instantiate the SubstanceSpecification data model.
JSON representing FHIR SubstanceSpecification
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to SubstanceSpecification
SubstanceSpecification data model or undefined for SubstanceSpecification
JsonError if the provided JSON is not a valid JSON object
the identifier property value as a Identifier object if defined; else an empty Identifier object
Assigns the provided Identifier object value to the identifier property.
the identifier object value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the type_ property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Type object value to the type_ property.
the type_ object value
this
InvalidTypeError for invalid data types
true if the type_ property exists and has a value; false otherwise
the status property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Status object value to the status property.
the status object value
this
InvalidTypeError for invalid data types
true if the status property exists and has a value; false otherwise
the domain property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Domain object value to the domain property.
the domain object value
this
InvalidTypeError for invalid data types
true if the domain property exists and has a value; false otherwise
the description property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the description property.
the description value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the description property exists and has a value; false otherwise
the description property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the description property.
the description value
this
PrimitiveTypeError for invalid primitive types
true if the description property exists and has a value; false otherwise
the source property value as a Reference array
Assigns the provided Reference array value to the source property.
the source array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the source array property.
the source value
this
InvalidTypeError for invalid data type or reference value
true if the source property exists and has a value; false otherwise
the comment property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the comment property.
the comment value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the comment property exists and has a value; false otherwise
the comment property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the comment property.
the comment value
this
PrimitiveTypeError for invalid primitive types
true if the comment property exists and has a value; false otherwise
the moiety property value as a SubstanceSpecificationMoietyComponent array
Assigns the provided SubstanceSpecificationMoietyComponent array value to the moiety property.
the moiety array value
this
InvalidTypeError for invalid data types
Add the provided SubstanceSpecificationMoietyComponent value to the moiety array property.
the moiety value
this
InvalidTypeError for invalid data types
true if the moiety property exists and has a value; false otherwise
the property property value as a SubstanceSpecificationPropertyComponent array
Assigns the provided SubstanceSpecificationPropertyComponent array value to the property property.
the property array value
this
InvalidTypeError for invalid data types
Add the provided SubstanceSpecificationPropertyComponent value to the property array property.
the property value
this
InvalidTypeError for invalid data types
true if the property property exists and has a value; false otherwise
the referenceInformation property value as a Reference object; else an empty Reference object
Assigns the provided ReferenceInformation object value to the referenceInformation property.
the referenceInformation object value
this
@ReferenceTargets('SubstanceSpecification.referenceInformation', ['SubstanceReferenceInformation',])
InvalidTypeError for invalid data type or reference value
true if the referenceInformation property exists and has a value; false otherwise
the structure property value as a SubstanceSpecificationStructureComponent object if defined; else an empty SubstanceSpecificationStructureComponent object
Assigns the provided Structure object value to the structure property.
the structure object value
this
InvalidTypeError for invalid data types
true if the structure property exists and has a value; false otherwise
the code property value as a SubstanceSpecificationCodeComponent array
Assigns the provided SubstanceSpecificationCodeComponent array value to the code property.
the code array value
this
InvalidTypeError for invalid data types
Add the provided SubstanceSpecificationCodeComponent value to the code array property.
the code value
this
InvalidTypeError for invalid data types
true if the code property exists and has a value; false otherwise
the name property value as a SubstanceSpecificationNameComponent array
Assigns the provided SubstanceSpecificationNameComponent array value to the name property.
the name array value
this
InvalidTypeError for invalid data types
Add the provided SubstanceSpecificationNameComponent value to the name array property.
the name value
this
InvalidTypeError for invalid data types
true if the name property exists and has a value; false otherwise
the molecularWeight property value as a SubstanceSpecificationStructureIsotopeMolecularWeightComponent array
Assigns the provided SubstanceSpecificationStructureIsotopeMolecularWeightComponent array value to the molecularWeight property.
the molecularWeight array value
this
InvalidTypeError for invalid data types
Add the provided SubstanceSpecificationStructureIsotopeMolecularWeightComponent value to the molecularWeight array property.
the molecularWeight value
this
InvalidTypeError for invalid data types
true if the molecularWeight property exists and has a value; false otherwise
the relationship property value as a SubstanceSpecificationRelationshipComponent array
Assigns the provided SubstanceSpecificationRelationshipComponent array value to the relationship property.
the relationship array value
this
InvalidTypeError for invalid data types
Add the provided SubstanceSpecificationRelationshipComponent value to the relationship array property.
the relationship value
this
InvalidTypeError for invalid data types
true if the relationship property exists and has a value; false otherwise
the nucleicAcid property value as a Reference object; else an empty Reference object
Assigns the provided NucleicAcid object value to the nucleicAcid property.
the nucleicAcid object value
this
InvalidTypeError for invalid data type or reference value
true if the nucleicAcid property exists and has a value; false otherwise
the polymer property value as a Reference object; else an empty Reference object
Assigns the provided Polymer object value to the polymer property.
the polymer object value
this
InvalidTypeError for invalid data type or reference value
true if the polymer property exists and has a value; false otherwise
the protein property value as a Reference object; else an empty Reference object
Assigns the provided Protein object value to the protein property.
the protein object value
this
InvalidTypeError for invalid data type or reference value
true if the protein property exists and has a value; false otherwise
the sourceMaterial property value as a Reference object; else an empty Reference object
Assigns the provided SourceMaterial object value to the sourceMaterial property.
the sourceMaterial object value
this
InvalidTypeError for invalid data type or reference value
true if the sourceMaterial 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
the JSON value or undefined if the instance is empty
the text property value as a Narrative
Assigns the provided value to the text property.
the text value
this
true if the text property exists and has a value; false otherwise
the contained property value as a Resource array
Assigns the provided Resource array value to the contained property.
the contained array value
this
Add the provided Resource value to the contained array property.
the contained value
this
true if the contained property 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
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 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
the array of modifierExtension values
Assigns the provided array of Extension values to the modifierExtension property.
array of Extensions
this
Determines if the modifierExtension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has 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 modifierExtension property exists and has any values.
AssertionError for invalid url
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
the FHIR resource type as defined by the FHIR specification
the id property value as a PrimitiveType
Assigns the provided PrimitiveType value to the id property.
the id value
this
true if the id property exists and has a value; false otherwise
the id property value as a primitive value
Assigns the provided primitive value to the id property.
the id value
this
PrimitiveTypeError for invalid primitive types
true if the id property exists and has a value; false otherwise
the meta property value as a Meta
Assigns the provided value to the meta property.
the meta value
this
true if the meta property exists and has a value; false otherwise
the implicitRules property value as a PrimitiveType
Assigns the provided PrimitiveType value to the implicitRules property.
the implicitRules value
this
true if the implicitRules property exists and has a value; false otherwise
the implicitRules property value as a primitive value
Assigns the provided primitive value to the implicitRules property.
the implicitRules value
this
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the language property value as a PrimitiveType
Assigns the provided PrimitiveType value to the language property.
the language value
this
true if the language property exists and has a value; false otherwise
the language property value as a primitive value
Assigns the provided primitive value to the language property.
the language value
this
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; false otherwise
true if the instance is a FHIR resource; false otherwise
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 complex or primitive datatype; false otherwise
true if the instance is a FHIR complex datatype; 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
PrivateinitInitialize the source property
PrivateinitInitialize the moiety property
PrivateinitInitialize the property property
PrivateinitInitialize the code property
PrivateinitInitialize the name property
PrivateinitInitialize the molecularWeight property
PrivateinitInitialize the relationship property
SubstanceSpecification Class
Remarks
The detailed description of a substance, typically at a level beyond what is used for prescribing.
FHIR Specification
See
FHIR SubstanceSpecification