Package com.ibm.fhir.model.resource

Class MedicinalProduct.SpecialDesignation.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.MedicinalProduct.SpecialDesignation.Builder

All Implemented Interfaces:

Builder<Element>

Enclosing class:

MedicinalProduct.SpecialDesignation

public static class MedicinalProduct.SpecialDesignation.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

Fields inherited from class com.ibm.fhir.model.builder.AbstractBuilder

validating

Method Summary

Modifier and Type	Method	Description
MedicinalProduct.SpecialDesignation	build()	Build the MedicinalProduct.SpecialDesignation
MedicinalProduct.SpecialDesignation.Builder	date(DateTime date)	Date when the designation was granted.
MedicinalProduct.SpecialDesignation.Builder	extension(Extension... extension)	May be used to represent additional information that is not part of the basic definition of the element.
MedicinalProduct.SpecialDesignation.Builder	extension(java.util.Collection<Extension> extension)	May be used to represent additional information that is not part of the basic definition of the element.
protected MedicinalProduct.SpecialDesignation.Builder	from(MedicinalProduct.SpecialDesignation specialDesignation)
MedicinalProduct.SpecialDesignation.Builder	id(java.lang.String id)	Unique id for the element within a resource (for internal references).
MedicinalProduct.SpecialDesignation.Builder	identifier(Identifier... identifier)	Identifier for the designation, or procedure number.
MedicinalProduct.SpecialDesignation.Builder	identifier(java.util.Collection<Identifier> identifier)	Identifier for the designation, or procedure number.
MedicinalProduct.SpecialDesignation.Builder	indication(Element indication)	Condition for which the medicinal use applies.
MedicinalProduct.SpecialDesignation.Builder	intendedUse(CodeableConcept intendedUse)	The intended use of the product, e.g.
MedicinalProduct.SpecialDesignation.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.
MedicinalProduct.SpecialDesignation.Builder	modifierExtension(java.util.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.
MedicinalProduct.SpecialDesignation.Builder	species(CodeableConcept species)	Animal species for which this applies.
MedicinalProduct.SpecialDesignation.Builder	status(CodeableConcept status)	For example granted, pending, expired or withdrawn.
MedicinalProduct.SpecialDesignation.Builder	type(CodeableConcept type)	The type of special designation, e.g.
protected void	validate(MedicinalProduct.SpecialDesignation specialDesignation)

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

from, validate

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

from, validate

Methods inherited from class com.ibm.fhir.model.builder.AbstractBuilder

isValidating, setValidating

Methods inherited from class java.lang.Object

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

Method Detail

id

public MedicinalProduct.SpecialDesignation.Builder id(java.lang.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 MedicinalProduct.SpecialDesignation.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. If any of the elements are null, calling build() will fail.

Overrides:

extension in class BackboneElement.Builder

Parameters:

extension - Additional content defined by implementations

Returns:

A reference to this Builder instance

extension

public MedicinalProduct.SpecialDesignation.Builder extension(java.util.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. If any of the elements are null, calling build() will fail.

Overrides:

extension in class BackboneElement.Builder

Parameters:

extension - Additional content defined by implementations

Returns:

A reference to this Builder instance

Throws:

java.lang.NullPointerException - If the passed collection is null

modifierExtension

public MedicinalProduct.SpecialDesignation.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. If any of the elements are null, calling build() will fail.

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 MedicinalProduct.SpecialDesignation.Builder modifierExtension(java.util.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. If any of the elements are null, calling build() will fail.

Overrides:

modifierExtension in class BackboneElement.Builder

Parameters:

modifierExtension - Extensions that cannot be ignored even if unrecognized

Returns:

A reference to this Builder instance

Throws:

java.lang.NullPointerException - If the passed collection is null

identifier

public MedicinalProduct.SpecialDesignation.Builder identifier(Identifier... identifier)

Identifier for the designation, or procedure number.

Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

Parameters:

identifier - Identifier for the designation, or procedure number

Returns:

A reference to this Builder instance

identifier

public MedicinalProduct.SpecialDesignation.Builder identifier(java.util.Collection<Identifier> identifier)

Identifier for the designation, or procedure number.

Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

Parameters:

identifier - Identifier for the designation, or procedure number

Returns:

A reference to this Builder instance

Throws:

java.lang.NullPointerException - If the passed collection is null

type

public MedicinalProduct.SpecialDesignation.Builder type(CodeableConcept type)

The type of special designation, e.g. orphan drug, minor use.

Parameters:

type - The type of special designation, e.g. orphan drug, minor use

Returns:

A reference to this Builder instance

intendedUse

public MedicinalProduct.SpecialDesignation.Builder intendedUse(CodeableConcept intendedUse)

The intended use of the product, e.g. prevention, treatment.

Parameters:

intendedUse - The intended use of the product, e.g. prevention, treatment

Returns:

A reference to this Builder instance

indication

public MedicinalProduct.SpecialDesignation.Builder indication(Element indication)

Condition for which the medicinal use applies.

This is a choice element with the following allowed types:

• CodeableConcept
• Reference

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

• MedicinalProductIndication

Parameters:

indication - Condition for which the medicinal use applies

Returns:

A reference to this Builder instance

status

public MedicinalProduct.SpecialDesignation.Builder status(CodeableConcept status)

For example granted, pending, expired or withdrawn.

Parameters:

status - For example granted, pending, expired or withdrawn

Returns:

A reference to this Builder instance

date

public MedicinalProduct.SpecialDesignation.Builder date(DateTime date)

Date when the designation was granted.

Parameters:

date - Date when the designation was granted

Returns:

A reference to this Builder instance

species

public MedicinalProduct.SpecialDesignation.Builder species(CodeableConcept species)

Animal species for which this applies.

Parameters:

species - Animal species for which this applies

Returns:

A reference to this Builder instance

build

public MedicinalProduct.SpecialDesignation build()

Build the MedicinalProduct.SpecialDesignation

Specified by:

build in interface Builder<Element>

Specified by:

build in class BackboneElement.Builder

Returns:

An immutable object of type MedicinalProduct.SpecialDesignation

Throws:

java.lang.IllegalStateException - if the current state cannot be built into a valid SpecialDesignation per the base specification

validate

protected void validate(MedicinalProduct.SpecialDesignation specialDesignation)

from

protected MedicinalProduct.SpecialDesignation.Builder from(MedicinalProduct.SpecialDesignation specialDesignation)