SubstanceDefinition class

SubstanceDefinition The detailed description of a substance, typically at a level beyond what is used for prescribing.

Inheritance
Available extensions

Constructors

SubstanceDefinition({FhirString? id, FhirMeta? meta, FhirUri? implicitRules, AllLanguages? language, Narrative? text, List<Resource>? contained, List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, List<Identifier>? identifier, FhirString? version, CodeableConcept? status, List<CodeableConcept>? classification, CodeableConcept? domain, List<CodeableConcept>? grade, FhirMarkdown? description, List<Reference>? informationSource, List<Annotation>? note, List<Reference>? manufacturer, List<Reference>? supplier, List<SubstanceDefinitionMoiety>? moiety, List<SubstanceDefinitionCharacterization>? characterization, List<SubstanceDefinitionProperty>? property, Reference? referenceInformation, List<SubstanceDefinitionMolecularWeight>? molecularWeight, SubstanceDefinitionStructure? structure, List<SubstanceDefinitionCode>? code, List<SubstanceDefinitionName>? name, List<SubstanceDefinitionRelationship>? relationship, Reference? nucleicAcid, Reference? polymer, Reference? protein, SubstanceDefinitionSourceMaterial? sourceMaterial})
Primary constructor for SubstanceDefinition
const
SubstanceDefinition.fromJson(Map<String, dynamic> json)
Factory constructor that accepts Map<String, dynamic> as an argument
factory
SubstanceDefinition.fromJsonString(String source)
Factory constructor for SubstanceDefinition that takes in a String Convenience method to avoid the json Encoding/Decoding normally required to get data from a String
factory
SubstanceDefinition.fromYaml(dynamic yaml)
Deserialize SubstanceDefinition from a String or YamlMap object
factory

Properties

characterization → List<SubstanceDefinitionCharacterization>?
characterization General specifications for this substance.
final
classification → List<CodeableConcept>?
classification A high level categorization, e.g. polymer or nucleic acid, or food, chemical, biological, or a lower level such as the general types of polymer (linear or branch chain) or type of impurity (process related or contaminant).
final
code → List<SubstanceDefinitionCode>?
code Codes associated with the substance.
final
contained → List<Resource>?
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope
finalinherited
copyWith → $SubstanceDefinitionCopyWith<SubstanceDefinition>
Copy function for SubstanceDefinition Returns a copy of the current instance with the provided fields modified. If a field is not provided, it will retain its original value. If a null is provided, this will clearn the field, unless the field is required, in which case it will keep its current value.
no setteroverride
copyWith → $SubstanceDefinitionCopyWith<SubstanceDefinition>

Available on SubstanceDefinition, provided by the SubstanceDefinitionCopyWithExtension extension

no setter
description → FhirMarkdown?
description Textual description of the substance.
final
domain → CodeableConcept?
domain If the substance applies to human or veterinary use.
final
extension_ → List<FhirExtension>?
May be used to represent additional information that is not part of the basic definition of the resource. 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.",
finalinherited
fhirType → String
Returns the FHIR type of the object.
no setteroverride
grade → List<CodeableConcept>?
grade The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard).
final
hashCode → int
The hash code for this object.
no setterinherited
hasPrimitiveValue → bool
Checks if the object has a primitive value.
no setterinherited
id → FhirString?
The logical id of the resource, as used in the URL for the resource.
finalinherited
identifier → List<Identifier>?
identifier Identifier by which this substance is known.
final
implicitRules → FhirUri?
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
finalinherited
informationSource → List<Reference>?
informationSource Supporting literature.
final
isMetadataBased → bool
All FhirBases and Resources are NOT metadata based
no setterinherited
isPrimitive → bool
Checks if the object is primitive.
no setterinherited
language → AllLanguages?
The base language in which the resource is written. This should be the language of the text value in the content element when a text value is present.
finalinherited
manufacturer → List<Reference>?
manufacturer The entity that creates, makes, produces or fabricates the substance. This is a set of potential manufacturers but is not necessarily comprehensive.
final
meta → FhirMeta?
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
finalinherited
modifierExtension → List<FhirExtension>?
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s 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 is allowed to 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
finalinherited
moiety → List<SubstanceDefinitionMoiety>?
moiety Moiety, for structural modifications.
final
molecularWeight → List<SubstanceDefinitionMolecularWeight>?
molecularWeight The average mass of a molecule of a compound compared to 1/12 the mass of carbon 12 and calculated as the sum of the atomic weights of the constituent atoms.
final
name → List<SubstanceDefinitionName>?
name Names applicable to this substance.
final
note → List<Annotation>?
note Textual comment about the substance's catalogue or registry record.
final
nucleicAcid → Reference?
nucleicAcid Data items specific to nucleic acids.
final
path → String
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
polymer → Reference?
polymer Data items specific to polymers.
final
primitiveValue → String?
Retrieves the primitive value of the object.
no setterinherited
property → List<SubstanceDefinitionProperty>?
property General specifications for this substance.
final
protein → Reference?
protein Data items specific to proteins.
final
referenceInformation → Reference?
referenceInformation General information detailing this substance.
final
relationship → List<SubstanceDefinitionRelationship>?
relationship A link between this substance and another, with details of the relationship.
final
resourceType → R5ResourceType
The type of resource
finalinherited
resourceTypeString → String
produce a string of the resourceType
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sourceMaterial → SubstanceDefinitionSourceMaterial?
sourceMaterial Material or taxonomic/anatomical source for the substance.
final
status → CodeableConcept?
status Status of substance within the catalogue e.g. active, retired.
final
structure → SubstanceDefinitionStructure?
structure Structural information.
final
supplier → List<Reference>?
supplier An entity that is the source for the substance. It may be different from the manufacturer. Supplier is synonymous to a distributor.
final
text → Narrative?
A human-readable summary of the resource conveying the essential clinical and business information for the resource.",
finalinherited
thisReference → Reference
Convenience method to return a Reference referring to that Resource
no setterinherited
version → FhirString?
version A business level version identifier of the substance.
final

Methods

clone() → SubstanceDefinition
Subclasses must implement the clone method.
override
compareDeepStrings(String? s1, String? s2, bool allowNull) → bool
Checks if the object is equal to another object.
inherited
equalsDeep(FhirBase? o) → bool
Performs a deep comparison between two instances.
override
getChildByName(String name) → FhirBase?
Retrieves a single field value by its name.
override
getChildrenByName(String fieldName, [bool checkValid = false]) → List<FhirBase>
Retrieves all matching child fields by name. Optionally validates the name.
override
hasType(List<String> names) → bool
Checks if the object has a given type.
inherited
hasValues() → bool
Checks if the object has values.
inherited
isAs<T extends FhirBase>() → T?
Returns an Object cast as a Type if it is that type.
inherited
isEmpty() → bool
Checks if the object is empty.
inherited
listChildrenNames() → List<String>
Lists the JSON keys for the object.
override
newId() → Resource
returns the same resource with a new ID (even if there is already an ID present)
inherited
newIdIfNoId() → Resource
returns the same resource with a new ID if there is no current ID
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
prettyPrint() → String
Converts the object to a pretty JSON string.
inherited
toJson() → Map<String, dynamic>
Returns a Map<String, dynamic> of the DomainResource
override
toJsonString() → String
Converts the object to a JSON string.
inherited
toString() → String
A string representation of this object.
inherited
toYaml() → String
Converts the object to a YAML string.
inherited
updateVersion({FhirMeta? oldMeta, bool versionIdAsTime = false}) → Resource
Updates the meta field of this Resource, updates the meta.lastUpdated field, adds 1 to the version number
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited