SubstanceSourceMaterial class
SubstanceSourceMaterial Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
SubstanceSourceMaterial({@Default(R5ResourceType.SubstanceSourceMaterial) @JsonKey(unknownEnumValue: R5ResourceType.SubstanceSourceMaterial) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<
Resource> ? contained, @JsonKey(name: 'extension') List<FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, CodeableConcept? sourceMaterialClass, CodeableConcept? sourceMaterialType, CodeableConcept? sourceMaterialState, Identifier? organismId, String? organismName, @JsonKey(name: '_organismName') Element? organismNameElement, List<Identifier> ? parentSubstanceId, List<String> ? parentSubstanceName, @JsonKey(name: '_parentSubstanceName') List<Element> ? parentSubstanceNameElement, List<CodeableConcept> ? countryOfOrigin, List<String> ? geographicalLocation, @JsonKey(name: '_geographicalLocation') List<Element> ? geographicalLocationElement, CodeableConcept? developmentStage, List<SubstanceSourceMaterialFractionDescription> ? fractionDescription, SubstanceSourceMaterialOrganism? organism, List<SubstanceSourceMaterialPartDescription> ? partDescription}) -
SubstanceSourceMaterial Source material shall capture information on
the taxonomic and anatomical origins as well as the fraction of a
material that can result in or can be modified to form a substance. This
set of data elements shall be used to define polymer substances isolated
from biological matrices. Taxonomic and anatomical origins shall be
described using a controlled vocabulary as required. This information is
captured for naturally derived polymers ( . starch) and structurally
diverse substances. For Organisms belonging to the Kingdom Plantae the
Substance level defines the fresh material of a single species or
infraspecies, the Herbal Drug and the Herbal preparation. For Herbal
preparations, the fraction information will be captured at the Substance
information level and additional information for herbal extracts will be
captured at the Specified Substance Group 1 information level. See for
further explanation the Substance Class: Structurally Diverse and the
herbal annex.
constfactory
-
SubstanceSourceMaterial.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- SubstanceSourceMaterial.fromJsonString(String source)
-
Acts like a constructor, returns a SubstanceSourceMaterial, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- SubstanceSourceMaterial.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
-
contained
→ List<
Resource> ? -
contained These resources do not have an independent existence apart
from the resource that contains them - they cannot be identified
independently, nor can they have their own independent transaction
scope. This is allowed to be a Parameters resource if and only if it
is referenced by a resource that provides context/meaning.
no setterinherited
-
copyWith
→ $SubstanceSourceMaterialCopyWith<
SubstanceSourceMaterial> -
no setterinherited
-
countryOfOrigin
→ List<
CodeableConcept> ? -
countryOfOrigin The country where the plant material is harvested or
the countries where the plasma is sourced from as laid down in
accordance with the Plasma Master File. For “Plasma-derived
substances” the attribute country of origin provides information about
the countries used for the manufacturing of the Cryopoor plama or
Crioprecipitate.
no setterinherited
- dbId → int?
-
no setterinherited
- developmentStage → CodeableConcept?
-
developmentStage Stage of life for animals, plants, insects and
microorganisms. This information shall be provided only when the
substance is significantly different in these stages (e.g. foetal
bovine serum).
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
extension_ ("extension") 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 managable, 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.
no setterinherited
- fhirId → FhirId?
-
id The logical id of the resource, as used in the URL for the
resource. Once assigned, this value never changes.
no setterinherited
-
fractionDescription
→ List<
SubstanceSourceMaterialFractionDescription> ? -
fractionDescription Many complex materials are fractions of parts of
plants, animals, or minerals. Fraction elements are often necessary to
define both Substances and Specified Group 1 Substances. For
substances derived from Plants, fraction information will be captured
at the Substance information level ( . Oils, Juices and Exudates).
Additional information for Extracts, such as extraction solvent
composition, will be captured at the Specified Substance Group 1
information level. For plasma-derived products fraction information
will be captured at the Substance and the Specified Substance Group 1
levels.
no setterinherited
-
geographicalLocation
→ List<
String> ? -
geographicalLocation The place/region where the plant is harvested or
the places/regions where the animal source material has its habitat.
no setterinherited
-
geographicalLocationElement
→ List<
Element> ? -
geographicalLocationElement ("_geographicalLocation") Extensions for
geographicalLocation
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- implicitRules → FhirUri?
-
implicitRules 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.
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement ("_implicitRules") Extensions for implicitRules
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement ("_language") Extensions for language
no setterinherited
- meta → FhirMeta?
-
meta 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.
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
modifierExtension 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's descendants. Usually
modifier elements provide negation or qualification. To make the use
of extensions safe and managable, 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.Modifier extensions SHALL NOT change the
meaning of any elements on Resource or DomainResource (including
cannot change the meaning of modifierExtension itself).
no setterinherited
- organism → SubstanceSourceMaterialOrganism?
-
organism This subclause describes the organism which the substance is
derived from. For vaccines, the parent organism shall be specified
based on these subclause elements. As an example, full taxonomy will
be described for the Substance Name: ., Leaf.
no setterinherited
- organismId → Identifier?
-
organismId The unique identifier associated with the source material
parent organism shall be specified.
no setterinherited
- organismName → String?
-
organismName The organism accepted Scientific name shall be provided
based on the organism taxonomy.
no setterinherited
- organismNameElement → Element?
-
organismNameElement ("_organismName") Extensions for organismName
no setterinherited
-
parentSubstanceId
→ List<
Identifier> ? -
parentSubstanceId The parent of the herbal drug Ginkgo biloba, Leaf
is the substance ID of the substance (fresh) of Ginkgo biloba L. or
Ginkgo biloba L. (Whole plant).
no setterinherited
-
parentSubstanceName
→ List<
String> ? -
parentSubstanceName The parent substance of the Herbal Drug, or
Herbal preparation.
no setterinherited
-
parentSubstanceNameElement
→ List<
Element> ? -
parentSubstanceNameElement ("_parentSubstanceName") Extensions for
parentSubstanceName
no setterinherited
-
partDescription
→ List<
SubstanceSourceMaterialPartDescription> ? -
partDescription To do.
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
- resourceType → R5ResourceType
-
resourceType This is a SubstanceSourceMaterial resource
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sourceMaterialClass → CodeableConcept?
-
sourceMaterialClass General high level classification of the source
material specific to the origin of the material.
no setterinherited
- sourceMaterialState → CodeableConcept?
-
sourceMaterialState The state of the source material when extracted.
no setterinherited
- sourceMaterialType → CodeableConcept?
-
sourceMaterialType The type of the source material shall be specified
based on a controlled vocabulary. For vaccines, this subclause refers
to the class of infectious agent.
no setterinherited
- text → Narrative?
-
text A human-readable narrative that contains a summary of the
resource and can be used to represent the content of the resource to a
human. The narrative need not encode all the structured data, but is
required to contain sufficient detail to make it "clinically safe" for
a human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
Methods
-
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
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
override
-
updateVersion(
{FhirMeta? oldMeta}) → 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