Package org.hl7.fhir.r4.model
Class SubstanceSourceMaterial
java.lang.Object
org.hl7.fhir.r4.model.Base
org.hl7.fhir.r4.model.BaseResource
org.hl7.fhir.r4.model.Resource
org.hl7.fhir.r4.model.DomainResource
org.hl7.fhir.r4.model.SubstanceSourceMaterial
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IAnyResource
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
,org.hl7.fhir.instance.model.api.IBaseResource
,org.hl7.fhir.instance.model.api.IDomainResource
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.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static class
static class
static class
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected List
<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.protected CodeableConcept
Stage of life for animals, plants, insects and microorganisms.Many complex materials are fractions of parts of plants, animals, or minerals.protected List
<StringType> The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.This subclause describes the organism which the substance is derived from.protected Identifier
The unique identifier associated with the source material parent organism shall be specified.protected StringType
The organism accepted Scientific name shall be provided based on the organism taxonomy.protected List
<Identifier> The parent of the herbal drug Ginkgo biloba, Leaf is the substance ID of the substance (fresh) of Ginkgo biloba L.protected List
<StringType> The parent substance of the Herbal Drug, or Herbal preparation.To do.protected CodeableConcept
General high level classification of the source material specific to the origin of the material.protected CodeableConcept
The state of the source material when extracted.protected CodeableConcept
The type of the source material shall be specified based on a controlled vocabulary.Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddFractionDescription
(SubstanceSourceMaterial.SubstanceSourceMaterialFractionDescriptionComponent t) addGeographicalLocation
(String value) addParentSubstanceName
(String value) copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
hasGeographicalLocation
(String value) boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasParentSubstanceName
(String value) boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setCountryOfOrigin
(List<CodeableConcept> theCountryOfOrigin) setFractionDescription
(List<SubstanceSourceMaterial.SubstanceSourceMaterialFractionDescriptionComponent> theFractionDescription) setGeographicalLocation
(List<StringType> theGeographicalLocation) setOrganismId
(Identifier value) setOrganismName
(String value) setOrganismNameElement
(StringType value) setParentSubstanceId
(List<Identifier> theParentSubstanceId) setParentSubstanceName
(List<StringType> theParentSubstanceName) setPartDescription
(List<SubstanceSourceMaterial.SubstanceSourceMaterialPartDescriptionComponent> thePartDescription) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) protected SubstanceSourceMaterial
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
sourceMaterialClass
General high level classification of the source material specific to the origin of the material. -
sourceMaterialType
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
The state of the source material when extracted. -
organismId
The unique identifier associated with the source material parent organism shall be specified. -
organismName
The organism accepted Scientific name shall be provided based on the organism taxonomy. -
parentSubstanceId
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
The parent substance of the Herbal Drug, or Herbal preparation. -
countryOfOrigin
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
The place/region where the plant is harvested or the places/regions where the animal source material has its habitat. -
developmentStage
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
protected List<SubstanceSourceMaterial.SubstanceSourceMaterialFractionDescriptionComponent> fractionDescriptionMany 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. -
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. -
partDescription
protected List<SubstanceSourceMaterial.SubstanceSourceMaterialPartDescriptionComponent> partDescriptionTo do.
-
-
Constructor Details
-
SubstanceSourceMaterial
public SubstanceSourceMaterial()Constructor
-
-
Method Details
-
getSourceMaterialClass
- Returns:
sourceMaterialClass
(General high level classification of the source material specific to the origin of the material.)
-
hasSourceMaterialClass
-
setSourceMaterialClass
- Parameters:
value
-sourceMaterialClass
(General high level classification of the source material specific to the origin of the material.)
-
getSourceMaterialType
- Returns:
sourceMaterialType
(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.)
-
hasSourceMaterialType
-
setSourceMaterialType
- Parameters:
value
-sourceMaterialType
(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.)
-
getSourceMaterialState
- Returns:
sourceMaterialState
(The state of the source material when extracted.)
-
hasSourceMaterialState
-
setSourceMaterialState
- Parameters:
value
-sourceMaterialState
(The state of the source material when extracted.)
-
getOrganismId
- Returns:
organismId
(The unique identifier associated with the source material parent organism shall be specified.)
-
hasOrganismId
-
setOrganismId
- Parameters:
value
-organismId
(The unique identifier associated with the source material parent organism shall be specified.)
-
getOrganismNameElement
- Returns:
organismName
(The organism accepted Scientific name shall be provided based on the organism taxonomy.). This is the underlying object with id, value and extensions. The accessor "getOrganismName" gives direct access to the value
-
hasOrganismNameElement
-
hasOrganismName
-
setOrganismNameElement
- Parameters:
value
-organismName
(The organism accepted Scientific name shall be provided based on the organism taxonomy.). This is the underlying object with id, value and extensions. The accessor "getOrganismName" gives direct access to the value
-
getOrganismName
- Returns:
- The organism accepted Scientific name shall be provided based on the organism taxonomy.
-
setOrganismName
- Parameters:
value
- The organism accepted Scientific name shall be provided based on the organism taxonomy.
-
getParentSubstanceId
- Returns:
parentSubstanceId
(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).)
-
setParentSubstanceId
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasParentSubstanceId
-
addParentSubstanceId
-
addParentSubstanceId
-
getParentSubstanceIdFirstRep
- Returns:
- The first repetition of repeating field
parentSubstanceId
, creating it if it does not already exist
-
getParentSubstanceName
- Returns:
parentSubstanceName
(The parent substance of the Herbal Drug, or Herbal preparation.)
-
setParentSubstanceName
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasParentSubstanceName
-
addParentSubstanceNameElement
- Returns:
parentSubstanceName
(The parent substance of the Herbal Drug, or Herbal preparation.)
-
addParentSubstanceName
- Parameters:
value
-parentSubstanceName
(The parent substance of the Herbal Drug, or Herbal preparation.)
-
hasParentSubstanceName
- Parameters:
value
-parentSubstanceName
(The parent substance of the Herbal Drug, or Herbal preparation.)
-
getCountryOfOrigin
- Returns:
countryOfOrigin
(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.)
-
setCountryOfOrigin
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCountryOfOrigin
-
addCountryOfOrigin
-
addCountryOfOrigin
-
getCountryOfOriginFirstRep
- Returns:
- The first repetition of repeating field
countryOfOrigin
, creating it if it does not already exist
-
getGeographicalLocation
- Returns:
geographicalLocation
(The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.)
-
setGeographicalLocation
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasGeographicalLocation
-
addGeographicalLocationElement
- Returns:
geographicalLocation
(The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.)
-
addGeographicalLocation
- Parameters:
value
-geographicalLocation
(The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.)
-
hasGeographicalLocation
- Parameters:
value
-geographicalLocation
(The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.)
-
getDevelopmentStage
- Returns:
developmentStage
(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).)
-
hasDevelopmentStage
-
setDevelopmentStage
- Parameters:
value
-developmentStage
(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).)
-
getFractionDescription
public List<SubstanceSourceMaterial.SubstanceSourceMaterialFractionDescriptionComponent> getFractionDescription()- Returns:
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.)
-
setFractionDescription
public SubstanceSourceMaterial setFractionDescription(List<SubstanceSourceMaterial.SubstanceSourceMaterialFractionDescriptionComponent> theFractionDescription) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasFractionDescription
-
addFractionDescription
-
addFractionDescription
-
getFractionDescriptionFirstRep
public SubstanceSourceMaterial.SubstanceSourceMaterialFractionDescriptionComponent getFractionDescriptionFirstRep()- Returns:
- The first repetition of repeating field
fractionDescription
, creating it if it does not already exist
-
getOrganism
- Returns:
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.)
-
hasOrganism
-
setOrganism
public SubstanceSourceMaterial setOrganism(SubstanceSourceMaterial.SubstanceSourceMaterialOrganismComponent value) - Parameters:
value
-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.)
-
getPartDescription
public List<SubstanceSourceMaterial.SubstanceSourceMaterialPartDescriptionComponent> getPartDescription()- Returns:
partDescription
(To do.)
-
setPartDescription
public SubstanceSourceMaterial setPartDescription(List<SubstanceSourceMaterial.SubstanceSourceMaterialPartDescriptionComponent> thePartDescription) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasPartDescription
-
addPartDescription
-
addPartDescription
-
getPartDescriptionFirstRep
public SubstanceSourceMaterial.SubstanceSourceMaterialPartDescriptionComponent getPartDescriptionFirstRep()- Returns:
- The first repetition of repeating field
partDescription
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-