Data Model Libraries
    Preparing search index...

    Class SubstanceSourceMaterial

    SubstanceSourceMaterial Class

    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.

    FHIR Specification

    • Short: 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
    • Definition: 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.
    • FHIR Version: 5.0.0

    FHIR SubstanceSourceMaterial

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    sourceMaterialClass? sourceMaterialType? sourceMaterialState? organismId? organismName? parentSubstanceId? parentSubstanceName? countryOfOrigin? geographicalLocation? developmentStage? fractionDescription? organism? partDescription?

    Methods

    parse getSourceMaterialClass setSourceMaterialClass hasSourceMaterialClass getSourceMaterialType setSourceMaterialType hasSourceMaterialType getSourceMaterialState setSourceMaterialState hasSourceMaterialState getOrganismId setOrganismId hasOrganismId getOrganismNameElement setOrganismNameElement hasOrganismNameElement getOrganismName setOrganismName hasOrganismName getParentSubstanceId setParentSubstanceId addParentSubstanceId hasParentSubstanceId getParentSubstanceNameElement setParentSubstanceNameElement addParentSubstanceNameElement hasParentSubstanceNameElement getParentSubstanceName setParentSubstanceName addParentSubstanceName hasParentSubstanceName getCountryOfOrigin setCountryOfOrigin addCountryOfOrigin hasCountryOfOrigin getGeographicalLocationElement setGeographicalLocationElement addGeographicalLocationElement hasGeographicalLocationElement getGeographicalLocation setGeographicalLocation addGeographicalLocation hasGeographicalLocation getDevelopmentStage setDevelopmentStage hasDevelopmentStage getFractionDescription setFractionDescription addFractionDescription hasFractionDescription getOrganism setOrganism hasOrganism getPartDescription setPartDescription addPartDescription hasPartDescription fhirType isEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isRequiredFieldsEmpty isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initParentSubstanceId initParentSubstanceName initCountryOfOrigin initGeographicalLocation initFractionDescription initPartDescription

    Constructors

    Properties

    sourceMaterialClass?: CodeableConcept

    SubstanceSourceMaterial.sourceMaterialClass Element

    FHIR Specification

    • Short: General high level classification of the source material specific to the origin of the material
    • Definition: General high level classification of the source material specific to the origin of the material.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    sourceMaterialType?: CodeableConcept

    SubstanceSourceMaterial.sourceMaterialType Element

    FHIR Specification

    • Short: 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
    • Definition: 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.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    sourceMaterialState?: CodeableConcept

    SubstanceSourceMaterial.sourceMaterialState Element

    FHIR Specification

    • Short: The state of the source material when extracted
    • Definition: The state of the source material when extracted.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    organismId?: Identifier

    SubstanceSourceMaterial.organismId Element

    FHIR Specification

    • Short: The unique identifier associated with the source material parent organism shall be specified
    • Definition: The unique identifier associated with the source material parent organism shall be specified.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    organismName?: StringType

    SubstanceSourceMaterial.organismName Element

    FHIR Specification

    • Short: The organism accepted Scientific name shall be provided based on the organism taxonomy
    • Definition: The organism accepted Scientific name shall be provided based on the organism taxonomy.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    parentSubstanceId?: Identifier[]

    SubstanceSourceMaterial.parentSubstanceId Element

    FHIR Specification

    • Short: 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)
    • Definition: 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).
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    parentSubstanceName?: StringType[]

    SubstanceSourceMaterial.parentSubstanceName Element

    FHIR Specification

    • Short: The parent substance of the Herbal Drug, or Herbal preparation
    • Definition: The parent substance of the Herbal Drug, or Herbal preparation.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    countryOfOrigin?: CodeableConcept[]

    SubstanceSourceMaterial.countryOfOrigin Element

    FHIR Specification

    • Short: 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
    • Definition: 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.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    geographicalLocation?: StringType[]

    SubstanceSourceMaterial.geographicalLocation Element

    FHIR Specification

    • Short: The place/region where the plant is harvested or the places/regions where the animal source material has its habitat
    • Definition: The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    developmentStage?: CodeableConcept

    SubstanceSourceMaterial.developmentStage Element

    FHIR Specification

    • Short: 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)
    • Definition: 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).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    fractionDescription?: SubstanceSourceMaterialFractionDescriptionComponent[]

    SubstanceSourceMaterial.fractionDescription Element

    FHIR Specification

    • Short: 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
    • Definition: 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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    organism?: SubstanceSourceMaterialOrganismComponent

    SubstanceSourceMaterial.organism Element

    FHIR Specification

    • Short: 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
    • Definition: 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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    partDescription?: SubstanceSourceMaterialPartDescriptionComponent[]

    SubstanceSourceMaterial.partDescription Element

    FHIR Specification

    • Short: To do
    • Definition: To do.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided SubstanceSourceMaterial JSON to instantiate the SubstanceSourceMaterial data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubstanceSourceMaterial

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to SubstanceSourceMaterial

      Returns undefined | SubstanceSourceMaterial

      SubstanceSourceMaterial data model or undefined for SubstanceSourceMaterial

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      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

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      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

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetSourceMaterialClasssetSourceMaterialClasshasSourceMaterialClassgetSourceMaterialTypesetSourceMaterialTypehasSourceMaterialTypegetSourceMaterialStatesetSourceMaterialStatehasSourceMaterialStategetOrganismIdsetOrganismIdhasOrganismIdgetOrganismNameElementsetOrganismNameElementhasOrganismNameElementgetOrganismNamesetOrganismNamehasOrganismNamegetParentSubstanceIdsetParentSubstanceIdaddParentSubstanceIdhasParentSubstanceIdgetParentSubstanceNameElementsetParentSubstanceNameElementaddParentSubstanceNameElementhasParentSubstanceNameElementgetParentSubstanceNamesetParentSubstanceNameaddParentSubstanceNamehasParentSubstanceNamegetCountryOfOriginsetCountryOfOriginaddCountryOfOriginhasCountryOfOrigingetGeographicalLocationElementsetGeographicalLocationElementaddGeographicalLocationElementhasGeographicalLocationElementgetGeographicalLocationsetGeographicalLocationaddGeographicalLocationhasGeographicalLocationgetDevelopmentStagesetDevelopmentStagehasDevelopmentStagegetFractionDescriptionsetFractionDescriptionaddFractionDescriptionhasFractionDescriptiongetOrganismsetOrganismhasOrganismgetPartDescriptionsetPartDescriptionaddPartDescriptionhasPartDescriptionfhirTypeisEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisRequiredFieldsEmptyisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitParentSubstanceIdinitParentSubstanceNameinitCountryOfOrigininitGeographicalLocationinitFractionDescriptioninitPartDescription