15.14 Resource SubstanceSourceMaterial - Content

Name	Flags	Card.	Type	Description & Constraints
SubstanceSourceMaterial	TU		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 Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
sourceMaterialClass	Σ	0..1	CodeableConcept	General high level classification of the source material specific to the origin of the material
sourceMaterialType	Σ	0..1	CodeableConcept	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
sourceMaterialState	Σ	0..1	CodeableConcept	The state of the source material when extracted
organismId	Σ	0..1	Identifier	The unique identifier associated with the source material parent organism shall be specified
organismName	Σ	0..1	string	The organism accepted Scientific name shall be provided based on the organism taxonomy
parentSubstanceId	Σ	0..*	Identifier	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	Σ	0..*	string	The parent substance of the Herbal Drug, or Herbal preparation
countryOfOrigin	Σ	0..*	CodeableConcept	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
geographicalLocation	Σ	0..*	string	The place/region where the plant is harvested or the places/regions where the animal source material has its habitat
developmentStage	Σ	0..1	CodeableConcept	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)
fractionDescription	Σ	0..*	BackboneElement	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
fraction	Σ	0..1	string	This element is capturing information about the fraction of a plant part, or human plasma for fractionation
materialType	Σ	0..1	CodeableConcept	The specific type of the material constituting the component. For Herbal preparations the particulars of the extracts (liquid/dry) is described in Specified Substance Group 1
organism	Σ	0..1	BackboneElement	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
family	Σ	0..1	CodeableConcept	The family of an organism shall be specified
genus	Σ	0..1	CodeableConcept	The genus of an organism shall be specified; refers to the Latin epithet of the genus element of the plant/animal scientific name; it is present in names for genera, species and infraspecies
species	Σ	0..1	CodeableConcept	The species of an organism shall be specified; refers to the Latin epithet of the species of the plant/animal; it is present in names for species and infraspecies
intraspecificType	Σ	0..1	CodeableConcept	The Intraspecific type of an organism shall be specified
intraspecificDescription	Σ	0..1	string	The intraspecific description of an organism shall be specified based on a controlled vocabulary. For Influenza Vaccine, the intraspecific description shall contain the syntax of the antigen in line with the WHO convention
author	Σ	0..*	BackboneElement	4.9.13.6.1 Author type (Conditional)
authorType	Σ	0..1	CodeableConcept	The type of author of an organism species shall be specified. The parenthetical author of an organism species refers to the first author who published the plant/animal name (of any rank). The primary author of an organism species refers to the first author(s), who validly published the plant/animal name
authorDescription	Σ	0..1	string	The author of an organism species shall be specified. The author year of an organism shall also be specified when applicable; refers to the year in which the first author(s) published the infraspecific plant/animal name (of any rank)
hybrid	Σ	0..1	BackboneElement	4.9.13.8.1 Hybrid species maternal organism ID (Optional)
maternalOrganismId	Σ	0..1	string	The identifier of the maternal species constituting the hybrid organism shall be specified based on a controlled vocabulary. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal
maternalOrganismName	Σ	0..1	string	The name of the maternal species constituting the hybrid organism shall be specified. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal
paternalOrganismId	Σ	0..1	string	The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary
paternalOrganismName	Σ	0..1	string	The name of the paternal species constituting the hybrid organism shall be specified
hybridType	Σ	0..1	CodeableConcept	The hybrid type of an organism shall be specified
organismGeneral	Σ	0..1	BackboneElement	4.9.13.7.1 Kingdom (Conditional)
kingdom	Σ	0..1	CodeableConcept	The kingdom of an organism shall be specified
phylum	Σ	0..1	CodeableConcept	The phylum of an organism shall be specified
class	Σ	0..1	CodeableConcept	The class of an organism shall be specified
order	Σ	0..1	CodeableConcept	The order of an organism shall be specified,
partDescription	Σ	0..*	BackboneElement	To do
part	Σ	0..1	CodeableConcept	Entity of anatomical origin of source material within an organism
partLocation	Σ	0..1	CodeableConcept	The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply
Documentation for this format

See the Extensions for this resource

<SubstanceSourceMaterial xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <sourceMaterialClass><!-- 0..1 CodeableConcept General high level classification of the source material specific to the origin of the material --></sourceMaterialClass>
 <sourceMaterialType><!-- 0..1 CodeableConcept 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 --></sourceMaterialType>
 <sourceMaterialState><!-- 0..1 CodeableConcept The state of the source material when extracted --></sourceMaterialState>
 <organismId><!-- 0..1 Identifier The unique identifier associated with the source material parent organism shall be specified --></organismId>
 <organismName value="[string]"/><!-- 0..1 The organism accepted Scientific name shall be provided based on the organism taxonomy -->
 <parentSubstanceId><!-- 0..* Identifier 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) --></parentSubstanceId>
 <parentSubstanceName value="[string]"/><!-- 0..* The parent substance of the Herbal Drug, or Herbal preparation -->
 <countryOfOrigin><!-- 0..* CodeableConcept 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 --></countryOfOrigin>
 <geographicalLocation value="[string]"/><!-- 0..* The place/region where the plant is harvested or the places/regions where the animal source material has its habitat -->
 <developmentStage><!-- 0..1 CodeableConcept 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) --></developmentStage>
 <fractionDescription>  <!-- 0..* 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 -->
  <fraction value="[string]"/><!-- 0..1 This element is capturing information about the fraction of a plant part, or human plasma for fractionation -->
  <materialType><!-- 0..1 CodeableConcept The specific type of the material constituting the component. For Herbal preparations the particulars of the extracts (liquid/dry) is described in Specified Substance Group 1 --></materialType>
 </fractionDescription>
 <organism>  <!-- 0..1 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 -->
  <family><!-- 0..1 CodeableConcept The family of an organism shall be specified --></family>
  <genus><!-- 0..1 CodeableConcept The genus of an organism shall be specified; refers to the Latin epithet of the genus element of the plant/animal scientific name; it is present in names for genera, species and infraspecies --></genus>
  <species><!-- 0..1 CodeableConcept The species of an organism shall be specified; refers to the Latin epithet of the species of the plant/animal; it is present in names for species and infraspecies --></species>
  <intraspecificType><!-- 0..1 CodeableConcept The Intraspecific type of an organism shall be specified --></intraspecificType>
  <intraspecificDescription value="[string]"/><!-- 0..1 The intraspecific description of an organism shall be specified based on a controlled vocabulary. For Influenza Vaccine, the intraspecific description shall contain the syntax of the antigen in line with the WHO convention -->
  <author>  <!-- 0..* 4.9.13.6.1 Author type (Conditional) -->
   <authorType><!-- 0..1 CodeableConcept The type of author of an organism species shall be specified. The parenthetical author of an organism species refers to the first author who published the plant/animal name (of any rank). The primary author of an organism species refers to the first author(s), who validly published the plant/animal name --></authorType>
   <authorDescription value="[string]"/><!-- 0..1 The author of an organism species shall be specified. The author year of an organism shall also be specified when applicable; refers to the year in which the first author(s) published the infraspecific plant/animal name (of any rank) -->
  </author>
  <hybrid>  <!-- 0..1 4.9.13.8.1 Hybrid species maternal organism ID (Optional) -->
   <maternalOrganismId value="[string]"/><!-- 0..1 The identifier of the maternal species constituting the hybrid organism shall be specified based on a controlled vocabulary. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal -->
   <maternalOrganismName value="[string]"/><!-- 0..1 The name of the maternal species constituting the hybrid organism shall be specified. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal -->
   <paternalOrganismId value="[string]"/><!-- 0..1 The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary -->
   <paternalOrganismName value="[string]"/><!-- 0..1 The name of the paternal species constituting the hybrid organism shall be specified -->
   <hybridType><!-- 0..1 CodeableConcept The hybrid type of an organism shall be specified --></hybridType>
  </hybrid>
  <organismGeneral>  <!-- 0..1 4.9.13.7.1 Kingdom (Conditional) -->
   <kingdom><!-- 0..1 CodeableConcept The kingdom of an organism shall be specified --></kingdom>
   <phylum><!-- 0..1 CodeableConcept The phylum of an organism shall be specified --></phylum>
   <class><!-- 0..1 CodeableConcept The class of an organism shall be specified --></class>
   <order><!-- 0..1 CodeableConcept The order of an organism shall be specified, --></order>
  </organismGeneral>
 </organism>
 <partDescription>  <!-- 0..* To do -->
  <part><!-- 0..1 CodeableConcept Entity of anatomical origin of source material within an organism --></part>
  <partLocation><!-- 0..1 CodeableConcept The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply --></partLocation>
 </partDescription>
</SubstanceSourceMaterial>

{
  "resourceType" : "SubstanceSourceMaterial",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "sourceMaterialClass" : { CodeableConcept }, // General high level classification of the source material specific to the origin of the material
  "sourceMaterialType" : { CodeableConcept }, // 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
  "sourceMaterialState" : { CodeableConcept }, // The state of the source material when extracted
  "organismId" : { Identifier }, // The unique identifier associated with the source material parent organism shall be specified
  "organismName" : "<string>", // The organism accepted Scientific name shall be provided based on the organism taxonomy
  "parentSubstanceId" : [{ Identifier }], // 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" : ["<string>"], // The parent substance of the Herbal Drug, or Herbal preparation
  "countryOfOrigin" : [{ CodeableConcept }], // 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
  "geographicalLocation" : ["<string>"], // The place/region where the plant is harvested or the places/regions where the animal source material has its habitat
  "developmentStage" : { CodeableConcept }, // 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)
  "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
    "fraction" : "<string>", // This element is capturing information about the fraction of a plant part, or human plasma for fractionation
    "materialType" : { CodeableConcept } // The specific type of the material constituting the component. For Herbal preparations the particulars of the extracts (liquid/dry) is described in Specified Substance Group 1
  }],
  "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
    "family" : { CodeableConcept }, // The family of an organism shall be specified
    "genus" : { CodeableConcept }, // The genus of an organism shall be specified; refers to the Latin epithet of the genus element of the plant/animal scientific name; it is present in names for genera, species and infraspecies
    "species" : { CodeableConcept }, // The species of an organism shall be specified; refers to the Latin epithet of the species of the plant/animal; it is present in names for species and infraspecies
    "intraspecificType" : { CodeableConcept }, // The Intraspecific type of an organism shall be specified
    "intraspecificDescription" : "<string>", // The intraspecific description of an organism shall be specified based on a controlled vocabulary. For Influenza Vaccine, the intraspecific description shall contain the syntax of the antigen in line with the WHO convention
    "author" : [{ // 4.9.13.6.1 Author type (Conditional)
      "authorType" : { CodeableConcept }, // The type of author of an organism species shall be specified. The parenthetical author of an organism species refers to the first author who published the plant/animal name (of any rank). The primary author of an organism species refers to the first author(s), who validly published the plant/animal name
      "authorDescription" : "<string>" // The author of an organism species shall be specified. The author year of an organism shall also be specified when applicable; refers to the year in which the first author(s) published the infraspecific plant/animal name (of any rank)
    }],
    "hybrid" : { // 4.9.13.8.1 Hybrid species maternal organism ID (Optional)
      "maternalOrganismId" : "<string>", // The identifier of the maternal species constituting the hybrid organism shall be specified based on a controlled vocabulary. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal
      "maternalOrganismName" : "<string>", // The name of the maternal species constituting the hybrid organism shall be specified. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal
      "paternalOrganismId" : "<string>", // The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary
      "paternalOrganismName" : "<string>", // The name of the paternal species constituting the hybrid organism shall be specified
      "hybridType" : { CodeableConcept } // The hybrid type of an organism shall be specified
    },
    "organismGeneral" : { // 4.9.13.7.1 Kingdom (Conditional)
      "kingdom" : { CodeableConcept }, // The kingdom of an organism shall be specified
      "phylum" : { CodeableConcept }, // The phylum of an organism shall be specified
      "class" : { CodeableConcept }, // The class of an organism shall be specified
      "order" : { CodeableConcept } // The order of an organism shall be specified,
    }
  },
  "partDescription" : [{ // To do
    "part" : { CodeableConcept }, // Entity of anatomical origin of source material within an organism
    "partLocation" : { CodeableConcept } // The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply
  }]
}

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:SubstanceSourceMaterial;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:sourceMaterialClass [ CodeableConcept ] ; # 0..1 General high level classification of the source material specific to the origin of the material
  fhir:sourceMaterialType [ CodeableConcept ] ; # 0..1 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:sourceMaterialState [ CodeableConcept ] ; # 0..1 The state of the source material when extracted
  fhir:organismId [ Identifier ] ; # 0..1 The unique identifier associated with the source material parent organism shall be specified
  fhir:organismName [ string ] ; # 0..1 The organism accepted Scientific name shall be provided based on the organism taxonomy
  fhir:parentSubstanceId  ( [ Identifier ] ... ) ; # 0..* 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:parentSubstanceName  ( [ string ] ... ) ; # 0..* The parent substance of the Herbal Drug, or Herbal preparation
  fhir:countryOfOrigin  ( [ CodeableConcept ] ... ) ; # 0..* 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:geographicalLocation  ( [ string ] ... ) ; # 0..* The place/region where the plant is harvested or the places/regions where the animal source material has its habitat
  fhir:developmentStage [ CodeableConcept ] ; # 0..1 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:fractionDescription ( [ # 0..* 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:fraction [ string ] ; # 0..1 This element is capturing information about the fraction of a plant part, or human plasma for fractionation
    fhir:materialType [ CodeableConcept ] ; # 0..1 The specific type of the material constituting the component. For Herbal preparations the particulars of the extracts (liquid/dry) is described in Specified Substance Group 1
  ] ... ) ;
  fhir:organism [ # 0..1 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:family [ CodeableConcept ] ; # 0..1 The family of an organism shall be specified
    fhir:genus [ CodeableConcept ] ; # 0..1 The genus of an organism shall be specified; refers to the Latin epithet of the genus element of the plant/animal scientific name; it is present in names for genera, species and infraspecies
    fhir:species [ CodeableConcept ] ; # 0..1 The species of an organism shall be specified; refers to the Latin epithet of the species of the plant/animal; it is present in names for species and infraspecies
    fhir:intraspecificType [ CodeableConcept ] ; # 0..1 The Intraspecific type of an organism shall be specified
    fhir:intraspecificDescription [ string ] ; # 0..1 The intraspecific description of an organism shall be specified based on a controlled vocabulary. For Influenza Vaccine, the intraspecific description shall contain the syntax of the antigen in line with the WHO convention
    fhir:author ( [ # 0..* 4.9.13.6.1 Author type (Conditional)
      fhir:authorType [ CodeableConcept ] ; # 0..1 The type of author of an organism species shall be specified. The parenthetical author of an organism species refers to the first author who published the plant/animal name (of any rank). The primary author of an organism species refers to the first author(s), who validly published the plant/animal name
      fhir:authorDescription [ string ] ; # 0..1 The author of an organism species shall be specified. The author year of an organism shall also be specified when applicable; refers to the year in which the first author(s) published the infraspecific plant/animal name (of any rank)
    ] ... ) ;
    fhir:hybrid [ # 0..1 4.9.13.8.1 Hybrid species maternal organism ID (Optional)
      fhir:maternalOrganismId [ string ] ; # 0..1 The identifier of the maternal species constituting the hybrid organism shall be specified based on a controlled vocabulary. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal
      fhir:maternalOrganismName [ string ] ; # 0..1 The name of the maternal species constituting the hybrid organism shall be specified. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal
      fhir:paternalOrganismId [ string ] ; # 0..1 The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary
      fhir:paternalOrganismName [ string ] ; # 0..1 The name of the paternal species constituting the hybrid organism shall be specified
      fhir:hybridType [ CodeableConcept ] ; # 0..1 The hybrid type of an organism shall be specified
    ] ;
    fhir:organismGeneral [ # 0..1 4.9.13.7.1 Kingdom (Conditional)
      fhir:kingdom [ CodeableConcept ] ; # 0..1 The kingdom of an organism shall be specified
      fhir:phylum [ CodeableConcept ] ; # 0..1 The phylum of an organism shall be specified
      fhir:class [ CodeableConcept ] ; # 0..1 The class of an organism shall be specified
      fhir:order [ CodeableConcept ] ; # 0..1 The order of an organism shall be specified,
    ] ;
  ] ;
  fhir:partDescription ( [ # 0..* To do
    fhir:part [ CodeableConcept ] ; # 0..1 Entity of anatomical origin of source material within an organism
    fhir:partLocation [ CodeableConcept ] ; # 0..1 The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply
  ] ... ) ;
]

See the Full Difference for further information

This analysis is available as XML or JSON.

Name	Flags	Card.	Type	Description & Constraints
SubstanceSourceMaterial	TU		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 Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
sourceMaterialClass	Σ	0..1	CodeableConcept	General high level classification of the source material specific to the origin of the material
sourceMaterialType	Σ	0..1	CodeableConcept	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
sourceMaterialState	Σ	0..1	CodeableConcept	The state of the source material when extracted
organismId	Σ	0..1	Identifier	The unique identifier associated with the source material parent organism shall be specified
organismName	Σ	0..1	string	The organism accepted Scientific name shall be provided based on the organism taxonomy
parentSubstanceId	Σ	0..*	Identifier	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	Σ	0..*	string	The parent substance of the Herbal Drug, or Herbal preparation
countryOfOrigin	Σ	0..*	CodeableConcept	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
geographicalLocation	Σ	0..*	string	The place/region where the plant is harvested or the places/regions where the animal source material has its habitat
developmentStage	Σ	0..1	CodeableConcept	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)
fractionDescription	Σ	0..*	BackboneElement	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
fraction	Σ	0..1	string	This element is capturing information about the fraction of a plant part, or human plasma for fractionation
materialType	Σ	0..1	CodeableConcept	The specific type of the material constituting the component. For Herbal preparations the particulars of the extracts (liquid/dry) is described in Specified Substance Group 1
organism	Σ	0..1	BackboneElement	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
family	Σ	0..1	CodeableConcept	The family of an organism shall be specified
genus	Σ	0..1	CodeableConcept	The genus of an organism shall be specified; refers to the Latin epithet of the genus element of the plant/animal scientific name; it is present in names for genera, species and infraspecies
species	Σ	0..1	CodeableConcept	The species of an organism shall be specified; refers to the Latin epithet of the species of the plant/animal; it is present in names for species and infraspecies
intraspecificType	Σ	0..1	CodeableConcept	The Intraspecific type of an organism shall be specified
intraspecificDescription	Σ	0..1	string	The intraspecific description of an organism shall be specified based on a controlled vocabulary. For Influenza Vaccine, the intraspecific description shall contain the syntax of the antigen in line with the WHO convention
author	Σ	0..*	BackboneElement	4.9.13.6.1 Author type (Conditional)
authorType	Σ	0..1	CodeableConcept	The type of author of an organism species shall be specified. The parenthetical author of an organism species refers to the first author who published the plant/animal name (of any rank). The primary author of an organism species refers to the first author(s), who validly published the plant/animal name
authorDescription	Σ	0..1	string	The author of an organism species shall be specified. The author year of an organism shall also be specified when applicable; refers to the year in which the first author(s) published the infraspecific plant/animal name (of any rank)
hybrid	Σ	0..1	BackboneElement	4.9.13.8.1 Hybrid species maternal organism ID (Optional)
maternalOrganismId	Σ	0..1	string	The identifier of the maternal species constituting the hybrid organism shall be specified based on a controlled vocabulary. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal
maternalOrganismName	Σ	0..1	string	The name of the maternal species constituting the hybrid organism shall be specified. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal
paternalOrganismId	Σ	0..1	string	The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary
paternalOrganismName	Σ	0..1	string	The name of the paternal species constituting the hybrid organism shall be specified
hybridType	Σ	0..1	CodeableConcept	The hybrid type of an organism shall be specified
organismGeneral	Σ	0..1	BackboneElement	4.9.13.7.1 Kingdom (Conditional)
kingdom	Σ	0..1	CodeableConcept	The kingdom of an organism shall be specified
phylum	Σ	0..1	CodeableConcept	The phylum of an organism shall be specified
class	Σ	0..1	CodeableConcept	The class of an organism shall be specified
order	Σ	0..1	CodeableConcept	The order of an organism shall be specified,
partDescription	Σ	0..*	BackboneElement	To do
part	Σ	0..1	CodeableConcept	Entity of anatomical origin of source material within an organism
partLocation	Σ	0..1	CodeableConcept	The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply
Documentation for this format

See the Extensions for this resource

<SubstanceSourceMaterial xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <sourceMaterialClass><!-- 0..1 CodeableConcept General high level classification of the source material specific to the origin of the material --></sourceMaterialClass>
 <sourceMaterialType><!-- 0..1 CodeableConcept 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 --></sourceMaterialType>
 <sourceMaterialState><!-- 0..1 CodeableConcept The state of the source material when extracted --></sourceMaterialState>
 <organismId><!-- 0..1 Identifier The unique identifier associated with the source material parent organism shall be specified --></organismId>
 <organismName value="[string]"/><!-- 0..1 The organism accepted Scientific name shall be provided based on the organism taxonomy -->
 <parentSubstanceId><!-- 0..* Identifier 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) --></parentSubstanceId>
 <parentSubstanceName value="[string]"/><!-- 0..* The parent substance of the Herbal Drug, or Herbal preparation -->
 <countryOfOrigin><!-- 0..* CodeableConcept 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 --></countryOfOrigin>
 <geographicalLocation value="[string]"/><!-- 0..* The place/region where the plant is harvested or the places/regions where the animal source material has its habitat -->
 <developmentStage><!-- 0..1 CodeableConcept 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) --></developmentStage>
 <fractionDescription>  <!-- 0..* 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 -->
  <fraction value="[string]"/><!-- 0..1 This element is capturing information about the fraction of a plant part, or human plasma for fractionation -->
  <materialType><!-- 0..1 CodeableConcept The specific type of the material constituting the component. For Herbal preparations the particulars of the extracts (liquid/dry) is described in Specified Substance Group 1 --></materialType>
 </fractionDescription>
 <organism>  <!-- 0..1 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 -->
  <family><!-- 0..1 CodeableConcept The family of an organism shall be specified --></family>
  <genus><!-- 0..1 CodeableConcept The genus of an organism shall be specified; refers to the Latin epithet of the genus element of the plant/animal scientific name; it is present in names for genera, species and infraspecies --></genus>
  <species><!-- 0..1 CodeableConcept The species of an organism shall be specified; refers to the Latin epithet of the species of the plant/animal; it is present in names for species and infraspecies --></species>
  <intraspecificType><!-- 0..1 CodeableConcept The Intraspecific type of an organism shall be specified --></intraspecificType>
  <intraspecificDescription value="[string]"/><!-- 0..1 The intraspecific description of an organism shall be specified based on a controlled vocabulary. For Influenza Vaccine, the intraspecific description shall contain the syntax of the antigen in line with the WHO convention -->
  <author>  <!-- 0..* 4.9.13.6.1 Author type (Conditional) -->
   <authorType><!-- 0..1 CodeableConcept The type of author of an organism species shall be specified. The parenthetical author of an organism species refers to the first author who published the plant/animal name (of any rank). The primary author of an organism species refers to the first author(s), who validly published the plant/animal name --></authorType>
   <authorDescription value="[string]"/><!-- 0..1 The author of an organism species shall be specified. The author year of an organism shall also be specified when applicable; refers to the year in which the first author(s) published the infraspecific plant/animal name (of any rank) -->
  </author>
  <hybrid>  <!-- 0..1 4.9.13.8.1 Hybrid species maternal organism ID (Optional) -->
   <maternalOrganismId value="[string]"/><!-- 0..1 The identifier of the maternal species constituting the hybrid organism shall be specified based on a controlled vocabulary. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal -->
   <maternalOrganismName value="[string]"/><!-- 0..1 The name of the maternal species constituting the hybrid organism shall be specified. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal -->
   <paternalOrganismId value="[string]"/><!-- 0..1 The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary -->
   <paternalOrganismName value="[string]"/><!-- 0..1 The name of the paternal species constituting the hybrid organism shall be specified -->
   <hybridType><!-- 0..1 CodeableConcept The hybrid type of an organism shall be specified --></hybridType>
  </hybrid>
  <organismGeneral>  <!-- 0..1 4.9.13.7.1 Kingdom (Conditional) -->
   <kingdom><!-- 0..1 CodeableConcept The kingdom of an organism shall be specified --></kingdom>
   <phylum><!-- 0..1 CodeableConcept The phylum of an organism shall be specified --></phylum>
   <class><!-- 0..1 CodeableConcept The class of an organism shall be specified --></class>
   <order><!-- 0..1 CodeableConcept The order of an organism shall be specified, --></order>
  </organismGeneral>
 </organism>
 <partDescription>  <!-- 0..* To do -->
  <part><!-- 0..1 CodeableConcept Entity of anatomical origin of source material within an organism --></part>
  <partLocation><!-- 0..1 CodeableConcept The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply --></partLocation>
 </partDescription>
</SubstanceSourceMaterial>

{
  "resourceType" : "SubstanceSourceMaterial",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "sourceMaterialClass" : { CodeableConcept }, // General high level classification of the source material specific to the origin of the material
  "sourceMaterialType" : { CodeableConcept }, // 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
  "sourceMaterialState" : { CodeableConcept }, // The state of the source material when extracted
  "organismId" : { Identifier }, // The unique identifier associated with the source material parent organism shall be specified
  "organismName" : "<string>", // The organism accepted Scientific name shall be provided based on the organism taxonomy
  "parentSubstanceId" : [{ Identifier }], // 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" : ["<string>"], // The parent substance of the Herbal Drug, or Herbal preparation
  "countryOfOrigin" : [{ CodeableConcept }], // 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
  "geographicalLocation" : ["<string>"], // The place/region where the plant is harvested or the places/regions where the animal source material has its habitat
  "developmentStage" : { CodeableConcept }, // 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)
  "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
    "fraction" : "<string>", // This element is capturing information about the fraction of a plant part, or human plasma for fractionation
    "materialType" : { CodeableConcept } // The specific type of the material constituting the component. For Herbal preparations the particulars of the extracts (liquid/dry) is described in Specified Substance Group 1
  }],
  "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
    "family" : { CodeableConcept }, // The family of an organism shall be specified
    "genus" : { CodeableConcept }, // The genus of an organism shall be specified; refers to the Latin epithet of the genus element of the plant/animal scientific name; it is present in names for genera, species and infraspecies
    "species" : { CodeableConcept }, // The species of an organism shall be specified; refers to the Latin epithet of the species of the plant/animal; it is present in names for species and infraspecies
    "intraspecificType" : { CodeableConcept }, // The Intraspecific type of an organism shall be specified
    "intraspecificDescription" : "<string>", // The intraspecific description of an organism shall be specified based on a controlled vocabulary. For Influenza Vaccine, the intraspecific description shall contain the syntax of the antigen in line with the WHO convention
    "author" : [{ // 4.9.13.6.1 Author type (Conditional)
      "authorType" : { CodeableConcept }, // The type of author of an organism species shall be specified. The parenthetical author of an organism species refers to the first author who published the plant/animal name (of any rank). The primary author of an organism species refers to the first author(s), who validly published the plant/animal name
      "authorDescription" : "<string>" // The author of an organism species shall be specified. The author year of an organism shall also be specified when applicable; refers to the year in which the first author(s) published the infraspecific plant/animal name (of any rank)
    }],
    "hybrid" : { // 4.9.13.8.1 Hybrid species maternal organism ID (Optional)
      "maternalOrganismId" : "<string>", // The identifier of the maternal species constituting the hybrid organism shall be specified based on a controlled vocabulary. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal
      "maternalOrganismName" : "<string>", // The name of the maternal species constituting the hybrid organism shall be specified. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal
      "paternalOrganismId" : "<string>", // The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary
      "paternalOrganismName" : "<string>", // The name of the paternal species constituting the hybrid organism shall be specified
      "hybridType" : { CodeableConcept } // The hybrid type of an organism shall be specified
    },
    "organismGeneral" : { // 4.9.13.7.1 Kingdom (Conditional)
      "kingdom" : { CodeableConcept }, // The kingdom of an organism shall be specified
      "phylum" : { CodeableConcept }, // The phylum of an organism shall be specified
      "class" : { CodeableConcept }, // The class of an organism shall be specified
      "order" : { CodeableConcept } // The order of an organism shall be specified,
    }
  },
  "partDescription" : [{ // To do
    "part" : { CodeableConcept }, // Entity of anatomical origin of source material within an organism
    "partLocation" : { CodeableConcept } // The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply
  }]
}

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:SubstanceSourceMaterial;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:sourceMaterialClass [ CodeableConcept ] ; # 0..1 General high level classification of the source material specific to the origin of the material
  fhir:sourceMaterialType [ CodeableConcept ] ; # 0..1 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:sourceMaterialState [ CodeableConcept ] ; # 0..1 The state of the source material when extracted
  fhir:organismId [ Identifier ] ; # 0..1 The unique identifier associated with the source material parent organism shall be specified
  fhir:organismName [ string ] ; # 0..1 The organism accepted Scientific name shall be provided based on the organism taxonomy
  fhir:parentSubstanceId  ( [ Identifier ] ... ) ; # 0..* 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:parentSubstanceName  ( [ string ] ... ) ; # 0..* The parent substance of the Herbal Drug, or Herbal preparation
  fhir:countryOfOrigin  ( [ CodeableConcept ] ... ) ; # 0..* 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:geographicalLocation  ( [ string ] ... ) ; # 0..* The place/region where the plant is harvested or the places/regions where the animal source material has its habitat
  fhir:developmentStage [ CodeableConcept ] ; # 0..1 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:fractionDescription ( [ # 0..* 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:fraction [ string ] ; # 0..1 This element is capturing information about the fraction of a plant part, or human plasma for fractionation
    fhir:materialType [ CodeableConcept ] ; # 0..1 The specific type of the material constituting the component. For Herbal preparations the particulars of the extracts (liquid/dry) is described in Specified Substance Group 1
  ] ... ) ;
  fhir:organism [ # 0..1 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:family [ CodeableConcept ] ; # 0..1 The family of an organism shall be specified
    fhir:genus [ CodeableConcept ] ; # 0..1 The genus of an organism shall be specified; refers to the Latin epithet of the genus element of the plant/animal scientific name; it is present in names for genera, species and infraspecies
    fhir:species [ CodeableConcept ] ; # 0..1 The species of an organism shall be specified; refers to the Latin epithet of the species of the plant/animal; it is present in names for species and infraspecies
    fhir:intraspecificType [ CodeableConcept ] ; # 0..1 The Intraspecific type of an organism shall be specified
    fhir:intraspecificDescription [ string ] ; # 0..1 The intraspecific description of an organism shall be specified based on a controlled vocabulary. For Influenza Vaccine, the intraspecific description shall contain the syntax of the antigen in line with the WHO convention
    fhir:author ( [ # 0..* 4.9.13.6.1 Author type (Conditional)
      fhir:authorType [ CodeableConcept ] ; # 0..1 The type of author of an organism species shall be specified. The parenthetical author of an organism species refers to the first author who published the plant/animal name (of any rank). The primary author of an organism species refers to the first author(s), who validly published the plant/animal name
      fhir:authorDescription [ string ] ; # 0..1 The author of an organism species shall be specified. The author year of an organism shall also be specified when applicable; refers to the year in which the first author(s) published the infraspecific plant/animal name (of any rank)
    ] ... ) ;
    fhir:hybrid [ # 0..1 4.9.13.8.1 Hybrid species maternal organism ID (Optional)
      fhir:maternalOrganismId [ string ] ; # 0..1 The identifier of the maternal species constituting the hybrid organism shall be specified based on a controlled vocabulary. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal
      fhir:maternalOrganismName [ string ] ; # 0..1 The name of the maternal species constituting the hybrid organism shall be specified. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal
      fhir:paternalOrganismId [ string ] ; # 0..1 The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary
      fhir:paternalOrganismName [ string ] ; # 0..1 The name of the paternal species constituting the hybrid organism shall be specified
      fhir:hybridType [ CodeableConcept ] ; # 0..1 The hybrid type of an organism shall be specified
    ] ;
    fhir:organismGeneral [ # 0..1 4.9.13.7.1 Kingdom (Conditional)
      fhir:kingdom [ CodeableConcept ] ; # 0..1 The kingdom of an organism shall be specified
      fhir:phylum [ CodeableConcept ] ; # 0..1 The phylum of an organism shall be specified
      fhir:class [ CodeableConcept ] ; # 0..1 The class of an organism shall be specified
      fhir:order [ CodeableConcept ] ; # 0..1 The order of an organism shall be specified,
    ] ;
  ] ;
  fhir:partDescription ( [ # 0..* To do
    fhir:part [ CodeableConcept ] ; # 0..1 Entity of anatomical origin of source material within an organism
    fhir:partLocation [ CodeableConcept ] ; # 0..1 The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply
  ] ... ) ;
]

See the Full Difference for further information

This analysis is available as XML or JSON.