SubstanceSourceMaterial

@POJOBoilerplate
class SubstanceSourceMaterial(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val organismId: Option[Identifier], val organismName: Option[String], val implicitRules: Option[UriStr], val countryOfOrigin: LitSeq[CodeableConcept], val developmentStage: Option[CodeableConcept], val modifierExtension: LitSeq[Extension], val parentSubstanceId: LitSeq[Identifier], val sourceMaterialType: Option[CodeableConcept], val sourceMaterialClass: Option[CodeableConcept], val sourceMaterialState: Option[CodeableConcept], val parentSubstanceName: LitSeq[String], val geographicalLocation: LitSeq[String], val partDescription: LitSeq[PartDescription], val fractionDescription: LitSeq[FractionDescription], val organism: Option[Organism], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

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.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value Params
contained
  • 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.
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.
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).
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 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.
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.
geographicalLocation
  • The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
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.
language
  • The base language in which the resource is written.
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.
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 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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.
organismId
  • The unique identifier associated with the source material parent organism shall be specified.
organismName
  • The organism accepted Scientific name shall be provided based on the organism taxonomy.
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).
parentSubstanceName
  • The parent substance of the Herbal Drug, or Herbal preparation.
partDescription
  • To do.
sourceMaterialClass
  • General high level classification of the source material specific to the origin of the material.
sourceMaterialState
  • The state of the source material when extracted.
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.
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.
Constructor

Introduces the fields organismId, organismName, countryOfOrigin, developmentStage, parentSubstanceId, sourceMaterialType, sourceMaterialClass, sourceMaterialState, parentSubstanceName, geographicalLocation, partDescription, fractionDescription, organism.

Companion
object
class DomainResource
class Resource
class FHIRObject
trait FHIRComponent
trait Utils
class Object
trait Matchable
class Any

Type members

Inherited classlikes

object extensions
Inherited from
FHIRObject
object ids
Inherited from
FHIRObject

Inherited types

type FieldToElementLookup = TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
Inherited from
FHIRObject

Value members

Inherited methods

final
def >>[T](fn: T => T)(implicit tt: LTag[T]): SubstanceSourceMaterial

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_] or an Option[_]
  • It may require a type parameter sometimes (e.g. sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET } )
Inherited from
FHIRObject
final
def >>=[T, F[_] : Monad](fn: T => F[T])(implicit evidence$7: Monad[F], tt: LTag[T]): F[SubstanceSourceMaterial]
Inherited from
FHIRObject
final
def ^^[From, To](fn: From => To)(implicit tt: LTag[From]): LitSeq[To]

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Inherited from
FHIRObject
final
def ^^^[T](implicit tt: LTag[T]): LitSeq[T]
Inherited from
FHIRObject
def companionClassName[T](tag: LTag[T]): String
Inherited from
Utils
def companionOf[T <: FHIRObject : ClassTag](implicit evidence$1: ClassTag[T], tag: LTag[T]): CompanionFor[T]
Inherited from
Utils
def constructor: Constructor[_]
Inherited from
FHIRComponent
def decodeMethodFor[T <: FHIRObject : ClassTag](implicit evidence$2: ClassTag[T], tag: LTag[T], params: DecoderParams): HCursor => Try[T]
Inherited from
Utils
override
def equals(obj: Any): Boolean
Definition Classes
FHIRObject -> Any
Inherited from
FHIRObject
def fields: Seq[FHIRComponentField[_]]
Inherited from
FHIRObject
def getFieldByClass[T](name: String, clazz: Class[T]): LitSeq[T]
Inherited from
FHIRComponent
def getFieldByType[T : LTag](name: String): LitSeq[T]
Inherited from
FHIRComponent
def getIdentifier: Option[String]
Inherited from
Resource
def getMostSpecificIdentifier: Option[String]
Inherited from
Resource
def getVersionedIdentifier: Option[String]
Inherited from
Resource
override
def hashCode(): Int
Definition Classes
FHIRObject -> Any
Inherited from
FHIRObject
def modifyField[T : LTag, Up >: SubstanceSourceMaterial <: FHIRObject](fieldName: String, modify: T => T)(implicit evidence$5: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from
FHIRObject
def modifyFieldUnsafe[T, Up >: SubstanceSourceMaterial <: FHIRObject](fieldName: String, modify: T => T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from
FHIRObject
final
def nodalExtract[From, To](klass: Class[From], fn: From => To): LitSeq[To]

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Inherited from
FHIRObject
final
def nodalGetByClass[Target](klass: Class[Target]): LitSeq[Target]

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Inherited from
FHIRObject
final
def nodalMap[T](klass: Class[T], fn: T => T): SubstanceSourceMaterial

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
Inherited from
FHIRObject
def setFromField[T, UpType >: SubstanceSourceMaterial <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(newVal: T): UpType
Inherited from
FHIRObject
def thisClassName: String
Inherited from
FHIRObject
def toClass[T](klass: Class[T]): Option[T]
Inherited from
FHIRObject
override
def toString: String
Definition Classes
FHIRObject -> Any
Inherited from
FHIRObject
def toType[T](implicit ct: ClassTag[T]): Option[T]
Inherited from
FHIRObject
def updateFromField[T, UpType >: SubstanceSourceMaterial <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(fn: T => T): UpType
Inherited from
FHIRObject
def updatePrimitiveAttributes(fn: FieldToElementLookup => FieldToElementLookup): SubstanceSourceMaterial
Inherited from
FHIRObject
def withField[T : LTag, Up >: SubstanceSourceMaterial <: FHIRObject](fieldName: String, value: T)(implicit evidence$6: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from
FHIRObject
def withFieldUnsafe[T, Up >: SubstanceSourceMaterial <: FHIRObject](fieldName: String, value: T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from
FHIRObject
def withFields[Up >: SubstanceSourceMaterial <: FHIRObject](replacementFields: (String, Any)*)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from
FHIRObject
def withPrimitiveAttributes(a: FieldToElementLookup): SubstanceSourceMaterial
Inherited from
FHIRObject

Concrete fields

override
val contained: LitSeq[Resource]
val countryOfOrigin: LitSeq[CodeableConcept]
val developmentStage: Option[CodeableConcept]
override
val extension: LitSeq[Extension]
val geographicalLocation: LitSeq[String]
override
val id: Option[String]
override
val implicitRules: Option[UriStr]
override
val language: Option[LANGUAGES]
override
val meta: Option[Meta]
override
val modifierExtension: LitSeq[Extension]
val organism: Option[Organism]
val organismId: Option[Identifier]
val organismName: Option[String]
val parentSubstanceId: LitSeq[Identifier]
val parentSubstanceName: LitSeq[String]
override
val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
val sourceMaterialClass: Option[CodeableConcept]
val sourceMaterialState: Option[CodeableConcept]
val sourceMaterialType: Option[CodeableConcept]
override
val text: Option[Narrative]
override
val thisTypeName: String

Inherited fields

Inherited from
FHIRObject