Package com.ibm.fhir.model.resource

Class MedicationKnowledge.Ingredient

java.lang.Object

com.ibm.fhir.model.visitor.AbstractVisitable

com.ibm.fhir.model.type.Element

com.ibm.fhir.model.type.BackboneElement

com.ibm.fhir.model.resource.MedicationKnowledge.Ingredient

All Implemented Interfaces:

Visitable

Enclosing class:

MedicationKnowledge

public static class MedicationKnowledge.Ingredient
extends BackboneElement

Identifies a particular constituent of interest in the product.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MedicationKnowledge.Ingredient.Builder

Field Summary

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

modifierExtension

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

extension, id

Method Summary

Modifier and Type	Method	Description
void	accept(String elementName, int elementIndex, Visitor visitor)	Accept a Visitor and invoke the appropriate visit methods.
static MedicationKnowledge.Ingredient.Builder	builder()
boolean	equals(Object obj)
Boolean	getIsActive()	Indication of whether this ingredient affects the therapeutic action of the drug.
Element	getItem()	The actual ingredient - either a substance (simple ingredient) or another medication.
Ratio	getStrength()	Specifies how many (or how much) of the items there are in this Medication.
boolean	hasChildren()
int	hashCode()
MedicationKnowledge.Ingredient.Builder	toBuilder()	Create a new Builder from the contents of this Element

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

getModifierExtension

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

as, getExtension, getId, hasValue, is

Methods inherited from class com.ibm.fhir.model.visitor.AbstractVisitable

accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.fhir.model.visitor.Visitable

accept, accept

Method Detail

getItem

public Element getItem()

The actual ingredient - either a substance (simple ingredient) or another medication.

Returns:

An immutable object of type Element that is non-null.

getIsActive

public Boolean getIsActive()

Indication of whether this ingredient affects the therapeutic action of the drug.

Returns:

An immutable object of type Boolean that may be null.

getStrength

public Ratio getStrength()

Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.

Returns:

An immutable object of type Ratio that may be null.

hasChildren

public boolean hasChildren()

Overrides:

hasChildren in class BackboneElement

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 interface Visitable

Specified by:

accept in class AbstractVisitable

Parameters:

elementName - the name of the element in the context of this visit

elementIndex - the index of the element in a list or -1 if it is not contained within a List

visitor - the visitor to use

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toBuilder

public MedicationKnowledge.Ingredient.Builder toBuilder()

Description copied from class: Element

Create a new Builder from the contents of this Element

Specified by:

toBuilder in class BackboneElement

builder

public static MedicationKnowledge.Ingredient.Builder builder()