Private OptionalidentifierSubstanceDefinition.identifier Element
Private OptionalversionSubstanceDefinition.version Element
Private OptionalstatusSubstanceDefinition.status Element
Private OptionalclassificationSubstanceDefinition.classification Element
FHIR Specification
CodeableConceptPrivate OptionaldomainSubstanceDefinition.domain Element
Private OptionalgradeSubstanceDefinition.grade Element
FHIR Specification
CodeableConceptPrivate OptionaldescriptionSubstanceDefinition.description Element
Private OptionalinformationSubstanceDefinition.informationSource Element
FHIR Specification
Reference
Private OptionalnoteSubstanceDefinition.note Element
Private OptionalmanufacturerSubstanceDefinition.manufacturer Element
FHIR Specification
Reference
Private OptionalsupplierSubstanceDefinition.supplier Element
FHIR Specification
Reference
Private OptionalmoietySubstanceDefinition.moiety Element
Private OptionalcharacterizationSubstanceDefinition.characterization Element
Private OptionalpropertySubstanceDefinition.property Element
Private OptionalreferenceSubstanceDefinition.referenceInformation Element
FHIR Specification
Reference
Private OptionalmolecularSubstanceDefinition.molecularWeight Element
FHIR Specification
BackboneElementPrivate OptionalstructureSubstanceDefinition.structure Element
Private OptionalcodeSubstanceDefinition.code Element
Private OptionalnameSubstanceDefinition.name Element
Private OptionalrelationshipSubstanceDefinition.relationship Element
Private OptionalnucleicSubstanceDefinition.nucleicAcid Element
FHIR Specification
Reference
Private OptionalpolymerSubstanceDefinition.polymer Element
FHIR Specification
Reference
Private OptionalproteinSubstanceDefinition.protein Element
FHIR Specification
Reference
Private OptionalsourceSubstanceDefinition.sourceMaterial Element
StaticparseParse the provided SubstanceDefinition JSON to instantiate the SubstanceDefinition data model.
JSON representing FHIR SubstanceDefinition
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to SubstanceDefinition
SubstanceDefinition data model or undefined for SubstanceDefinition
JsonError if the provided JSON is not a valid JSON object
the identifier property value as a Identifier array
Assigns the provided Identifier array value to the identifier property.
the identifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the identifier array property.
the identifier value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the version property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the version property.
the version value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the version property exists and has a value; false otherwise
the version property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the version property.
the version value
this
PrimitiveTypeError for invalid primitive types
true if the version 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 classification property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the classification property.
the classification array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the classification array property.
the classification value
this
InvalidTypeError for invalid data types
true if the classification 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 grade property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the grade property.
the grade array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the grade array property.
the grade value
this
InvalidTypeError for invalid data types
true if the grade property exists and has a value; false otherwise
the description property value as a MarkdownType object if defined; else an empty MarkdownType 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 fhirMarkdown 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 informationSource property value as a Reference array
Assigns the provided Reference array value to the informationSource property.
the informationSource array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the informationSource array property.
the informationSource value
this
InvalidTypeError for invalid data type or reference value
true if the informationSource property exists and has a value; false otherwise
the note property value as a Annotation array
Assigns the provided Annotation array value to the note property.
the note array value
this
InvalidTypeError for invalid data types
Add the provided Annotation value to the note array property.
the note value
this
InvalidTypeError for invalid data types
true if the note property exists and has a value; false otherwise
the manufacturer property value as a Reference array
Assigns the provided Reference array value to the manufacturer property.
the manufacturer array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the manufacturer array property.
the manufacturer value
this
InvalidTypeError for invalid data type or reference value
true if the manufacturer property exists and has a value; false otherwise
the supplier property value as a Reference array
Assigns the provided Reference array value to the supplier property.
the supplier array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the supplier array property.
the supplier value
this
InvalidTypeError for invalid data type or reference value
true if the supplier property exists and has a value; false otherwise
the moiety property value as a SubstanceDefinitionMoietyComponent array
Assigns the provided SubstanceDefinitionMoietyComponent array value to the moiety property.
the moiety array value
this
InvalidTypeError for invalid data types
Add the provided SubstanceDefinitionMoietyComponent 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 characterization property value as a SubstanceDefinitionCharacterizationComponent array
Assigns the provided SubstanceDefinitionCharacterizationComponent array value to the characterization property.
the characterization array value
this
InvalidTypeError for invalid data types
Add the provided SubstanceDefinitionCharacterizationComponent value to the characterization array property.
the characterization value
this
InvalidTypeError for invalid data types
true if the characterization property exists and has a value; false otherwise
the property property value as a SubstanceDefinitionPropertyComponent array
Assigns the provided SubstanceDefinitionPropertyComponent array value to the property property.
the property array value
this
InvalidTypeError for invalid data types
Add the provided SubstanceDefinitionPropertyComponent 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('SubstanceDefinition.referenceInformation', ['SubstanceReferenceInformation',])
InvalidTypeError for invalid data type or reference value
true if the referenceInformation property exists and has a value; false otherwise
the molecularWeight property value as a SubstanceDefinitionMolecularWeightComponent array
Assigns the provided SubstanceDefinitionMolecularWeightComponent array value to the molecularWeight property.
the molecularWeight array value
this
InvalidTypeError for invalid data types
Add the provided SubstanceDefinitionMolecularWeightComponent 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 structure property value as a SubstanceDefinitionStructureComponent object if defined; else an empty SubstanceDefinitionStructureComponent 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 SubstanceDefinitionCodeComponent array
Assigns the provided SubstanceDefinitionCodeComponent array value to the code property.
the code array value
this
InvalidTypeError for invalid data types
Add the provided SubstanceDefinitionCodeComponent 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 SubstanceDefinitionNameComponent array
Assigns the provided SubstanceDefinitionNameComponent array value to the name property.
the name array value
this
InvalidTypeError for invalid data types
Add the provided SubstanceDefinitionNameComponent 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 relationship property value as a SubstanceDefinitionRelationshipComponent array
Assigns the provided SubstanceDefinitionRelationshipComponent array value to the relationship property.
the relationship array value
this
InvalidTypeError for invalid data types
Add the provided SubstanceDefinitionRelationshipComponent 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 SubstanceDefinitionSourceMaterialComponent object if defined; else an empty SubstanceDefinitionSourceMaterialComponent object
Assigns the provided SourceMaterial object value to the sourceMaterial property.
the sourceMaterial object value
this
InvalidTypeError for invalid data types
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 identifier property
PrivateinitInitialize the classification property
PrivateinitInitialize the grade property
PrivateinitInitialize the informationSource property
PrivateinitInitialize the note property
PrivateinitInitialize the manufacturer property
PrivateinitInitialize the supplier property
PrivateinitInitialize the moiety property
PrivateinitInitialize the characterization property
PrivateinitInitialize the property property
PrivateinitInitialize the molecularWeight property
PrivateinitInitialize the code property
PrivateinitInitialize the name property
PrivateinitInitialize the relationship property
SubstanceDefinition Class
Remarks
The detailed description of a substance, typically at a level beyond what is used for prescribing.
FHIR Specification
See
FHIR SubstanceDefinition