Package org.hl7.fhir.r4.model
Class SubstanceSpecification
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.SubstanceSpecification
- 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
The detailed description of a substance, typically at a level beyond what is
used for prescribing.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static class
static class
static class
static class
static class
static class
static class
static class
-
Field Summary
Modifier and TypeFieldDescriptionCodes associated with the substance.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for codeprotected StringType
Textual comment about this record of a substance.protected StringType
Textual description of the substance.protected CodeableConcept
If the substance applies to only human or veterinary use.protected Identifier
Identifier by which this substance is known.Moiety, for structural modifications.protected List
<SubstanceSpecification.SubstanceSpecificationStructureIsotopeMolecularWeightComponent> The molecular weight or weight range (for proteins, polymers or nucleic acids).Names applicable to this substance.protected Reference
Data items specific to nucleic acids.protected SubstanceNucleicAcid
The actual object that is the target of the reference (Data items specific to nucleic acids.)protected Reference
Data items specific to polymers.protected SubstancePolymer
The actual object that is the target of the reference (Data items specific to polymers.)General specifications for this substance, including how it is related to other substances.protected Reference
Data items specific to proteins.protected SubstanceProtein
The actual object that is the target of the reference (Data items specific to proteins.)protected Reference
General information detailing this substance.protected SubstanceReferenceInformation
The actual object that is the target of the reference (General information detailing this substance.)A link between this substance and another, with details of the relationship.Supporting literature.protected Reference
Material or taxonomic/anatomical source for the substance.protected SubstanceSourceMaterial
The actual object that is the target of the reference (Material or taxonomic/anatomical source for the substance.)protected List
<DocumentReference> The actual objects that are the target of the reference (Supporting literature.)static final String
Search parameter: codeprotected CodeableConcept
Status of substance within the catalogue e.g.Structural information.protected CodeableConcept
High level categorization, e.g.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 TypeMethodDescriptionaddCode()
addMolecularWeight
(SubstanceSpecification.SubstanceSpecificationStructureIsotopeMolecularWeightComponent t) addName()
Deprecated.Use Reference#setResource(IBaseResource) insteadcopy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getCode()
getName()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadgetType()
String[]
getTypesForProperty
(int hash, String name) boolean
hasCode()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasName()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasType()
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setComment
(String value) setCommentElement
(StringType value) setDescription
(String value) setDescriptionElement
(StringType value) setDomain
(CodeableConcept value) setIdentifier
(Identifier value) setMolecularWeight
(List<SubstanceSpecification.SubstanceSpecificationStructureIsotopeMolecularWeightComponent> theMolecularWeight) setNucleicAcid
(Reference value) setPolymer
(Reference value) setPolymerTarget
(SubstancePolymer value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setProtein
(Reference value) setProteinTarget
(SubstanceProtein value) setReferenceInformation
(Reference value) setRelationship
(List<SubstanceSpecification.SubstanceSpecificationRelationshipComponent> theRelationship) setSourceMaterial
(Reference value) setStatus
(CodeableConcept value) setType
(CodeableConcept value) protected SubstanceSpecification
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
-
identifier
Identifier by which this substance is known. -
type
High level categorization, e.g. polymer or nucleic acid. -
status
Status of substance within the catalogue e.g. approved. -
domain
If the substance applies to only human or veterinary use. -
description
Textual description of the substance. -
source
Supporting literature. -
sourceTarget
The actual objects that are the target of the reference (Supporting literature.) -
comment
Textual comment about this record of a substance. -
moiety
Moiety, for structural modifications. -
property
General specifications for this substance, including how it is related to other substances. -
referenceInformation
General information detailing this substance. -
referenceInformationTarget
The actual object that is the target of the reference (General information detailing this substance.) -
structure
Structural information. -
code
Codes associated with the substance. -
name
Names applicable to this substance. -
molecularWeight
protected List<SubstanceSpecification.SubstanceSpecificationStructureIsotopeMolecularWeightComponent> molecularWeightThe molecular weight or weight range (for proteins, polymers or nucleic acids). -
relationship
A link between this substance and another, with details of the relationship. -
nucleicAcid
Data items specific to nucleic acids. -
nucleicAcidTarget
The actual object that is the target of the reference (Data items specific to nucleic acids.) -
polymer
Data items specific to polymers. -
polymerTarget
The actual object that is the target of the reference (Data items specific to polymers.) -
protein
Data items specific to proteins. -
proteinTarget
The actual object that is the target of the reference (Data items specific to proteins.) -
sourceMaterial
Material or taxonomic/anatomical source for the substance. -
sourceMaterialTarget
The actual object that is the target of the reference (Material or taxonomic/anatomical source for the substance.) -
SP_CODE
Search parameter: codeDescription: The specific code
Type: token
Path: SubstanceSpecification.code.code
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: The specific code
Type: token
Path: SubstanceSpecification.code.code
-
-
Constructor Details
-
SubstanceSpecification
public SubstanceSpecification()Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Identifier by which this substance is known.)
-
hasIdentifier
-
setIdentifier
- Parameters:
value
-identifier
(Identifier by which this substance is known.)
-
getType
- Returns:
type
(High level categorization, e.g. polymer or nucleic acid.)
-
hasType
-
setType
- Parameters:
value
-type
(High level categorization, e.g. polymer or nucleic acid.)
-
getStatus
- Returns:
status
(Status of substance within the catalogue e.g. approved.)
-
hasStatus
-
setStatus
- Parameters:
value
-status
(Status of substance within the catalogue e.g. approved.)
-
getDomain
- Returns:
domain
(If the substance applies to only human or veterinary use.)
-
hasDomain
-
setDomain
- Parameters:
value
-domain
(If the substance applies to only human or veterinary use.)
-
getDescriptionElement
- Returns:
description
(Textual description of the substance.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
-
hasDescription
-
setDescriptionElement
- Parameters:
value
-description
(Textual description of the substance.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
- Returns:
- Textual description of the substance.
-
setDescription
- Parameters:
value
- Textual description of the substance.
-
getSource
- Returns:
source
(Supporting literature.)
-
setSource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSource
-
addSource
-
addSource
-
getSourceFirstRep
- Returns:
- The first repetition of repeating field
source
, creating it if it does not already exist
-
getSourceTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addSourceTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getCommentElement
- Returns:
comment
(Textual comment about this record of a substance.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value
-
hasCommentElement
-
hasComment
-
setCommentElement
- Parameters:
value
-comment
(Textual comment about this record of a substance.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value
-
getComment
- Returns:
- Textual comment about this record of a substance.
-
setComment
- Parameters:
value
- Textual comment about this record of a substance.
-
getMoiety
- Returns:
moiety
(Moiety, for structural modifications.)
-
setMoiety
public SubstanceSpecification setMoiety(List<SubstanceSpecification.SubstanceSpecificationMoietyComponent> theMoiety) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasMoiety
-
addMoiety
-
addMoiety
-
getMoietyFirstRep
- Returns:
- The first repetition of repeating field
moiety
, creating it if it does not already exist
-
getProperty
- Returns:
property
(General specifications for this substance, including how it is related to other substances.)
-
setProperty
public SubstanceSpecification setProperty(List<SubstanceSpecification.SubstanceSpecificationPropertyComponent> theProperty) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasProperty
-
addProperty
-
addProperty
-
getPropertyFirstRep
- Returns:
- The first repetition of repeating field
property
, creating it if it does not already exist
-
getReferenceInformation
- Returns:
referenceInformation
(General information detailing this substance.)
-
hasReferenceInformation
-
setReferenceInformation
- Parameters:
value
-referenceInformation
(General information detailing this substance.)
-
getReferenceInformationTarget
- Returns:
referenceInformation
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (General information detailing this substance.)
-
setReferenceInformationTarget
- Parameters:
value
-referenceInformation
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (General information detailing this substance.)
-
getStructure
- Returns:
structure
(Structural information.)
-
hasStructure
-
setStructure
public SubstanceSpecification setStructure(SubstanceSpecification.SubstanceSpecificationStructureComponent value) - Parameters:
value
-structure
(Structural information.)
-
getCode
- Returns:
code
(Codes associated with the substance.)
-
setCode
public SubstanceSpecification setCode(List<SubstanceSpecification.SubstanceSpecificationCodeComponent> theCode) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasCode
-
addCode
-
addCode
-
getCodeFirstRep
- Returns:
- The first repetition of repeating field
code
, creating it if it does not already exist
-
getName
- Returns:
name
(Names applicable to this substance.)
-
setName
public SubstanceSpecification setName(List<SubstanceSpecification.SubstanceSpecificationNameComponent> theName) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasName
-
addName
-
addName
-
getNameFirstRep
- Returns:
- The first repetition of repeating field
name
, creating it if it does not already exist
-
getMolecularWeight
public List<SubstanceSpecification.SubstanceSpecificationStructureIsotopeMolecularWeightComponent> getMolecularWeight()- Returns:
molecularWeight
(The molecular weight or weight range (for proteins, polymers or nucleic acids).)
-
setMolecularWeight
public SubstanceSpecification setMolecularWeight(List<SubstanceSpecification.SubstanceSpecificationStructureIsotopeMolecularWeightComponent> theMolecularWeight) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasMolecularWeight
-
addMolecularWeight
-
addMolecularWeight
-
getMolecularWeightFirstRep
public SubstanceSpecification.SubstanceSpecificationStructureIsotopeMolecularWeightComponent getMolecularWeightFirstRep()- Returns:
- The first repetition of repeating field
molecularWeight
, creating it if it does not already exist
-
getRelationship
- Returns:
relationship
(A link between this substance and another, with details of the relationship.)
-
setRelationship
public SubstanceSpecification setRelationship(List<SubstanceSpecification.SubstanceSpecificationRelationshipComponent> theRelationship) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasRelationship
-
addRelationship
-
addRelationship
-
getRelationshipFirstRep
- Returns:
- The first repetition of repeating field
relationship
, creating it if it does not already exist
-
getNucleicAcid
- Returns:
nucleicAcid
(Data items specific to nucleic acids.)
-
hasNucleicAcid
-
setNucleicAcid
- Parameters:
value
-nucleicAcid
(Data items specific to nucleic acids.)
-
getNucleicAcidTarget
- Returns:
nucleicAcid
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Data items specific to nucleic acids.)
-
setNucleicAcidTarget
- Parameters:
value
-nucleicAcid
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Data items specific to nucleic acids.)
-
getPolymer
- Returns:
polymer
(Data items specific to polymers.)
-
hasPolymer
-
setPolymer
- Parameters:
value
-polymer
(Data items specific to polymers.)
-
getPolymerTarget
- Returns:
polymer
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Data items specific to polymers.)
-
setPolymerTarget
- Parameters:
value
-polymer
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Data items specific to polymers.)
-
getProtein
- Returns:
protein
(Data items specific to proteins.)
-
hasProtein
-
setProtein
- Parameters:
value
-protein
(Data items specific to proteins.)
-
getProteinTarget
- Returns:
protein
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Data items specific to proteins.)
-
setProteinTarget
- Parameters:
value
-protein
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Data items specific to proteins.)
-
getSourceMaterial
- Returns:
sourceMaterial
(Material or taxonomic/anatomical source for the substance.)
-
hasSourceMaterial
-
setSourceMaterial
- Parameters:
value
-sourceMaterial
(Material or taxonomic/anatomical source for the substance.)
-
getSourceMaterialTarget
- Returns:
sourceMaterial
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Material or taxonomic/anatomical source for the substance.)
-
setSourceMaterialTarget
- Parameters:
value
-sourceMaterial
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Material or taxonomic/anatomical source for the substance.)
-
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
-