Package com.ibm.fhir.model.resource

Class SubstanceSpecification.Relationship.Builder

java.lang.Object

com.ibm.fhir.model.builder.AbstractBuilder<Element>

com.ibm.fhir.model.type.Element.Builder

com.ibm.fhir.model.type.BackboneElement.Builder

com.ibm.fhir.model.resource.SubstanceSpecification.Relationship.Builder

All Implemented Interfaces:

Builder<Element>

Enclosing class:

SubstanceSpecification.Relationship

public static class SubstanceSpecification.Relationship.Builder
extends BackboneElement.Builder

Field Summary

Fields inherited from class com.ibm.fhir.model.type.BackboneElement.Builder

modifierExtension

Fields inherited from class com.ibm.fhir.model.type.Element.Builder

extension, id

Method Summary

Modifier and Type	Method	Description
SubstanceSpecification.Relationship.Builder	amount(Element amount)	A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.
SubstanceSpecification.Relationship.Builder	amountRatioLowLimit(Ratio amountRatioLowLimit)	For use when the numeric.
SubstanceSpecification.Relationship.Builder	amountType(CodeableConcept amountType)	An operator for the amount, for example "average", "approximately", "less than".
SubstanceSpecification.Relationship	build()	Build the SubstanceSpecification.Relationship
SubstanceSpecification.Relationship.Builder	extension(Extension... extension)	May be used to represent additional information that is not part of the basic definition of the element.
SubstanceSpecification.Relationship.Builder	extension(Collection<Extension> extension)	May be used to represent additional information that is not part of the basic definition of the element.
protected SubstanceSpecification.Relationship.Builder	from(SubstanceSpecification.Relationship relationship)
SubstanceSpecification.Relationship.Builder	id(String id)	Unique id for the element within a resource (for internal references).
SubstanceSpecification.Relationship.Builder	isDefining(Boolean isDefining)	For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.
SubstanceSpecification.Relationship.Builder	modifierExtension(Extension... modifierExtension)	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.
SubstanceSpecification.Relationship.Builder	modifierExtension(Collection<Extension> modifierExtension)	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.
SubstanceSpecification.Relationship.Builder	relationship(CodeableConcept relationship)	For example "salt to parent", "active moiety", "starting material".
SubstanceSpecification.Relationship.Builder	source(Reference... source)	Supporting literature.
SubstanceSpecification.Relationship.Builder	source(Collection<Reference> source)	Supporting literature.
SubstanceSpecification.Relationship.Builder	substance(Element substance)	A pointer to another substance, as a resource or just a representational code.

Methods inherited from class com.ibm.fhir.model.type.BackboneElement.Builder

from

Methods inherited from class com.ibm.fhir.model.type.Element.Builder

from

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

id

public SubstanceSpecification.Relationship.Builder id(String id)

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Overrides:

id in class BackboneElement.Builder

Parameters:

id - Unique id for inter-element referencing

Returns:

A reference to this Builder instance

extension

public SubstanceSpecification.Relationship.Builder extension(Extension... extension)

May be used to represent additional information that is not part of the basic definition of the element. 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 class BackboneElement.Builder

Parameters:

extension - Additional content defined by implementations

Returns:

A reference to this Builder instance

extension

public SubstanceSpecification.Relationship.Builder extension(Collection<Extension> extension)

May be used to represent additional information that is not part of the basic definition of the element. 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 class BackboneElement.Builder

Parameters:

extension - Additional content defined by implementations

Returns:

A reference to this Builder instance

modifierExtension

public SubstanceSpecification.Relationship.Builder modifierExtension(Extension... modifierExtension)

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 class BackboneElement.Builder

Parameters:

modifierExtension - Extensions that cannot be ignored even if unrecognized

Returns:

A reference to this Builder instance

modifierExtension

public SubstanceSpecification.Relationship.Builder modifierExtension(Collection<Extension> modifierExtension)

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 class BackboneElement.Builder

Parameters:

modifierExtension - Extensions that cannot be ignored even if unrecognized

Returns:

A reference to this Builder instance

substance

public SubstanceSpecification.Relationship.Builder substance(Element substance)

A pointer to another substance, as a resource or just a representational code.

This is a choice element with the following allowed types:

• Reference
• CodeableConcept

When of type Reference, the allowed resource types for this reference are:

• SubstanceSpecification

Parameters:

substance - A pointer to another substance, as a resource or just a representational code

Returns:

A reference to this Builder instance

relationship

public SubstanceSpecification.Relationship.Builder relationship(CodeableConcept relationship)

For example "salt to parent", "active moiety", "starting material".

Parameters:

relationship - For example "salt to parent", "active moiety", "starting material"

Returns:

A reference to this Builder instance

isDefining

public SubstanceSpecification.Relationship.Builder isDefining(Boolean isDefining)

For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.

Parameters:

isDefining - For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships

Returns:

A reference to this Builder instance

amount

public SubstanceSpecification.Relationship.Builder amount(Element amount)

A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.

This is a choice element with the following allowed types:

• Quantity
• Range
• Ratio
• String

Parameters:

amount - A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other

Returns:

A reference to this Builder instance

amountRatioLowLimit

public SubstanceSpecification.Relationship.Builder amountRatioLowLimit(Ratio amountRatioLowLimit)

For use when the numeric.

Parameters:

amountRatioLowLimit - For use when the numeric

Returns:

A reference to this Builder instance

amountType

public SubstanceSpecification.Relationship.Builder amountType(CodeableConcept amountType)

An operator for the amount, for example "average", "approximately", "less than".

Parameters:

amountType - An operator for the amount, for example "average", "approximately", "less than"

Returns:

A reference to this Builder instance

source

public SubstanceSpecification.Relationship.Builder source(Reference... source)

Supporting literature.

Adds new element(s) to the existing list

Allowed resource types for the references:

• DocumentReference

Parameters:

source - Supporting literature

Returns:

A reference to this Builder instance

source

public SubstanceSpecification.Relationship.Builder source(Collection<Reference> source)

Supporting literature.

Replaces the existing list with a new one containing elements from the Collection

Allowed resource types for the references:

• DocumentReference

Parameters:

source - Supporting literature

Returns:

A reference to this Builder instance

build

public SubstanceSpecification.Relationship build()

Build the SubstanceSpecification.Relationship

Specified by:

build in interface Builder<Element>

Specified by:

build in class BackboneElement.Builder

Returns:

An immutable object of type SubstanceSpecification.Relationship

Throws:

IllegalStateException - if the current state cannot be built into a valid Relationship per the base specification

from

protected SubstanceSpecification.Relationship.Builder from(SubstanceSpecification.Relationship relationship)