Package org.hl7.fhir.r5.model
Class SubstanceDefinition
- java.lang.Object
-
- org.hl7.fhir.r5.model.Base
-
- org.hl7.fhir.r5.model.BaseResource
-
- org.hl7.fhir.r5.model.Resource
-
- org.hl7.fhir.r5.model.DomainResource
-
- org.hl7.fhir.r5.model.SubstanceDefinition
-
- 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 SubstanceDefinition extends DomainResource
The detailed description of a substance, typically at a level beyond what is used for prescribing.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSubstanceDefinition.SubstanceDefinitionCodeComponentstatic classSubstanceDefinition.SubstanceDefinitionMoietyComponentstatic classSubstanceDefinition.SubstanceDefinitionNameComponentstatic classSubstanceDefinition.SubstanceDefinitionNameOfficialComponentstatic classSubstanceDefinition.SubstanceDefinitionPropertyComponentstatic classSubstanceDefinition.SubstanceDefinitionRelationshipComponentstatic classSubstanceDefinition.SubstanceDefinitionStructureComponentstatic classSubstanceDefinition.SubstanceDefinitionStructureIsotopeComponentstatic classSubstanceDefinition.SubstanceDefinitionStructureIsotopeMolecularWeightComponentstatic classSubstanceDefinition.SubstanceDefinitionStructureRepresentationComponent
-
Field Summary
Fields Modifier and Type Field Description protected CodeableConceptcategoryHigh level categorization, e.g.protected List<SubstanceDefinition.SubstanceDefinitionCodeComponent>codeCodes associated with the substance.static ca.uhn.fhir.rest.gclient.TokenClientParamCODEFluent Client search parameter constant for codeprotected MarkdownTypedescriptionTextual description of the substance.protected CodeableConceptdomainIf the substance applies to only human or veterinary use.protected IdentifieridentifierIdentifier by which this substance is known.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierprotected List<Reference>manufacturerA company that makes this substance.protected List<SubstanceDefinition.SubstanceDefinitionMoietyComponent>moietyMoiety, for structural modifications.protected List<SubstanceDefinition.SubstanceDefinitionStructureIsotopeMolecularWeightComponent>molecularWeightThe molecular weight or weight range (for proteins, polymers or nucleic acids).protected List<SubstanceDefinition.SubstanceDefinitionNameComponent>nameNames applicable to this substance.protected List<Annotation>noteTextual comment about this record of a substance.protected ReferencenucleicAcidData items specific to nucleic acids.protected ReferencepolymerData items specific to polymers.protected List<SubstanceDefinition.SubstanceDefinitionPropertyComponent>propertyGeneral specifications for this substance, including how it is related to other substances.protected ReferenceproteinData items specific to proteins.protected ReferencereferenceInformationGeneral information detailing this substance.protected List<SubstanceDefinition.SubstanceDefinitionRelationshipComponent>relationshipA link between this substance and another, with details of the relationship.protected List<Reference>sourceSupporting literature.protected ReferencesourceMaterialMaterial or taxonomic/anatomical source for the substance.static StringSP_CODESearch parameter: codestatic StringSP_IDENTIFIERSearch parameter: identifierprotected CodeableConceptstatusStatus of substance within the catalogue e.g.protected SubstanceDefinition.SubstanceDefinitionStructureComponentstructureStructural information.protected List<Reference>supplierA company that supplies this substance.protected StringTypeversionA business level identifier of the substance.-
Fields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
-
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description SubstanceDefinition()Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r5.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.r5.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.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, 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
-
identifier
protected Identifier identifier
Identifier by which this substance is known.
-
version
protected StringType version
A business level identifier of the substance.
-
status
protected CodeableConcept status
Status of substance within the catalogue e.g. approved.
-
category
protected CodeableConcept category
High level categorization, e.g. polymer or nucleic acid, or food, chemical, biological.
-
domain
protected CodeableConcept domain
If the substance applies to only human or veterinary use.
-
description
protected MarkdownType description
Textual description of the substance.
-
note
protected List<Annotation> note
Textual comment about this record of a substance.
-
manufacturer
protected List<Reference> manufacturer
A company that makes this substance.
-
moiety
protected List<SubstanceDefinition.SubstanceDefinitionMoietyComponent> moiety
Moiety, for structural modifications.
-
property
protected List<SubstanceDefinition.SubstanceDefinitionPropertyComponent> property
General specifications for this substance, including how it is related to other substances.
-
referenceInformation
protected Reference referenceInformation
General information detailing this substance.
-
structure
protected SubstanceDefinition.SubstanceDefinitionStructureComponent structure
Structural information.
-
code
protected List<SubstanceDefinition.SubstanceDefinitionCodeComponent> code
Codes associated with the substance.
-
name
protected List<SubstanceDefinition.SubstanceDefinitionNameComponent> name
Names applicable to this substance.
-
molecularWeight
protected List<SubstanceDefinition.SubstanceDefinitionStructureIsotopeMolecularWeightComponent> molecularWeight
The molecular weight or weight range (for proteins, polymers or nucleic acids).
-
relationship
protected List<SubstanceDefinition.SubstanceDefinitionRelationshipComponent> relationship
A link between this substance and another, with details of the relationship.
-
nucleicAcid
protected Reference nucleicAcid
Data items specific to nucleic acids.
-
sourceMaterial
protected Reference sourceMaterial
Material or taxonomic/anatomical source for the substance.
-
SP_CODE
public static final String SP_CODE
Search parameter: codeDescription: The specific code
Type: token
Path: SubstanceDefinition.code.code
- See Also:
- Constant Field Values
-
CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
Fluent Client search parameter constant for codeDescription: The specific code
Type: token
Path: SubstanceDefinition.code.code
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Identifier by which this substance is known
Type: token
Path: SubstanceDefinition.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Identifier by which this substance is known
Type: token
Path: SubstanceDefinition.identifier
-
-
Constructor Detail
-
SubstanceDefinition
public SubstanceDefinition()
Constructor
-
-
Method Detail
-
getIdentifier
public Identifier getIdentifier()
- Returns:
identifier(Identifier by which this substance is known.)
-
hasIdentifier
public boolean hasIdentifier()
-
setIdentifier
public SubstanceDefinition setIdentifier(Identifier value)
- Parameters:
value-identifier(Identifier by which this substance is known.)
-
getVersionElement
public StringType getVersionElement()
- Returns:
version(A business level identifier of the substance.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
hasVersionElement
public boolean hasVersionElement()
-
hasVersion
public boolean hasVersion()
-
setVersionElement
public SubstanceDefinition setVersionElement(StringType value)
- Parameters:
value-version(A business level identifier of the substance.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
getVersion
public String getVersion()
- Returns:
- A business level identifier of the substance.
-
setVersion
public SubstanceDefinition setVersion(String value)
- Parameters:
value- A business level identifier of the substance.
-
getStatus
public CodeableConcept getStatus()
- Returns:
status(Status of substance within the catalogue e.g. approved.)
-
hasStatus
public boolean hasStatus()
-
setStatus
public SubstanceDefinition setStatus(CodeableConcept value)
- Parameters:
value-status(Status of substance within the catalogue e.g. approved.)
-
getCategory
public CodeableConcept getCategory()
- Returns:
category(High level categorization, e.g. polymer or nucleic acid, or food, chemical, biological.)
-
hasCategory
public boolean hasCategory()
-
setCategory
public SubstanceDefinition setCategory(CodeableConcept value)
- Parameters:
value-category(High level categorization, e.g. polymer or nucleic acid, or food, chemical, biological.)
-
getDomain
public CodeableConcept getDomain()
- Returns:
domain(If the substance applies to only human or veterinary use.)
-
hasDomain
public boolean hasDomain()
-
setDomain
public SubstanceDefinition setDomain(CodeableConcept value)
- Parameters:
value-domain(If the substance applies to only human or veterinary use.)
-
getDescriptionElement
public MarkdownType 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
public boolean hasDescriptionElement()
-
hasDescription
public boolean hasDescription()
-
setDescriptionElement
public SubstanceDefinition setDescriptionElement(MarkdownType value)
- 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
public String getDescription()
- Returns:
- Textual description of the substance.
-
setDescription
public SubstanceDefinition setDescription(String value)
- Parameters:
value- Textual description of the substance.
-
setSource
public SubstanceDefinition setSource(List<Reference> theSource)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSource
public boolean hasSource()
-
addSource
public SubstanceDefinition addSource(Reference t)
-
getSourceFirstRep
public Reference getSourceFirstRep()
- Returns:
- The first repetition of repeating field
source, creating it if it does not already exist {3}
-
getNote
public List<Annotation> getNote()
- Returns:
note(Textual comment about this record of a substance.)
-
setNote
public SubstanceDefinition setNote(List<Annotation> theNote)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasNote
public boolean hasNote()
-
addNote
public Annotation addNote()
-
addNote
public SubstanceDefinition addNote(Annotation t)
-
getNoteFirstRep
public Annotation getNoteFirstRep()
- Returns:
- The first repetition of repeating field
note, creating it if it does not already exist {3}
-
getManufacturer
public List<Reference> getManufacturer()
- Returns:
manufacturer(A company that makes this substance.)
-
setManufacturer
public SubstanceDefinition setManufacturer(List<Reference> theManufacturer)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasManufacturer
public boolean hasManufacturer()
-
addManufacturer
public Reference addManufacturer()
-
addManufacturer
public SubstanceDefinition addManufacturer(Reference t)
-
getManufacturerFirstRep
public Reference getManufacturerFirstRep()
- Returns:
- The first repetition of repeating field
manufacturer, creating it if it does not already exist {3}
-
getSupplier
public List<Reference> getSupplier()
- Returns:
supplier(A company that supplies this substance.)
-
setSupplier
public SubstanceDefinition setSupplier(List<Reference> theSupplier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSupplier
public boolean hasSupplier()
-
addSupplier
public Reference addSupplier()
-
addSupplier
public SubstanceDefinition addSupplier(Reference t)
-
getSupplierFirstRep
public Reference getSupplierFirstRep()
- Returns:
- The first repetition of repeating field
supplier, creating it if it does not already exist {3}
-
getMoiety
public List<SubstanceDefinition.SubstanceDefinitionMoietyComponent> getMoiety()
- Returns:
moiety(Moiety, for structural modifications.)
-
setMoiety
public SubstanceDefinition setMoiety(List<SubstanceDefinition.SubstanceDefinitionMoietyComponent> theMoiety)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasMoiety
public boolean hasMoiety()
-
addMoiety
public SubstanceDefinition.SubstanceDefinitionMoietyComponent addMoiety()
-
addMoiety
public SubstanceDefinition addMoiety(SubstanceDefinition.SubstanceDefinitionMoietyComponent t)
-
getMoietyFirstRep
public SubstanceDefinition.SubstanceDefinitionMoietyComponent getMoietyFirstRep()
- Returns:
- The first repetition of repeating field
moiety, creating it if it does not already exist {3}
-
getProperty
public List<SubstanceDefinition.SubstanceDefinitionPropertyComponent> getProperty()
- Returns:
property(General specifications for this substance, including how it is related to other substances.)
-
setProperty
public SubstanceDefinition setProperty(List<SubstanceDefinition.SubstanceDefinitionPropertyComponent> theProperty)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasProperty
public boolean hasProperty()
-
addProperty
public SubstanceDefinition.SubstanceDefinitionPropertyComponent addProperty()
-
addProperty
public SubstanceDefinition addProperty(SubstanceDefinition.SubstanceDefinitionPropertyComponent t)
-
getPropertyFirstRep
public SubstanceDefinition.SubstanceDefinitionPropertyComponent getPropertyFirstRep()
- Returns:
- The first repetition of repeating field
property, creating it if it does not already exist {3}
-
getReferenceInformation
public Reference getReferenceInformation()
- Returns:
referenceInformation(General information detailing this substance.)
-
hasReferenceInformation
public boolean hasReferenceInformation()
-
setReferenceInformation
public SubstanceDefinition setReferenceInformation(Reference value)
- Parameters:
value-referenceInformation(General information detailing this substance.)
-
getStructure
public SubstanceDefinition.SubstanceDefinitionStructureComponent getStructure()
- Returns:
structure(Structural information.)
-
hasStructure
public boolean hasStructure()
-
setStructure
public SubstanceDefinition setStructure(SubstanceDefinition.SubstanceDefinitionStructureComponent value)
- Parameters:
value-structure(Structural information.)
-
getCode
public List<SubstanceDefinition.SubstanceDefinitionCodeComponent> getCode()
- Returns:
code(Codes associated with the substance.)
-
setCode
public SubstanceDefinition setCode(List<SubstanceDefinition.SubstanceDefinitionCodeComponent> theCode)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCode
public boolean hasCode()
-
addCode
public SubstanceDefinition.SubstanceDefinitionCodeComponent addCode()
-
addCode
public SubstanceDefinition addCode(SubstanceDefinition.SubstanceDefinitionCodeComponent t)
-
getCodeFirstRep
public SubstanceDefinition.SubstanceDefinitionCodeComponent getCodeFirstRep()
- Returns:
- The first repetition of repeating field
code, creating it if it does not already exist {3}
-
getName
public List<SubstanceDefinition.SubstanceDefinitionNameComponent> getName()
- Returns:
name(Names applicable to this substance.)
-
setName
public SubstanceDefinition setName(List<SubstanceDefinition.SubstanceDefinitionNameComponent> theName)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasName
public boolean hasName()
-
addName
public SubstanceDefinition.SubstanceDefinitionNameComponent addName()
-
addName
public SubstanceDefinition addName(SubstanceDefinition.SubstanceDefinitionNameComponent t)
-
getNameFirstRep
public SubstanceDefinition.SubstanceDefinitionNameComponent getNameFirstRep()
- Returns:
- The first repetition of repeating field
name, creating it if it does not already exist {3}
-
getMolecularWeight
public List<SubstanceDefinition.SubstanceDefinitionStructureIsotopeMolecularWeightComponent> getMolecularWeight()
- Returns:
molecularWeight(The molecular weight or weight range (for proteins, polymers or nucleic acids).)
-
setMolecularWeight
public SubstanceDefinition setMolecularWeight(List<SubstanceDefinition.SubstanceDefinitionStructureIsotopeMolecularWeightComponent> theMolecularWeight)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasMolecularWeight
public boolean hasMolecularWeight()
-
addMolecularWeight
public SubstanceDefinition.SubstanceDefinitionStructureIsotopeMolecularWeightComponent addMolecularWeight()
-
addMolecularWeight
public SubstanceDefinition addMolecularWeight(SubstanceDefinition.SubstanceDefinitionStructureIsotopeMolecularWeightComponent t)
-
getMolecularWeightFirstRep
public SubstanceDefinition.SubstanceDefinitionStructureIsotopeMolecularWeightComponent getMolecularWeightFirstRep()
- Returns:
- The first repetition of repeating field
molecularWeight, creating it if it does not already exist {3}
-
getRelationship
public List<SubstanceDefinition.SubstanceDefinitionRelationshipComponent> getRelationship()
- Returns:
relationship(A link between this substance and another, with details of the relationship.)
-
setRelationship
public SubstanceDefinition setRelationship(List<SubstanceDefinition.SubstanceDefinitionRelationshipComponent> theRelationship)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasRelationship
public boolean hasRelationship()
-
addRelationship
public SubstanceDefinition.SubstanceDefinitionRelationshipComponent addRelationship()
-
addRelationship
public SubstanceDefinition addRelationship(SubstanceDefinition.SubstanceDefinitionRelationshipComponent t)
-
getRelationshipFirstRep
public SubstanceDefinition.SubstanceDefinitionRelationshipComponent getRelationshipFirstRep()
- Returns:
- The first repetition of repeating field
relationship, creating it if it does not already exist {3}
-
getNucleicAcid
public Reference getNucleicAcid()
- Returns:
nucleicAcid(Data items specific to nucleic acids.)
-
hasNucleicAcid
public boolean hasNucleicAcid()
-
setNucleicAcid
public SubstanceDefinition setNucleicAcid(Reference value)
- Parameters:
value-nucleicAcid(Data items specific to nucleic acids.)
-
getPolymer
public Reference getPolymer()
- Returns:
polymer(Data items specific to polymers.)
-
hasPolymer
public boolean hasPolymer()
-
setPolymer
public SubstanceDefinition setPolymer(Reference value)
- Parameters:
value-polymer(Data items specific to polymers.)
-
getProtein
public Reference getProtein()
- Returns:
protein(Data items specific to proteins.)
-
hasProtein
public boolean hasProtein()
-
setProtein
public SubstanceDefinition setProtein(Reference value)
- Parameters:
value-protein(Data items specific to proteins.)
-
getSourceMaterial
public Reference getSourceMaterial()
- Returns:
sourceMaterial(Material or taxonomic/anatomical source for the substance.)
-
hasSourceMaterial
public boolean hasSourceMaterial()
-
setSourceMaterial
public SubstanceDefinition setSourceMaterial(Reference value)
- Parameters:
value-sourceMaterial(Material or taxonomic/anatomical source for the substance.)
-
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 SubstanceDefinition copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(SubstanceDefinition dst)
-
typedCopy
protected SubstanceDefinition 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
-
-