Skip to main content

HS.FHIRModel.R4.SubstanceSourceMaterialX.Organism

class HS.FHIRModel.R4.SubstanceSourceMaterialX.Organism extends HS.FHIRModel.FHIRClassSuper

*****************************************
** SubstanceSourceMaterialX.Organism 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_SUBSTANCESOURCEMATERIALX_ORGANISM;
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 _intraspecificDescription as HS.FHIRModel.R4.Element;
Extensions for intraspecificDescription
Property methods: _intraspecificDescriptionGet(), _intraspecificDescriptionGetSwizzled(), _intraspecificDescriptionIsValid(), _intraspecificDescriptionNewObject(), _intraspecificDescriptionSet()
4.9.13.6.1 Author type (Conditional).
Property methods: authorGet(), authorGetSwizzled(), authorIsValid(), authorNewObject(), authorSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element. 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 family as HS.FHIRModel.R4.CodeableConcept;
The family of an organism shall be specified.
Property methods: familyGet(), familyGetSwizzled(), familyIsValid(), familyNewObject(), familySet()
property fhirID as %String;
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property genus as HS.FHIRModel.R4.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.
Property methods: genusGet(), genusGetSwizzled(), genusIsValid(), genusNewObject(), genusSet()
4.9.13.8.1 Hybrid species maternal organism ID (Optional).
Property methods: hybridGet(), hybridGetSwizzled(), hybridIsValid(), hybridNewObject(), hybridSet()
property intraspecificDescription as %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.
Property methods: intraspecificDescriptionDisplayToLogical(), intraspecificDescriptionGet(), intraspecificDescriptionIsValid(), intraspecificDescriptionLogicalToDisplay(), intraspecificDescriptionLogicalToOdbc(), intraspecificDescriptionNormalize(), intraspecificDescriptionSet()
property intraspecificType as HS.FHIRModel.R4.CodeableConcept;
The Intraspecific type of an organism shall be specified.
Property methods: intraspecificTypeGet(), intraspecificTypeGetSwizzled(), intraspecificTypeIsValid(), intraspecificTypeNewObject(), intraspecificTypeSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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()
4.9.13.7.1 Kingdom (Conditional).
Property methods: organismGeneralGet(), organismGeneralGetSwizzled(), organismGeneralIsValid(), organismGeneralNewObject(), organismGeneralSet()
property species as HS.FHIRModel.R4.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.
Property methods: speciesGet(), speciesGetSwizzled(), speciesIsValid(), speciesNewObject(), speciesSet()

Methods

method IncludeAuthor()
method IncludeExtension()
method IncludeFamily()
method IncludeGenus()
method IncludeHybrid()
method IncludeIntraspecificType()
method IncludeModifierExtension()
method IncludeOrganismGeneral()
method IncludeSpecies()
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