SubstanceSourceMaterial - FHIR Resource (r4)
This SubstanceSourceMaterial Resource uses the FHIR API standard for access and structure.
Validate an SubstanceSourceMaterial FHIR Resource (r4)
SubstanceSourceMaterial Attributes
AttributeField is listTypeDescription
Description: General high level classification of the source material specific to the origin of the material
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"sourceMaterialClass": Learn more about the (SubstanceSourceMaterial) sourceMaterialClass FHIR attribute
Description: 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 Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"sourceMaterialType": Learn more about the (SubstanceSourceMaterial) sourceMaterialType FHIR attribute
Description: The state of the source material when extracted
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"sourceMaterialState": Learn more about the (SubstanceSourceMaterial) sourceMaterialState FHIR attribute
Description: The unique identifier associated with the source material parent organism shall be specified
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"organismId": Learn more about the (SubstanceSourceMaterial) organismId FHIR attribute
Description: The organism accepted Scientific name shall be provided based on the organism taxonomy
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"organismName": Learn more about the (SubstanceSourceMaterial) organismName FHIR attribute
Description: 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 Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"parentSubstanceId": Learn more about the (SubstanceSourceMaterial) parentSubstanceId FHIR attribute
Description: The parent substance of the Herbal Drug, or Herbal preparation
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"parentSubstanceName": Learn more about the (SubstanceSourceMaterial) parentSubstanceName FHIR attribute
Description: 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 Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"countryOfOrigin": Learn more about the (SubstanceSourceMaterial) countryOfOrigin FHIR attribute
Description: The place/region where the plant is harvested or the places/regions where the animal source material has its habitat
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"geographicalLocation": Learn more about the (SubstanceSourceMaterial) geographicalLocation FHIR attribute
Description: 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 Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"developmentStage": Learn more about the (SubstanceSourceMaterial) developmentStage FHIR attribute
Description: 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 Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"fractionDescription": Learn more about the (SubstanceSourceMaterial) fractionDescription FHIR attribute
Description: 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 Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"organism": Learn more about the (SubstanceSourceMaterial) organism FHIR attribute
Description: To do
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"partDescription": Learn more about the (SubstanceSourceMaterial) partDescription FHIR attribute
SubstanceSourceMaterial Example
{
"resourceType": "SubstanceSpecification",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p></div>"
}
}SubstanceSourceMaterial Structure
{
"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
}]
}
SubstanceSourceMaterial Search Parameters
The following search parameters can be used to query SubstanceSourceMaterial resources. Just submit them like so:
https://api.1up.health/fhir/r4/SubstanceSourceMaterial?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|
