ProdCharacteristic (org.hl7.fhir.r4 5.4.0 API)

java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.Element
  - - org.hl7.fhir.r4.model.Type
    - - org.hl7.fhir.r4.model.BackboneType
      - org.hl7.fhir.r4.model.ProdCharacteristic

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.ICompositeType
```
public class ProdCharacteristic
extends BackboneType
implements org.hl7.fhir.instance.model.api.ICompositeType
```
The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<StringType>`	`color` Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.
`protected Quantity`	`depth` Where applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
`protected Quantity`	`externalDiameter` Where applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
`protected Quantity`	`height` Where applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
`protected List<Attachment>`	`image` Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations.
`protected List<StringType>`	`imprint` Where applicable, the imprint can be specified as text.
`protected Quantity`	`nominalVolume` Where applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
`protected CodeableConcept`	`scoring` Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.
`protected StringType`	`shape` Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.
`protected Quantity`	`weight` Where applicable, the weight can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
`protected Quantity`	`width` Where applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.

Fields inherited from class org.hl7.fhir.r4.model.BackboneType
modifierExtension

Fields inherited from class org.hl7.fhir.r4.model.Element
extension, id

Constructor Summary

Constructors
Constructor and Description

ProdCharacteristic()
Constructor

Constructors
Constructor and Description
`ProdCharacteristic()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`ProdCharacteristic`	`addColor(String value)`
`StringType`	`addColorElement()`
`Attachment`	`addImage()`
`ProdCharacteristic`	`addImage(Attachment t)`
`ProdCharacteristic`	`addImprint(String value)`
`StringType`	`addImprintElement()`
`ProdCharacteristic`	`copy()`
`void`	`copyValues(ProdCharacteristic dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`List<StringType>`	`getColor()`
`Quantity`	`getDepth()`
`Quantity`	`getExternalDiameter()`
`Quantity`	`getHeight()`
`List<Attachment>`	`getImage()`
`Attachment`	`getImageFirstRep()`
`List<StringType>`	`getImprint()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`Quantity`	`getNominalVolume()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`CodeableConcept`	`getScoring()`
`String`	`getShape()`
`StringType`	`getShapeElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`Quantity`	`getWeight()`
`Quantity`	`getWidth()`
`boolean`	`hasColor()`
`boolean`	`hasColor(String value)`
`boolean`	`hasDepth()`
`boolean`	`hasExternalDiameter()`
`boolean`	`hasHeight()`
`boolean`	`hasImage()`
`boolean`	`hasImprint()`
`boolean`	`hasImprint(String value)`
`boolean`	`hasNominalVolume()`
`boolean`	`hasScoring()`
`boolean`	`hasShape()`
`boolean`	`hasShapeElement()`
`boolean`	`hasWeight()`
`boolean`	`hasWidth()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`ProdCharacteristic`	`setColor(List<StringType> theColor)`
`ProdCharacteristic`	`setDepth(Quantity value)`
`ProdCharacteristic`	`setExternalDiameter(Quantity value)`
`ProdCharacteristic`	`setHeight(Quantity value)`
`ProdCharacteristic`	`setImage(List<Attachment> theImage)`
`ProdCharacteristic`	`setImprint(List<StringType> theImprint)`
`ProdCharacteristic`	`setNominalVolume(Quantity value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`ProdCharacteristic`	`setScoring(CodeableConcept value)`
`ProdCharacteristic`	`setShape(String value)`
`ProdCharacteristic`	`setShapeElement(StringType value)`
`ProdCharacteristic`	`setWeight(Quantity value)`
`ProdCharacteristic`	`setWidth(Quantity value)`
`protected ProdCharacteristic`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r4.model.BackboneType
addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.r4.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData

- Field Detail
  - height
```
protected Quantity height
```
    Where applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
  - width
```
protected Quantity width
```
    Where applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
  - depth
```
protected Quantity depth
```
    Where applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
  - weight
```
protected Quantity weight
```
    Where applicable, the weight can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
  - nominalVolume
```
protected Quantity nominalVolume
```
    Where applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
  - externalDiameter
```
protected Quantity externalDiameter
```
    Where applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
  - shape
```
protected StringType shape
```
    Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.
  - color
```
protected List<StringType> color
```
    Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.
  - imprint
```
protected List<StringType> imprint
```
    Where applicable, the imprint can be specified as text.
  - image
```
protected List<Attachment> image
```
    Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations.
  - scoring
```
protected CodeableConcept scoring
```
    Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.
- Constructor Detail
  - ProdCharacteristic
```
public ProdCharacteristic()
```
    Constructor
- Method Detail
  - getHeight
```
public Quantity getHeight()
```
    Returns:
    
    height (Where applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.)
  - hasHeight
```
public boolean hasHeight()
```
  - setHeight
```
public ProdCharacteristic setHeight(Quantity value)
```
    Parameters:
    
    value - height (Where applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.)
  - getWidth
```
public Quantity getWidth()
```
    Returns:
    
    width (Where applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.)
  - hasWidth
```
public boolean hasWidth()
```
  - setWidth
```
public ProdCharacteristic setWidth(Quantity value)
```
    Parameters:
    
    value - width (Where applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.)
  - getDepth
```
public Quantity getDepth()
```
    Returns:
    
    depth (Where applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.)
  - hasDepth
```
public boolean hasDepth()
```
  - setDepth
```
public ProdCharacteristic setDepth(Quantity value)
```
    Parameters:
    
    value - depth (Where applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.)
  - getWeight
```
public Quantity getWeight()
```
    Returns:
    
    weight (Where applicable, the weight can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.)
  - hasWeight
```
public boolean hasWeight()
```
  - setWeight
```
public ProdCharacteristic setWeight(Quantity value)
```
    Parameters:
    
    value - weight (Where applicable, the weight can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.)
  - getNominalVolume
```
public Quantity getNominalVolume()
```
    Returns:
    
    nominalVolume (Where applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.)
  - hasNominalVolume
```
public boolean hasNominalVolume()
```
  - setNominalVolume
```
public ProdCharacteristic setNominalVolume(Quantity value)
```
    Parameters:
    
    value - nominalVolume (Where applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.)
  - getExternalDiameter
```
public Quantity getExternalDiameter()
```
    Returns:
    
    externalDiameter (Where applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.)
  - hasExternalDiameter
```
public boolean hasExternalDiameter()
```
  - setExternalDiameter
```
public ProdCharacteristic setExternalDiameter(Quantity value)
```
    Parameters:
    
    value - externalDiameter (Where applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.)
  - getShapeElement
```
public StringType getShapeElement()
```
    Returns:
    
    shape (Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.). This is the underlying object with id, value and extensions. The accessor "getShape" gives direct access to the value
  - hasShapeElement
```
public boolean hasShapeElement()
```
  - hasShape
```
public boolean hasShape()
```
  - setShapeElement
```
public ProdCharacteristic setShapeElement(StringType value)
```
    Parameters:
    
    value - shape (Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.). This is the underlying object with id, value and extensions. The accessor "getShape" gives direct access to the value
  - getShape
```
public String getShape()
```
    Returns:
    
    Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.
  - setShape
```
public ProdCharacteristic setShape(String value)
```
    Parameters:
    
    value - Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.
  - getColor
```
public List<StringType> getColor()
```
    Returns:
    
    color (Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.)
  - setColor
```
public ProdCharacteristic setColor(List<StringType> theColor)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasColor
```
public boolean hasColor()
```
  - addColorElement
```
public StringType addColorElement()
```
    Returns:
    
    color (Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.)
  - addColor
```
public ProdCharacteristic addColor(String value)
```
    Parameters:
    
    value - color (Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.)
  - hasColor
```
public boolean hasColor(String value)
```
    Parameters:
    
    value - color (Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.)
  - getImprint
```
public List<StringType> getImprint()
```
    Returns:
    
    imprint (Where applicable, the imprint can be specified as text.)
  - setImprint
```
public ProdCharacteristic setImprint(List<StringType> theImprint)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasImprint
```
public boolean hasImprint()
```
  - addImprintElement
```
public StringType addImprintElement()
```
    Returns:
    
    imprint (Where applicable, the imprint can be specified as text.)
  - addImprint
```
public ProdCharacteristic addImprint(String value)
```
    Parameters:
    
    value - imprint (Where applicable, the imprint can be specified as text.)
  - hasImprint
```
public boolean hasImprint(String value)
```
    Parameters:
    
    value - imprint (Where applicable, the imprint can be specified as text.)
  - getImage
```
public List<Attachment> getImage()
```
    Returns:
    
    image (Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations.)
  - setImage
```
public ProdCharacteristic setImage(List<Attachment> theImage)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasImage
```
public boolean hasImage()
```
  - addImage
```
public Attachment addImage()
```
  - addImage
```
public ProdCharacteristic addImage(Attachment t)
```
  - getImageFirstRep
```
public Attachment getImageFirstRep()
```
    Returns:
    
    The first repetition of repeating field image, creating it if it does not already exist
  - getScoring
```
public CodeableConcept getScoring()
```
    Returns:
    
    scoring (Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.)
  - hasScoring
```
public boolean hasScoring()
```
  - setScoring
```
public ProdCharacteristic setScoring(CodeableConcept value)
```
    Parameters:
    
    value - scoring (Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.)
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class BackboneType
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class BackboneType
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class BackboneType
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class BackboneType
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class BackboneType
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class BackboneType
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class BackboneType
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class BackboneType
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Specified by:
    
    fhirType in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    fhirType in class BackboneType
  - copy
```
public ProdCharacteristic copy()
```
    Specified by:
    
    copy in class BackboneType
  - copyValues
```
public void copyValues(ProdCharacteristic dst)
```
  - typedCopy
```
protected ProdCharacteristic typedCopy()
```
    Specified by:
    
    typedCopy in class Type
  - equalsDeep
```
public boolean equalsDeep(Base other_)
```
    Overrides:
    
    equalsDeep in class BackboneType
  - equalsShallow
```
public boolean equalsShallow(Base other_)
```
    Overrides:
    
    equalsShallow in class BackboneType
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class BackboneType

Class ProdCharacteristic

Field Summary

Fields inherited from class org.hl7.fhir.r4.model.BackboneType

Fields inherited from class org.hl7.fhir.r4.model.Element

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.r4.model.BackboneType

Methods inherited from class org.hl7.fhir.r4.model.Element

Methods inherited from class org.hl7.fhir.r4.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

Field Detail

height

width

depth

weight

nominalVolume

externalDiameter

shape

color

imprint

image

scoring

Constructor Detail

ProdCharacteristic

Method Detail

getHeight

hasHeight

setHeight

getWidth

hasWidth

setWidth

getDepth

hasDepth

setDepth

getWeight

hasWeight

setWeight

getNominalVolume

hasNominalVolume

setNominalVolume

getExternalDiameter

hasExternalDiameter

setExternalDiameter

getShapeElement

hasShapeElement

hasShape

setShapeElement

getShape

setShape

getColor

setColor

hasColor

addColorElement

addColor

hasColor

getImprint

setImprint

hasImprint

addImprintElement

addImprint

hasImprint

getImage

setImage

hasImage

addImage

addImage

getImageFirstRep

getScoring

hasScoring

setScoring

listChildren

getNamedProperty

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty