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
public class SubstanceSourceMaterial extends 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.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSubstanceSourceMaterial.SubstanceSourceMaterialFractionDescriptionComponentstatic classSubstanceSourceMaterial.SubstanceSourceMaterialOrganismAuthorComponentstatic classSubstanceSourceMaterial.SubstanceSourceMaterialOrganismComponentstatic classSubstanceSourceMaterial.SubstanceSourceMaterialOrganismHybridComponentstatic classSubstanceSourceMaterial.SubstanceSourceMaterialOrganismOrganismGeneralComponentstatic classSubstanceSourceMaterial.SubstanceSourceMaterialPartDescriptionComponent
-
Field Summary
Fields Modifier and Type Field Description protected List<CodeableConcept>countryOfOriginThe 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 CodeableConceptdevelopmentStageStage of life for animals, plants, insects and microorganisms.protected List<SubstanceSourceMaterial.SubstanceSourceMaterialFractionDescriptionComponent>fractionDescriptionMany complex materials are fractions of parts of plants, animals, or minerals.protected List<StringType>geographicalLocationThe place/region where the plant is harvested or the places/regions where the animal source material has its habitat.protected SubstanceSourceMaterial.SubstanceSourceMaterialOrganismComponentorganismThis subclause describes the organism which the substance is derived from.protected IdentifierorganismIdThe unique identifier associated with the source material parent organism shall be specified.protected StringTypeorganismNameThe organism accepted Scientific name shall be provided based on the organism taxonomy.protected List<Identifier>parentSubstanceIdThe parent of the herbal drug Ginkgo biloba, Leaf is the substance ID of the substance (fresh) of Ginkgo biloba L.protected List<StringType>parentSubstanceNameThe parent substance of the Herbal Drug, or Herbal preparation.protected List<SubstanceSourceMaterial.SubstanceSourceMaterialPartDescriptionComponent>partDescriptionTo do.protected CodeableConceptsourceMaterialClassGeneral high level classification of the source material specific to the origin of the material.protected CodeableConceptsourceMaterialStateThe state of the source material when extracted.protected CodeableConceptsourceMaterialTypeThe 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
-
-
Constructor Summary
Constructors Constructor Description SubstanceSourceMaterial()Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, 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, 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, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, 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
-
-
-
-
Field Detail
-
sourceMaterialClass
protected CodeableConcept sourceMaterialClass
General high level classification of the source material specific to the origin of the material.
-
sourceMaterialType
protected CodeableConcept 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
protected CodeableConcept sourceMaterialState
The state of the source material when extracted.
-
organismId
protected Identifier organismId
The unique identifier associated with the source material parent organism shall be specified.
-
organismName
protected StringType organismName
The organism accepted Scientific name shall be provided based on the organism taxonomy.
-
parentSubstanceId
protected List<Identifier> 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
protected List<StringType> parentSubstanceName
The parent substance of the Herbal Drug, or Herbal preparation.
-
countryOfOrigin
protected List<CodeableConcept> 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
protected List<StringType> geographicalLocation
The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.
-
developmentStage
protected CodeableConcept 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> 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.
-
organism
protected SubstanceSourceMaterial.SubstanceSourceMaterialOrganismComponent 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> partDescription
To do.
-
-
Constructor Detail
-
SubstanceSourceMaterial
public SubstanceSourceMaterial()
Constructor
-
-
Method Detail
-
getSourceMaterialClass
public CodeableConcept getSourceMaterialClass()
- Returns:
sourceMaterialClass(General high level classification of the source material specific to the origin of the material.)
-
hasSourceMaterialClass
public boolean hasSourceMaterialClass()
-
setSourceMaterialClass
public SubstanceSourceMaterial setSourceMaterialClass(CodeableConcept value)
- Parameters:
value-sourceMaterialClass(General high level classification of the source material specific to the origin of the material.)
-
getSourceMaterialType
public CodeableConcept 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
public boolean hasSourceMaterialType()
-
setSourceMaterialType
public SubstanceSourceMaterial setSourceMaterialType(CodeableConcept value)
- 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
public CodeableConcept getSourceMaterialState()
- Returns:
sourceMaterialState(The state of the source material when extracted.)
-
hasSourceMaterialState
public boolean hasSourceMaterialState()
-
setSourceMaterialState
public SubstanceSourceMaterial setSourceMaterialState(CodeableConcept value)
- Parameters:
value-sourceMaterialState(The state of the source material when extracted.)
-
getOrganismId
public Identifier getOrganismId()
- Returns:
organismId(The unique identifier associated with the source material parent organism shall be specified.)
-
hasOrganismId
public boolean hasOrganismId()
-
setOrganismId
public SubstanceSourceMaterial setOrganismId(Identifier value)
- Parameters:
value-organismId(The unique identifier associated with the source material parent organism shall be specified.)
-
getOrganismNameElement
public StringType 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
public boolean hasOrganismNameElement()
-
hasOrganismName
public boolean hasOrganismName()
-
setOrganismNameElement
public SubstanceSourceMaterial setOrganismNameElement(StringType value)
- 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
public String getOrganismName()
- Returns:
- The organism accepted Scientific name shall be provided based on the organism taxonomy.
-
setOrganismName
public SubstanceSourceMaterial setOrganismName(String value)
- Parameters:
value- The organism accepted Scientific name shall be provided based on the organism taxonomy.
-
getParentSubstanceId
public List<Identifier> 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
public SubstanceSourceMaterial setParentSubstanceId(List<Identifier> theParentSubstanceId)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasParentSubstanceId
public boolean hasParentSubstanceId()
-
addParentSubstanceId
public Identifier addParentSubstanceId()
-
addParentSubstanceId
public SubstanceSourceMaterial addParentSubstanceId(Identifier t)
-
getParentSubstanceIdFirstRep
public Identifier getParentSubstanceIdFirstRep()
- Returns:
- The first repetition of repeating field
parentSubstanceId, creating it if it does not already exist
-
getParentSubstanceName
public List<StringType> getParentSubstanceName()
- Returns:
parentSubstanceName(The parent substance of the Herbal Drug, or Herbal preparation.)
-
setParentSubstanceName
public SubstanceSourceMaterial setParentSubstanceName(List<StringType> theParentSubstanceName)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasParentSubstanceName
public boolean hasParentSubstanceName()
-
addParentSubstanceNameElement
public StringType addParentSubstanceNameElement()
- Returns:
parentSubstanceName(The parent substance of the Herbal Drug, or Herbal preparation.)
-
addParentSubstanceName
public SubstanceSourceMaterial addParentSubstanceName(String value)
- Parameters:
value-parentSubstanceName(The parent substance of the Herbal Drug, or Herbal preparation.)
-
hasParentSubstanceName
public boolean hasParentSubstanceName(String value)
- Parameters:
value-parentSubstanceName(The parent substance of the Herbal Drug, or Herbal preparation.)
-
getCountryOfOrigin
public List<CodeableConcept> 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
public SubstanceSourceMaterial setCountryOfOrigin(List<CodeableConcept> theCountryOfOrigin)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCountryOfOrigin
public boolean hasCountryOfOrigin()
-
addCountryOfOrigin
public CodeableConcept addCountryOfOrigin()
-
addCountryOfOrigin
public SubstanceSourceMaterial addCountryOfOrigin(CodeableConcept t)
-
getCountryOfOriginFirstRep
public CodeableConcept getCountryOfOriginFirstRep()
- Returns:
- The first repetition of repeating field
countryOfOrigin, creating it if it does not already exist
-
getGeographicalLocation
public List<StringType> getGeographicalLocation()
- Returns:
geographicalLocation(The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.)
-
setGeographicalLocation
public SubstanceSourceMaterial setGeographicalLocation(List<StringType> theGeographicalLocation)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasGeographicalLocation
public boolean hasGeographicalLocation()
-
addGeographicalLocationElement
public StringType addGeographicalLocationElement()
- Returns:
geographicalLocation(The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.)
-
addGeographicalLocation
public SubstanceSourceMaterial addGeographicalLocation(String value)
- Parameters:
value-geographicalLocation(The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.)
-
hasGeographicalLocation
public boolean hasGeographicalLocation(String value)
- Parameters:
value-geographicalLocation(The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.)
-
getDevelopmentStage
public CodeableConcept 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
public boolean hasDevelopmentStage()
-
setDevelopmentStage
public SubstanceSourceMaterial setDevelopmentStage(CodeableConcept value)
- 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
thisfor easy method chaining
-
hasFractionDescription
public boolean hasFractionDescription()
-
addFractionDescription
public SubstanceSourceMaterial.SubstanceSourceMaterialFractionDescriptionComponent addFractionDescription()
-
addFractionDescription
public SubstanceSourceMaterial addFractionDescription(SubstanceSourceMaterial.SubstanceSourceMaterialFractionDescriptionComponent t)
-
getFractionDescriptionFirstRep
public SubstanceSourceMaterial.SubstanceSourceMaterialFractionDescriptionComponent getFractionDescriptionFirstRep()
- Returns:
- The first repetition of repeating field
fractionDescription, creating it if it does not already exist
-
getOrganism
public SubstanceSourceMaterial.SubstanceSourceMaterialOrganismComponent 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
public boolean 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
thisfor easy method chaining
-
hasPartDescription
public boolean hasPartDescription()
-
addPartDescription
public SubstanceSourceMaterial.SubstanceSourceMaterialPartDescriptionComponent addPartDescription()
-
addPartDescription
public SubstanceSourceMaterial addPartDescription(SubstanceSourceMaterial.SubstanceSourceMaterialPartDescriptionComponent t)
-
getPartDescriptionFirstRep
public SubstanceSourceMaterial.SubstanceSourceMaterialPartDescriptionComponent getPartDescriptionFirstRep()
- Returns:
- The first repetition of repeating field
partDescription, creating it if it does not already exist
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public SubstanceSourceMaterial copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(SubstanceSourceMaterial dst)
-
typedCopy
protected SubstanceSourceMaterial typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-