Skip to main content


class HS.FHIR.DTL.vR4.Model.Resource.SubstanceSourceMaterial extends HS.FHIR.DTL.vR4.Model.Base.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.

Property Inventory


Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = SubstanceSourceMaterial;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = SubstanceSourceMaterial;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.


property countryOfOrigin as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "countryOfOrigin", XMLPROJECTION = "ELEMENT");

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.

any FHIR4 code from any ValueSet may be used.

Property methods: countryOfOriginBuildValueArray(), countryOfOriginCollectionToDisplay(), countryOfOriginCollectionToOdbc(), countryOfOriginDisplayToCollection(), countryOfOriginGet(), countryOfOriginGetObject(), countryOfOriginGetObjectId(), countryOfOriginGetSwizzled(), countryOfOriginIsValid(), countryOfOriginOdbcToCollection(), countryOfOriginSet(), countryOfOriginSetObject(), countryOfOriginSetObjectId()
property developmentStage as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "developmentStage", XMLPROJECTION = "ELEMENT");

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)

any FHIR4 code from any ValueSet may be used.

Property methods: developmentStageGet(), developmentStageGetSwizzled(), developmentStageIsValid(), developmentStageNewObject(), developmentStageSet()
property fractionDescription as list of HS.FHIR.DTL.vR4.Model.Element.SubstanceSourceMaterial.fractionDescription (XMLNAME = "fractionDescription", XMLPROJECTION = "ELEMENT");

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.

Property methods: fractionDescriptionBuildValueArray(), fractionDescriptionCollectionToDisplay(), fractionDescriptionCollectionToOdbc(), fractionDescriptionDisplayToCollection(), fractionDescriptionGet(), fractionDescriptionGetObject(), fractionDescriptionGetObjectId(), fractionDescriptionGetSwizzled(), fractionDescriptionIsValid(), fractionDescriptionOdbcToCollection(), fractionDescriptionSet(), fractionDescriptionSetObject(), fractionDescriptionSetObjectId()
property geographicalLocation as list of %String (MAXLEN = 1000000, XMLNAME = "geographicalLocation", XMLPROJECTION = "ELEMENT");

The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.

Property methods: geographicalLocationBuildValueArray(), geographicalLocationCollectionToDisplay(), geographicalLocationCollectionToOdbc(), geographicalLocationDisplayToCollection(), geographicalLocationDisplayToLogical(), geographicalLocationGet(), geographicalLocationGetObject(), geographicalLocationGetObjectId(), geographicalLocationGetSwizzled(), geographicalLocationIsValid(), geographicalLocationLogicalToDisplay(), geographicalLocationLogicalToOdbc(), geographicalLocationNormalize(), geographicalLocationOdbcToCollection(), geographicalLocationSet(), geographicalLocationSetObject(), geographicalLocationSetObjectId()
property organism as HS.FHIR.DTL.vR4.Model.Element.SubstanceSourceMaterial.organism (XMLNAME = "organism", XMLPROJECTION = "ELEMENT");

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.

Property methods: organismGet(), organismGetSwizzled(), organismIsValid(), organismNewObject(), organismSet()
property organismId as HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "organismId", XMLPROJECTION = "ELEMENT");

The unique identifier associated with the source material parent organism shall be specified.

Property methods: organismIdGet(), organismIdGetSwizzled(), organismIdIsValid(), organismIdNewObject(), organismIdSet()
property organismName as %String (MAXLEN = 1000000, XMLNAME = "organismName", XMLPROJECTION = "ATTRIBUTE");

The organism accepted Scientific name shall be provided based on the organism taxonomy.

Property methods: organismNameDisplayToLogical(), organismNameGet(), organismNameIsValid(), organismNameLogicalToDisplay(), organismNameLogicalToOdbc(), organismNameNormalize(), organismNameSet()
property parentSubstanceId as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "parentSubstanceId", XMLPROJECTION = "ELEMENT");

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)

Property methods: parentSubstanceIdBuildValueArray(), parentSubstanceIdCollectionToDisplay(), parentSubstanceIdCollectionToOdbc(), parentSubstanceIdDisplayToCollection(), parentSubstanceIdGet(), parentSubstanceIdGetObject(), parentSubstanceIdGetObjectId(), parentSubstanceIdGetSwizzled(), parentSubstanceIdIsValid(), parentSubstanceIdOdbcToCollection(), parentSubstanceIdSet(), parentSubstanceIdSetObject(), parentSubstanceIdSetObjectId()
property parentSubstanceName as list of %String (MAXLEN = 1000000, XMLNAME = "parentSubstanceName", XMLPROJECTION = "ELEMENT");

The parent substance of the Herbal Drug, or Herbal preparation.

Property methods: parentSubstanceNameBuildValueArray(), parentSubstanceNameCollectionToDisplay(), parentSubstanceNameCollectionToOdbc(), parentSubstanceNameDisplayToCollection(), parentSubstanceNameDisplayToLogical(), parentSubstanceNameGet(), parentSubstanceNameGetObject(), parentSubstanceNameGetObjectId(), parentSubstanceNameGetSwizzled(), parentSubstanceNameIsValid(), parentSubstanceNameLogicalToDisplay(), parentSubstanceNameLogicalToOdbc(), parentSubstanceNameNormalize(), parentSubstanceNameOdbcToCollection(), parentSubstanceNameSet(), parentSubstanceNameSetObject(), parentSubstanceNameSetObjectId()
property partDescription as list of HS.FHIR.DTL.vR4.Model.Element.SubstanceSourceMaterial.partDescription (XMLNAME = "partDescription", XMLPROJECTION = "ELEMENT");

To do.

Property methods: partDescriptionBuildValueArray(), partDescriptionCollectionToDisplay(), partDescriptionCollectionToOdbc(), partDescriptionDisplayToCollection(), partDescriptionGet(), partDescriptionGetObject(), partDescriptionGetObjectId(), partDescriptionGetSwizzled(), partDescriptionIsValid(), partDescriptionOdbcToCollection(), partDescriptionSet(), partDescriptionSetObject(), partDescriptionSetObjectId()
property sourceMaterialClass as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "sourceMaterialClass", XMLPROJECTION = "ELEMENT");

General high level classification of the source material specific to the origin of the material.

any FHIR4 code from any ValueSet may be used.

Property methods: sourceMaterialClassGet(), sourceMaterialClassGetSwizzled(), sourceMaterialClassIsValid(), sourceMaterialClassNewObject(), sourceMaterialClassSet()
property sourceMaterialState as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "sourceMaterialState", XMLPROJECTION = "ELEMENT");

The state of the source material when extracted.

any FHIR4 code from any ValueSet may be used.

Property methods: sourceMaterialStateGet(), sourceMaterialStateGetSwizzled(), sourceMaterialStateIsValid(), sourceMaterialStateNewObject(), sourceMaterialStateSet()
property sourceMaterialType as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "sourceMaterialType", XMLPROJECTION = "ELEMENT");

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.

any FHIR4 code from any ValueSet may be used.

Property methods: sourceMaterialTypeGet(), sourceMaterialTypeGetSwizzled(), sourceMaterialTypeIsValid(), sourceMaterialTypeNewObject(), sourceMaterialTypeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab