Skip to main content

HS.FHIRModel.R4.SubstanceSourceMaterial

class HS.FHIRModel.R4.SubstanceSourceMaterial extends HS.FHIRModel.FHIRClassSuper

*****************************************
** SubstanceSourceMaterial generated class schema
*****************************************
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

Method Inventory

Parameters

parameter XMLTYPE = R4_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.

Properties

property _geographicalLocation as HS.FHIRModel.R4.SeqOfElement;
Extensions for geographicalLocation
Property methods: _geographicalLocationGet(), _geographicalLocationGetSwizzled(), _geographicalLocationIsValid(), _geographicalLocationNewObject(), _geographicalLocationSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _organismName as HS.FHIRModel.R4.Element;
Extensions for organismName
Property methods: _organismNameGet(), _organismNameGetSwizzled(), _organismNameIsValid(), _organismNameNewObject(), _organismNameSet()
property _parentSubstanceName as HS.FHIRModel.R4.SeqOfElement;
Extensions for parentSubstanceName
Property methods: _parentSubstanceNameGet(), _parentSubstanceNameGetSwizzled(), _parentSubstanceNameIsValid(), _parentSubstanceNameNewObject(), _parentSubstanceNameSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property countryOfOrigin as HS.FHIRModel.R4.SeqOfCodeableConcept;
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.
Property methods: countryOfOriginGet(), countryOfOriginGetSwizzled(), countryOfOriginIsValid(), countryOfOriginNewObject(), countryOfOriginSet()
property developmentStage as HS.FHIRModel.R4.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).
Property methods: developmentStageGet(), developmentStageGetSwizzled(), developmentStageIsValid(), developmentStageNewObject(), developmentStageSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
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: fractionDescriptionGet(), fractionDescriptionGetSwizzled(), fractionDescriptionIsValid(), fractionDescriptionNewObject(), fractionDescriptionSet()
property geographicalLocation as HS.FHIRModel.R4.SeqOfString;
The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.
Property methods: geographicalLocationGet(), geographicalLocationGetSwizzled(), geographicalLocationIsValid(), geographicalLocationNewObject(), geographicalLocationSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
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.FHIRModel.R4.Identifier;
The unique identifier associated with the source material parent organism shall be specified.
Property methods: organismIdGet(), organismIdGetSwizzled(), organismIdIsValid(), organismIdNewObject(), organismIdSet()
property organismName as %String;
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 HS.FHIRModel.R4.SeqOfIdentifier;
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: parentSubstanceIdGet(), parentSubstanceIdGetSwizzled(), parentSubstanceIdIsValid(), parentSubstanceIdNewObject(), parentSubstanceIdSet()
property parentSubstanceName as HS.FHIRModel.R4.SeqOfString;
The parent substance of the Herbal Drug, or Herbal preparation.
Property methods: parentSubstanceNameGet(), parentSubstanceNameGetSwizzled(), parentSubstanceNameIsValid(), parentSubstanceNameNewObject(), parentSubstanceNameSet()
To do.
Property methods: partDescriptionGet(), partDescriptionGetSwizzled(), partDescriptionIsValid(), partDescriptionNewObject(), partDescriptionSet()
property resourceType as %String [ InitialExpression = "SubstanceSourceMaterial" , Required ];
This is a SubstanceSourceMaterial resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property sourceMaterialClass as HS.FHIRModel.R4.CodeableConcept;
General high level classification of the source material specific to the origin of the material.
Property methods: sourceMaterialClassGet(), sourceMaterialClassGetSwizzled(), sourceMaterialClassIsValid(), sourceMaterialClassNewObject(), sourceMaterialClassSet()
property sourceMaterialState as HS.FHIRModel.R4.CodeableConcept;
The state of the source material when extracted.
Property methods: sourceMaterialStateGet(), sourceMaterialStateGetSwizzled(), sourceMaterialStateIsValid(), sourceMaterialStateNewObject(), sourceMaterialStateSet()
property sourceMaterialType as HS.FHIRModel.R4.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.
Property methods: sourceMaterialTypeGet(), sourceMaterialTypeGetSwizzled(), sourceMaterialTypeIsValid(), sourceMaterialTypeNewObject(), sourceMaterialTypeSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()

Methods

method IncludeContained()
method IncludeCountryOfOrigin()
method IncludeDevelopmentStage()
method IncludeExtension()
method IncludeFractionDescription()
method IncludeGeographicalLocation()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeOrganism()
method IncludeOrganismId()
method IncludeParentSubstanceId()
method IncludeParentSubstanceName()
method IncludePartDescription()
method IncludeSourceMaterialClass()
method IncludeSourceMaterialState()
method IncludeSourceMaterialType()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab