Class SubstanceSpecification.Builder
- java.lang.Object
-
- com.ibm.fhir.model.builder.AbstractBuilder<Resource>
-
- com.ibm.fhir.model.resource.Resource.Builder
-
- com.ibm.fhir.model.resource.DomainResource.Builder
-
- com.ibm.fhir.model.resource.SubstanceSpecification.Builder
-
- Enclosing class:
- SubstanceSpecification
public static class SubstanceSpecification.Builder extends DomainResource.Builder
-
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource.Builder
contained, extension, modifierExtension, text
-
Fields inherited from class com.ibm.fhir.model.resource.Resource.Builder
id, implicitRules, language, meta
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SubstanceSpecification
build()
Build theSubstanceSpecification
SubstanceSpecification.Builder
code(SubstanceSpecification.Code... code)
Codes associated with the substance.SubstanceSpecification.Builder
code(Collection<SubstanceSpecification.Code> code)
Codes associated with the substance.SubstanceSpecification.Builder
comment(String comment)
Textual comment about this record of a substance.SubstanceSpecification.Builder
contained(Resource... contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.SubstanceSpecification.Builder
contained(Collection<Resource> contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.SubstanceSpecification.Builder
description(String description)
Textual description of the substance.SubstanceSpecification.Builder
domain(CodeableConcept domain)
If the substance applies to only human or veterinary use.SubstanceSpecification.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.SubstanceSpecification.Builder
extension(Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected SubstanceSpecification.Builder
from(SubstanceSpecification substanceSpecification)
SubstanceSpecification.Builder
id(String id)
The logical id of the resource, as used in the URL for the resource.SubstanceSpecification.Builder
identifier(Identifier identifier)
Identifier by which this substance is known.SubstanceSpecification.Builder
implicitRules(Uri implicitRules)
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.SubstanceSpecification.Builder
language(Code language)
The base language in which the resource is written.SubstanceSpecification.Builder
meta(Meta meta)
The metadata about the resource.SubstanceSpecification.Builder
modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants.SubstanceSpecification.Builder
modifierExtension(Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants.SubstanceSpecification.Builder
moiety(SubstanceSpecification.Moiety... moiety)
Moiety, for structural modifications.SubstanceSpecification.Builder
moiety(Collection<SubstanceSpecification.Moiety> moiety)
Moiety, for structural modifications.SubstanceSpecification.Builder
molecularWeight(SubstanceSpecification.Structure.Isotope.MolecularWeight... molecularWeight)
The molecular weight or weight range (for proteins, polymers or nucleic acids).SubstanceSpecification.Builder
molecularWeight(Collection<SubstanceSpecification.Structure.Isotope.MolecularWeight> molecularWeight)
The molecular weight or weight range (for proteins, polymers or nucleic acids).SubstanceSpecification.Builder
name(SubstanceSpecification.Name... name)
Names applicable to this substance.SubstanceSpecification.Builder
name(Collection<SubstanceSpecification.Name> name)
Names applicable to this substance.SubstanceSpecification.Builder
nucleicAcid(Reference nucleicAcid)
Data items specific to nucleic acids.SubstanceSpecification.Builder
polymer(Reference polymer)
Data items specific to polymers.SubstanceSpecification.Builder
property(SubstanceSpecification.Property... property)
General specifications for this substance, including how it is related to other substances.SubstanceSpecification.Builder
property(Collection<SubstanceSpecification.Property> property)
General specifications for this substance, including how it is related to other substances.SubstanceSpecification.Builder
protein(Reference protein)
Data items specific to proteins.SubstanceSpecification.Builder
referenceInformation(Reference referenceInformation)
General information detailing this substance.SubstanceSpecification.Builder
relationship(SubstanceSpecification.Relationship... relationship)
A link between this substance and another, with details of the relationship.SubstanceSpecification.Builder
relationship(Collection<SubstanceSpecification.Relationship> relationship)
A link between this substance and another, with details of the relationship.SubstanceSpecification.Builder
source(Reference... source)
Supporting literature.SubstanceSpecification.Builder
source(Collection<Reference> source)
Supporting literature.SubstanceSpecification.Builder
sourceMaterial(Reference sourceMaterial)
Material or taxonomic/anatomical source for the substance.SubstanceSpecification.Builder
status(CodeableConcept status)
Status of substance within the catalogue e.g.SubstanceSpecification.Builder
structure(SubstanceSpecification.Structure structure)
Structural information.SubstanceSpecification.Builder
text(Narrative text)
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human.SubstanceSpecification.Builder
type(CodeableConcept type)
High level categorization, e.g.-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource.Builder
from
-
Methods inherited from class com.ibm.fhir.model.resource.Resource.Builder
from
-
-
-
-
Method Detail
-
id
public SubstanceSpecification.Builder id(String id)
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.- Overrides:
id
in classDomainResource.Builder
- Parameters:
id
- Logical id of this artifact- Returns:
- A reference to this Builder instance
-
meta
public SubstanceSpecification.Builder meta(Meta meta)
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.- Overrides:
meta
in classDomainResource.Builder
- Parameters:
meta
- Metadata about the resource- Returns:
- A reference to this Builder instance
-
implicitRules
public SubstanceSpecification.Builder implicitRules(Uri implicitRules)
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.- Overrides:
implicitRules
in classDomainResource.Builder
- Parameters:
implicitRules
- A set of rules under which this content was created- Returns:
- A reference to this Builder instance
-
language
public SubstanceSpecification.Builder language(Code language)
The base language in which the resource is written.- Overrides:
language
in classDomainResource.Builder
- Parameters:
language
- Language of the resource content- Returns:
- A reference to this Builder instance
-
text
public SubstanceSpecification.Builder text(Narrative text)
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.- Overrides:
text
in classDomainResource.Builder
- Parameters:
text
- Text summary of the resource, for human interpretation- Returns:
- A reference to this Builder instance
-
contained
public SubstanceSpecification.Builder contained(Resource... contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Adds new element(s) to the existing list
- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
contained
public SubstanceSpecification.Builder contained(Collection<Resource> contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Replaces the existing list with a new one containing elements from the Collection
- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
extension
public SubstanceSpecification.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Adds new element(s) to the existing list
- Overrides:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public SubstanceSpecification.Builder extension(Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Replaces the existing list with a new one containing elements from the Collection
- Overrides:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
modifierExtension
public SubstanceSpecification.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Adds new element(s) to the existing list
- Overrides:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
modifierExtension
public SubstanceSpecification.Builder modifierExtension(Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Replaces the existing list with a new one containing elements from the Collection
- Overrides:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
identifier
public SubstanceSpecification.Builder identifier(Identifier identifier)
Identifier by which this substance is known.- Parameters:
identifier
- Identifier by which this substance is known- Returns:
- A reference to this Builder instance
-
type
public SubstanceSpecification.Builder type(CodeableConcept type)
High level categorization, e.g. polymer or nucleic acid.- Parameters:
type
- High level categorization, e.g. polymer or nucleic acid- Returns:
- A reference to this Builder instance
-
status
public SubstanceSpecification.Builder status(CodeableConcept status)
Status of substance within the catalogue e.g. approved.- Parameters:
status
- Status of substance within the catalogue e.g. approved- Returns:
- A reference to this Builder instance
-
domain
public SubstanceSpecification.Builder domain(CodeableConcept domain)
If the substance applies to only human or veterinary use.- Parameters:
domain
- If the substance applies to only human or veterinary use- Returns:
- A reference to this Builder instance
-
description
public SubstanceSpecification.Builder description(String description)
Textual description of the substance.- Parameters:
description
- Textual description of the substance- Returns:
- A reference to this Builder instance
-
source
public SubstanceSpecification.Builder source(Reference... source)
Supporting literature.Adds new element(s) to the existing list
- Parameters:
source
- Supporting literature- Returns:
- A reference to this Builder instance
-
source
public SubstanceSpecification.Builder source(Collection<Reference> source)
Supporting literature.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
source
- Supporting literature- Returns:
- A reference to this Builder instance
-
comment
public SubstanceSpecification.Builder comment(String comment)
Textual comment about this record of a substance.- Parameters:
comment
- Textual comment about this record of a substance- Returns:
- A reference to this Builder instance
-
moiety
public SubstanceSpecification.Builder moiety(SubstanceSpecification.Moiety... moiety)
Moiety, for structural modifications.Adds new element(s) to the existing list
- Parameters:
moiety
- Moiety, for structural modifications- Returns:
- A reference to this Builder instance
-
moiety
public SubstanceSpecification.Builder moiety(Collection<SubstanceSpecification.Moiety> moiety)
Moiety, for structural modifications.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
moiety
- Moiety, for structural modifications- Returns:
- A reference to this Builder instance
-
property
public SubstanceSpecification.Builder property(SubstanceSpecification.Property... property)
General specifications for this substance, including how it is related to other substances.Adds new element(s) to the existing list
- Parameters:
property
- General specifications for this substance, including how it is related to other substances- Returns:
- A reference to this Builder instance
-
property
public SubstanceSpecification.Builder property(Collection<SubstanceSpecification.Property> property)
General specifications for this substance, including how it is related to other substances.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
property
- General specifications for this substance, including how it is related to other substances- Returns:
- A reference to this Builder instance
-
referenceInformation
public SubstanceSpecification.Builder referenceInformation(Reference referenceInformation)
General information detailing this substance.Allowed resource types for this reference:
- Parameters:
referenceInformation
- General information detailing this substance- Returns:
- A reference to this Builder instance
-
structure
public SubstanceSpecification.Builder structure(SubstanceSpecification.Structure structure)
Structural information.- Parameters:
structure
- Structural information- Returns:
- A reference to this Builder instance
-
code
public SubstanceSpecification.Builder code(SubstanceSpecification.Code... code)
Codes associated with the substance.Adds new element(s) to the existing list
- Parameters:
code
- Codes associated with the substance- Returns:
- A reference to this Builder instance
-
code
public SubstanceSpecification.Builder code(Collection<SubstanceSpecification.Code> code)
Codes associated with the substance.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
code
- Codes associated with the substance- Returns:
- A reference to this Builder instance
-
name
public SubstanceSpecification.Builder name(SubstanceSpecification.Name... name)
Names applicable to this substance.Adds new element(s) to the existing list
- Parameters:
name
- Names applicable to this substance- Returns:
- A reference to this Builder instance
-
name
public SubstanceSpecification.Builder name(Collection<SubstanceSpecification.Name> name)
Names applicable to this substance.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
name
- Names applicable to this substance- Returns:
- A reference to this Builder instance
-
molecularWeight
public SubstanceSpecification.Builder molecularWeight(SubstanceSpecification.Structure.Isotope.MolecularWeight... molecularWeight)
The molecular weight or weight range (for proteins, polymers or nucleic acids).Adds new element(s) to the existing list
- Parameters:
molecularWeight
- The molecular weight or weight range (for proteins, polymers or nucleic acids)- Returns:
- A reference to this Builder instance
-
molecularWeight
public SubstanceSpecification.Builder molecularWeight(Collection<SubstanceSpecification.Structure.Isotope.MolecularWeight> molecularWeight)
The molecular weight or weight range (for proteins, polymers or nucleic acids).Replaces the existing list with a new one containing elements from the Collection
- Parameters:
molecularWeight
- The molecular weight or weight range (for proteins, polymers or nucleic acids)- Returns:
- A reference to this Builder instance
-
relationship
public SubstanceSpecification.Builder relationship(SubstanceSpecification.Relationship... relationship)
A link between this substance and another, with details of the relationship.Adds new element(s) to the existing list
- Parameters:
relationship
- A link between this substance and another, with details of the relationship- Returns:
- A reference to this Builder instance
-
relationship
public SubstanceSpecification.Builder relationship(Collection<SubstanceSpecification.Relationship> relationship)
A link between this substance and another, with details of the relationship.Replaces the existing list with a new one containing elements from the Collection
- Parameters:
relationship
- A link between this substance and another, with details of the relationship- Returns:
- A reference to this Builder instance
-
nucleicAcid
public SubstanceSpecification.Builder nucleicAcid(Reference nucleicAcid)
Data items specific to nucleic acids.Allowed resource types for this reference:
- Parameters:
nucleicAcid
- Data items specific to nucleic acids- Returns:
- A reference to this Builder instance
-
polymer
public SubstanceSpecification.Builder polymer(Reference polymer)
Data items specific to polymers.Allowed resource types for this reference:
- Parameters:
polymer
- Data items specific to polymers- Returns:
- A reference to this Builder instance
-
protein
public SubstanceSpecification.Builder protein(Reference protein)
Data items specific to proteins.Allowed resource types for this reference:
- Parameters:
protein
- Data items specific to proteins- Returns:
- A reference to this Builder instance
-
sourceMaterial
public SubstanceSpecification.Builder sourceMaterial(Reference sourceMaterial)
Material or taxonomic/anatomical source for the substance.Allowed resource types for this reference:
- Parameters:
sourceMaterial
- Material or taxonomic/anatomical source for the substance- Returns:
- A reference to this Builder instance
-
build
public SubstanceSpecification build()
Build theSubstanceSpecification
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
SubstanceSpecification
- Throws:
IllegalStateException
- if the current state cannot be built into a valid SubstanceSpecification per the base specification
-
from
protected SubstanceSpecification.Builder from(SubstanceSpecification substanceSpecification)
-
-