Package com.ibm.fhir.model.resource
Class SubstanceSpecification
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.resource.Resource
-
- com.ibm.fhir.model.resource.DomainResource
-
- com.ibm.fhir.model.resource.SubstanceSpecification
-
- All Implemented Interfaces:
Visitable
@Generated("com.ibm.fhir.tools.CodeGenerator") public class SubstanceSpecification extends DomainResource
The detailed description of a substance, typically at a level beyond what is used for prescribing.Maturity level: FMM0 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SubstanceSpecification.Builder
static class
SubstanceSpecification.Code
Codes associated with the substance.static class
SubstanceSpecification.Moiety
Moiety, for structural modifications.static class
SubstanceSpecification.Name
Names applicable to this substance.static class
SubstanceSpecification.Property
General specifications for this substance, including how it is related to other substances.static class
SubstanceSpecification.Relationship
A link between this substance and another, with details of the relationship.static class
SubstanceSpecification.Structure
Structural information.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static SubstanceSpecification.Builder
builder()
boolean
equals(Object obj)
List<SubstanceSpecification.Code>
getCode()
Codes associated with the substance.String
getComment()
Textual comment about this record of a substance.String
getDescription()
Textual description of the substance.CodeableConcept
getDomain()
If the substance applies to only human or veterinary use.Identifier
getIdentifier()
Identifier by which this substance is known.List<SubstanceSpecification.Moiety>
getMoiety()
Moiety, for structural modifications.List<SubstanceSpecification.Structure.Isotope.MolecularWeight>
getMolecularWeight()
The molecular weight or weight range (for proteins, polymers or nucleic acids).List<SubstanceSpecification.Name>
getName()
Names applicable to this substance.Reference
getNucleicAcid()
Data items specific to nucleic acids.Reference
getPolymer()
Data items specific to polymers.List<SubstanceSpecification.Property>
getProperty()
General specifications for this substance, including how it is related to other substances.Reference
getProtein()
Data items specific to proteins.Reference
getReferenceInformation()
General information detailing this substance.List<SubstanceSpecification.Relationship>
getRelationship()
A link between this substance and another, with details of the relationship.List<Reference>
getSource()
Supporting literature.Reference
getSourceMaterial()
Material or taxonomic/anatomical source for the substance.CodeableConcept
getStatus()
Status of substance within the catalogue e.g.SubstanceSpecification.Structure
getStructure()
Structural information.CodeableConcept
getType()
High level categorization, e.g.boolean
hasChildren()
int
hashCode()
SubstanceSpecification.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class com.ibm.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public Identifier getIdentifier()
Identifier by which this substance is known.- Returns:
- An immutable object of type
Identifier
that may be null.
-
getType
public CodeableConcept getType()
High level categorization, e.g. polymer or nucleic acid.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getStatus
public CodeableConcept getStatus()
Status of substance within the catalogue e.g. approved.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getDomain
public CodeableConcept getDomain()
If the substance applies to only human or veterinary use.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getDescription
public String getDescription()
Textual description of the substance.- Returns:
- An immutable object of type
String
that may be null.
-
getSource
public List<Reference> getSource()
Supporting literature.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getComment
public String getComment()
Textual comment about this record of a substance.- Returns:
- An immutable object of type
String
that may be null.
-
getMoiety
public List<SubstanceSpecification.Moiety> getMoiety()
Moiety, for structural modifications.- Returns:
- An unmodifiable list containing immutable objects of type
SubstanceSpecification.Moiety
that may be empty.
-
getProperty
public List<SubstanceSpecification.Property> getProperty()
General specifications for this substance, including how it is related to other substances.- Returns:
- An unmodifiable list containing immutable objects of type
SubstanceSpecification.Property
that may be empty.
-
getReferenceInformation
public Reference getReferenceInformation()
General information detailing this substance.- Returns:
- An immutable object of type
Reference
that may be null.
-
getStructure
public SubstanceSpecification.Structure getStructure()
Structural information.- Returns:
- An immutable object of type
SubstanceSpecification.Structure
that may be null.
-
getCode
public List<SubstanceSpecification.Code> getCode()
Codes associated with the substance.- Returns:
- An unmodifiable list containing immutable objects of type
SubstanceSpecification.Code
that may be empty.
-
getName
public List<SubstanceSpecification.Name> getName()
Names applicable to this substance.- Returns:
- An unmodifiable list containing immutable objects of type
SubstanceSpecification.Name
that may be empty.
-
getMolecularWeight
public List<SubstanceSpecification.Structure.Isotope.MolecularWeight> getMolecularWeight()
The molecular weight or weight range (for proteins, polymers or nucleic acids).- Returns:
- An unmodifiable list containing immutable objects of type
MolecularWeight
that may be empty.
-
getRelationship
public List<SubstanceSpecification.Relationship> getRelationship()
A link between this substance and another, with details of the relationship.- Returns:
- An unmodifiable list containing immutable objects of type
SubstanceSpecification.Relationship
that may be empty.
-
getNucleicAcid
public Reference getNucleicAcid()
Data items specific to nucleic acids.- Returns:
- An immutable object of type
Reference
that may be null.
-
getPolymer
public Reference getPolymer()
Data items specific to polymers.- Returns:
- An immutable object of type
Reference
that may be null.
-
getProtein
public Reference getProtein()
Data items specific to proteins.- Returns:
- An immutable object of type
Reference
that may be null.
-
getSourceMaterial
public Reference getSourceMaterial()
Material or taxonomic/anatomical source for the substance.- Returns:
- An immutable object of type
Reference
that may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
toBuilder
public SubstanceSpecification.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static SubstanceSpecification.Builder builder()
-
-