Package org.hl7.fhir.r5.model

Class PackagedProductDefinition

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.PackagedProductDefinition

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class PackagedProductDefinition
extends DomainResource

A medically related item or items, in a container or package.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PackagedProductDefinition.PackagedProductDefinitionLegalStatusOfSupplyComponent
static class	PackagedProductDefinition.PackagedProductDefinitionPackagingComponent
static class	PackagedProductDefinition.PackagedProductDefinitionPackagingContainedItemComponent
static class	PackagedProductDefinition.PackagedProductDefinitionPackagingPropertyComponent

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Reference>	attachedDocument	Additional information or supporting documentation about the packaged product.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	BIOLOGICAL	Fluent Client search parameter constant for biological
protected List<PackagedProductDefinition.PackagedProductDefinitionPackagingPropertyComponent>	characteristic	Allows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack".
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	CONTAINED_ITEM	Fluent Client search parameter constant for contained-item
protected List<Quantity>	containedItemQuantity	A total of the complete count of contained items of a particular type/form, independent of sub-packaging or organization.
protected BooleanType	copackagedIndicator	Identifies if the package contains different items, such as when a drug product is supplied with another item e.g.
protected MarkdownType	description	Textual description.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DEVICE	Fluent Client search parameter constant for device
protected List<Identifier>	identifier	A unique identifier for this package as whole - not the the content of the package.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_BIOLOGICAL	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_CONTAINED_ITEM	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_DEVICE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_MANUFACTURED_ITEM	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_MEDICATION	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_NUTRITION	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PACKAGE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PACKAGE_FOR	Constant for fluent queries to be used to add include statements.
protected List<PackagedProductDefinition.PackagedProductDefinitionLegalStatusOfSupplyComponent>	legalStatusOfSupply	The legal status of supply of the packaged item as classified by the regulator.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	MANUFACTURED_ITEM	Fluent Client search parameter constant for manufactured-item
protected List<Reference>	manufacturer	Manufacturer of this package type.
protected List<MarketingStatus>	marketingStatus	Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	MEDICATION	Fluent Client search parameter constant for medication
protected StringType	name	A name for this package.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	NAME	Fluent Client search parameter constant for name
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	NUTRITION	Fluent Client search parameter constant for nutrition
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PACKAGE	Fluent Client search parameter constant for package
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PACKAGE_FOR	Fluent Client search parameter constant for package-for
protected List<Reference>	packageFor	The product this package model relates to, not the contents of the package (for which see package.containedItem).
protected PackagedProductDefinition.PackagedProductDefinitionPackagingComponent	packaging	A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap (which is not a device or a medication manufactured item).
static final String	SP_BIOLOGICAL	Search parameter: biological
static final String	SP_CONTAINED_ITEM	Search parameter: contained-item
static final String	SP_DEVICE	Search parameter: device
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_MANUFACTURED_ITEM	Search parameter: manufactured-item
static final String	SP_MEDICATION	Search parameter: medication
static final String	SP_NAME	Search parameter: name
static final String	SP_NUTRITION	Search parameter: nutrition
static final String	SP_PACKAGE	Search parameter: package
static final String	SP_PACKAGE_FOR	Search parameter: package-for
static final String	SP_STATUS	Search parameter: status
protected CodeableConcept	status	The status within the lifecycle of this item.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected DateTimeType	statusDate	The date at which the given status became applicable.
protected CodeableConcept	type	A high level category e.g.

Fields inherited from class org.hl7.fhir.r5.model.DomainResource

contained, extension, modifierExtension, SP_TEXT, text, TEXT

Fields inherited from class org.hl7.fhir.r5.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
PackagedProductDefinition()	Constructor

Method Summary

Modifier and Type	Method	Description
Reference	addAttachedDocument()
PackagedProductDefinition	addAttachedDocument(Reference t)
PackagedProductDefinition.PackagedProductDefinitionPackagingPropertyComponent	addCharacteristic()
PackagedProductDefinition	addCharacteristic(PackagedProductDefinition.PackagedProductDefinitionPackagingPropertyComponent t)
Base	addChild(String name)
Quantity	addContainedItemQuantity()
PackagedProductDefinition	addContainedItemQuantity(Quantity t)
Identifier	addIdentifier()
PackagedProductDefinition	addIdentifier(Identifier t)
PackagedProductDefinition.PackagedProductDefinitionLegalStatusOfSupplyComponent	addLegalStatusOfSupply()
PackagedProductDefinition	addLegalStatusOfSupply(PackagedProductDefinition.PackagedProductDefinitionLegalStatusOfSupplyComponent t)
Reference	addManufacturer()
PackagedProductDefinition	addManufacturer(Reference t)
MarketingStatus	addMarketingStatus()
PackagedProductDefinition	addMarketingStatus(MarketingStatus t)
Reference	addPackageFor()
PackagedProductDefinition	addPackageFor(Reference t)
PackagedProductDefinition	copy()
void	copyValues(PackagedProductDefinition dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<Reference>	getAttachedDocument()
Reference	getAttachedDocumentFirstRep()
List<PackagedProductDefinition.PackagedProductDefinitionPackagingPropertyComponent>	getCharacteristic()
PackagedProductDefinition.PackagedProductDefinitionPackagingPropertyComponent	getCharacteristicFirstRep()
List<Quantity>	getContainedItemQuantity()
Quantity	getContainedItemQuantityFirstRep()
boolean	getCopackagedIndicator()
BooleanType	getCopackagedIndicatorElement()
String	getDescription()
MarkdownType	getDescriptionElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<PackagedProductDefinition.PackagedProductDefinitionLegalStatusOfSupplyComponent>	getLegalStatusOfSupply()
PackagedProductDefinition.PackagedProductDefinitionLegalStatusOfSupplyComponent	getLegalStatusOfSupplyFirstRep()
List<Reference>	getManufacturer()
Reference	getManufacturerFirstRep()
List<MarketingStatus>	getMarketingStatus()
MarketingStatus	getMarketingStatusFirstRep()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
List<Reference>	getPackageFor()
Reference	getPackageForFirstRep()
PackagedProductDefinition.PackagedProductDefinitionPackagingComponent	getPackaging()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
CodeableConcept	getStatus()
Date	getStatusDate()
DateTimeType	getStatusDateElement()
CodeableConcept	getType()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAttachedDocument()
boolean	hasCharacteristic()
boolean	hasContainedItemQuantity()
boolean	hasCopackagedIndicator()
boolean	hasCopackagedIndicatorElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasIdentifier()
boolean	hasLegalStatusOfSupply()
boolean	hasManufacturer()
boolean	hasMarketingStatus()
boolean	hasName()
boolean	hasNameElement()
boolean	hasPackageFor()
boolean	hasPackaging()
boolean	hasStatus()
boolean	hasStatusDate()
boolean	hasStatusDateElement()
boolean	hasType()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
PackagedProductDefinition	setAttachedDocument(List<Reference> theAttachedDocument)
PackagedProductDefinition	setCharacteristic(List<PackagedProductDefinition.PackagedProductDefinitionPackagingPropertyComponent> theCharacteristic)
PackagedProductDefinition	setContainedItemQuantity(List<Quantity> theContainedItemQuantity)
PackagedProductDefinition	setCopackagedIndicator(boolean value)
PackagedProductDefinition	setCopackagedIndicatorElement(BooleanType value)
PackagedProductDefinition	setDescription(String value)
PackagedProductDefinition	setDescriptionElement(MarkdownType value)
PackagedProductDefinition	setIdentifier(List<Identifier> theIdentifier)
PackagedProductDefinition	setLegalStatusOfSupply(List<PackagedProductDefinition.PackagedProductDefinitionLegalStatusOfSupplyComponent> theLegalStatusOfSupply)
PackagedProductDefinition	setManufacturer(List<Reference> theManufacturer)
PackagedProductDefinition	setMarketingStatus(List<MarketingStatus> theMarketingStatus)
PackagedProductDefinition	setName(String value)
PackagedProductDefinition	setNameElement(StringType value)
PackagedProductDefinition	setPackageFor(List<Reference> thePackageFor)
PackagedProductDefinition	setPackaging(PackagedProductDefinition.PackagedProductDefinitionPackagingComponent value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
PackagedProductDefinition	setStatus(CodeableConcept value)
PackagedProductDefinition	setStatusDate(Date value)
PackagedProductDefinition	setStatusDateElement(DateTimeType value)
PackagedProductDefinition	setType(CodeableConcept value)
protected PackagedProductDefinition	typedCopy()

Methods inherited from class org.hl7.fhir.r5.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText

Methods inherited from class org.hl7.fhir.r5.model.Resource

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

Methods inherited from class org.hl7.fhir.r5.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

A unique identifier for this package as whole - not the the content of the package. Unique instance identifiers assigned to a package by manufacturers, regulators, drug catalogue custodians or other organizations.

name

protected StringType name

A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.

type

protected CodeableConcept type

A high level category e.g. medicinal product, raw material, shipping/transport container, etc.

packageFor

protected List<Reference> packageFor

The product this package model relates to, not the contents of the package (for which see package.containedItem).

status

protected CodeableConcept status

The status within the lifecycle of this item. A high level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization or marketing status.

statusDate

protected DateTimeType statusDate

The date at which the given status became applicable.

containedItemQuantity

protected List<Quantity> containedItemQuantity

A total of the complete count of contained items of a particular type/form, independent of sub-packaging or organization. This can be considered as the pack size. This attribute differs from containedItem.amount in that it can give a single aggregated count of all tablet types in a pack, even when these are different manufactured items. For example a pill pack of 21 tablets plus 7 sugar tablets, can be denoted here as '28 tablets'. This attribute is repeatable so that the different item types in one pack type can be counted (e.g. a count of vials and count of syringes). Each repeat must have different units, so that it is clear what the different sets of counted items are, and it is not intended to allow different counts of similar items (e.g. not '2 tubes and 3 tubes'). Repeats are not to be used to represent different pack sizes (e.g. 20 pack vs. 50 pack) - which would be different instances of this resource.

description

protected MarkdownType description

Textual description. Note that this is not the name of the package or product.

legalStatusOfSupply

protected List<PackagedProductDefinition.PackagedProductDefinitionLegalStatusOfSupplyComponent> legalStatusOfSupply

The legal status of supply of the packaged item as classified by the regulator.

marketingStatus

protected List<MarketingStatus> marketingStatus

Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated.

copackagedIndicator

protected BooleanType copackagedIndicator

Identifies if the package contains different items, such as when a drug product is supplied with another item e.g. a diluent or adjuvant.

manufacturer

protected List<Reference> manufacturer

Manufacturer of this package type. When there are multiple it means these are all possible manufacturers.

attachedDocument

protected List<Reference> attachedDocument

Additional information or supporting documentation about the packaged product.

packaging

protected PackagedProductDefinition.PackagedProductDefinitionPackagingComponent packaging

A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap (which is not a device or a medication manufactured item).

characteristic

protected List<PackagedProductDefinition.PackagedProductDefinitionPackagingPropertyComponent> characteristic

Allows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack".

SP_BIOLOGICAL

public static final String SP_BIOLOGICAL

Search parameter: biological

Description: A biologically derived product within this packaged product
Type: reference
Path: PackagedProductDefinition.packaging.containedItem.item.reference

See Also:

• Constant Field Values

BIOLOGICAL

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BIOLOGICAL

Fluent Client search parameter constant for biological

Description: A biologically derived product within this packaged product
Type: reference
Path: PackagedProductDefinition.packaging.containedItem.item.reference

INCLUDE_BIOLOGICAL

public static final ca.uhn.fhir.model.api.Include INCLUDE_BIOLOGICAL

Constant for fluent queries to be used to add include statements. Specifies the path value of "PackagedProductDefinition:biological".

SP_CONTAINED_ITEM

public static final String SP_CONTAINED_ITEM

Search parameter: contained-item

Description: Any of the contained items within this packaged product
Type: reference
Path: PackagedProductDefinition.packaging.containedItem.item.reference

See Also:

• Constant Field Values

CONTAINED_ITEM

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONTAINED_ITEM

Fluent Client search parameter constant for contained-item

Description: Any of the contained items within this packaged product
Type: reference
Path: PackagedProductDefinition.packaging.containedItem.item.reference

INCLUDE_CONTAINED_ITEM

public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTAINED_ITEM

Constant for fluent queries to be used to add include statements. Specifies the path value of "PackagedProductDefinition:contained-item".

SP_DEVICE

public static final String SP_DEVICE

Search parameter: device

Description: A device within this packaged product
Type: reference
Path: PackagedProductDefinition.packaging.containedItem.item.reference

See Also:

• Constant Field Values

DEVICE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEVICE

Fluent Client search parameter constant for device

Description: A device within this packaged product
Type: reference
Path: PackagedProductDefinition.packaging.containedItem.item.reference

INCLUDE_DEVICE

public static final ca.uhn.fhir.model.api.Include INCLUDE_DEVICE

Constant for fluent queries to be used to add include statements. Specifies the path value of "PackagedProductDefinition:device".

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Unique identifier
Type: token
Path: PackagedProductDefinition.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: Unique identifier
Type: token
Path: PackagedProductDefinition.identifier

SP_MANUFACTURED_ITEM

public static final String SP_MANUFACTURED_ITEM

Search parameter: manufactured-item

Description: A manufactured item of medication within this packaged product
Type: reference
Path: PackagedProductDefinition.packaging.containedItem.item.reference

See Also:

• Constant Field Values

MANUFACTURED_ITEM

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MANUFACTURED_ITEM

Fluent Client search parameter constant for manufactured-item

Description: A manufactured item of medication within this packaged product
Type: reference
Path: PackagedProductDefinition.packaging.containedItem.item.reference

INCLUDE_MANUFACTURED_ITEM

public static final ca.uhn.fhir.model.api.Include INCLUDE_MANUFACTURED_ITEM

Constant for fluent queries to be used to add include statements. Specifies the path value of "PackagedProductDefinition:manufactured-item".

SP_MEDICATION

public static final String SP_MEDICATION

Search parameter: medication

Description: A manufactured item of medication within this packaged product
Type: reference
Path: PackagedProductDefinition.packaging.containedItem.item.reference

See Also:

• Constant Field Values

MEDICATION

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MEDICATION

Fluent Client search parameter constant for medication

Description: A manufactured item of medication within this packaged product
Type: reference
Path: PackagedProductDefinition.packaging.containedItem.item.reference

INCLUDE_MEDICATION

public static final ca.uhn.fhir.model.api.Include INCLUDE_MEDICATION

Constant for fluent queries to be used to add include statements. Specifies the path value of "PackagedProductDefinition:medication".

SP_NAME

public static final String SP_NAME

Search parameter: name

Description: A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.
Type: token
Path: PackagedProductDefinition.name

See Also:

• Constant Field Values

NAME

public static final ca.uhn.fhir.rest.gclient.TokenClientParam NAME

Fluent Client search parameter constant for name

Description: A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.
Type: token
Path: PackagedProductDefinition.name

SP_NUTRITION

public static final String SP_NUTRITION

Search parameter: nutrition

Description: A nutrition product within this packaged product
Type: reference
Path: PackagedProductDefinition.packaging.containedItem.item.reference

See Also:

• Constant Field Values

NUTRITION

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam NUTRITION

Fluent Client search parameter constant for nutrition

Description: A nutrition product within this packaged product
Type: reference
Path: PackagedProductDefinition.packaging.containedItem.item.reference

INCLUDE_NUTRITION

public static final ca.uhn.fhir.model.api.Include INCLUDE_NUTRITION

Constant for fluent queries to be used to add include statements. Specifies the path value of "PackagedProductDefinition:nutrition".

SP_PACKAGE_FOR

public static final String SP_PACKAGE_FOR

Search parameter: package-for

Description: The product that this is a pack for
Type: reference
Path: PackagedProductDefinition.packageFor

See Also:

• Constant Field Values

PACKAGE_FOR

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PACKAGE_FOR

Fluent Client search parameter constant for package-for

Description: The product that this is a pack for
Type: reference
Path: PackagedProductDefinition.packageFor

INCLUDE_PACKAGE_FOR

public static final ca.uhn.fhir.model.api.Include INCLUDE_PACKAGE_FOR

Constant for fluent queries to be used to add include statements. Specifies the path value of "PackagedProductDefinition:package-for".

SP_PACKAGE

public static final String SP_PACKAGE

Search parameter: package

Description: A complete packaged product within this packaged product
Type: reference
Path: PackagedProductDefinition.packaging.containedItem.item.reference

See Also:

• Constant Field Values

PACKAGE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PACKAGE

Fluent Client search parameter constant for package

Description: A complete packaged product within this packaged product
Type: reference
Path: PackagedProductDefinition.packaging.containedItem.item.reference

INCLUDE_PACKAGE

public static final ca.uhn.fhir.model.api.Include INCLUDE_PACKAGE

Constant for fluent queries to be used to add include statements. Specifies the path value of "PackagedProductDefinition:package".

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The status within the lifecycle of this item. A high level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization or marketing status
Type: token
Path: PackagedProductDefinition.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: The status within the lifecycle of this item. A high level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization or marketing status
Type: token
Path: PackagedProductDefinition.status

Constructor Details

PackagedProductDefinition

public PackagedProductDefinition()

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (A unique identifier for this package as whole - not the the content of the package. Unique instance identifiers assigned to a package by manufacturers, regulators, drug catalogue custodians or other organizations.)

setIdentifier

public PackagedProductDefinition setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public PackagedProductDefinition addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist {3}

getNameElement

public StringType getNameElement()

Returns:

name (A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

hasNameElement

public boolean hasNameElement()

hasName

public boolean hasName()

setNameElement

public PackagedProductDefinition setNameElement(StringType value)

Parameters:

value - name (A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

getName

public String getName()

Returns:

A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.

setName

public PackagedProductDefinition setName(String value)

Parameters:

value - A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.

getType

public CodeableConcept getType()

Returns:

type (A high level category e.g. medicinal product, raw material, shipping/transport container, etc.)

hasType

public boolean hasType()

setType

public PackagedProductDefinition setType(CodeableConcept value)

Parameters:

value - type (A high level category e.g. medicinal product, raw material, shipping/transport container, etc.)

getPackageFor

public List<Reference> getPackageFor()

Returns:

packageFor (The product this package model relates to, not the contents of the package (for which see package.containedItem).)

setPackageFor

public PackagedProductDefinition setPackageFor(List<Reference> thePackageFor)

Returns:

Returns a reference to this for easy method chaining

hasPackageFor

public boolean hasPackageFor()

addPackageFor

public Reference addPackageFor()

addPackageFor

public PackagedProductDefinition addPackageFor(Reference t)

getPackageForFirstRep

public Reference getPackageForFirstRep()

Returns:

The first repetition of repeating field packageFor, creating it if it does not already exist {3}

getStatus

public CodeableConcept getStatus()

Returns:

status (The status within the lifecycle of this item. A high level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization or marketing status.)

hasStatus

public boolean hasStatus()

setStatus

public PackagedProductDefinition setStatus(CodeableConcept value)

Parameters:

value - status (The status within the lifecycle of this item. A high level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization or marketing status.)

getStatusDateElement

public DateTimeType getStatusDateElement()

Returns:

statusDate (The date at which the given status became applicable.). This is the underlying object with id, value and extensions. The accessor "getStatusDate" gives direct access to the value

hasStatusDateElement

public boolean hasStatusDateElement()

hasStatusDate

public boolean hasStatusDate()

setStatusDateElement

public PackagedProductDefinition setStatusDateElement(DateTimeType value)

Parameters:

value - statusDate (The date at which the given status became applicable.). This is the underlying object with id, value and extensions. The accessor "getStatusDate" gives direct access to the value

getStatusDate

public Date getStatusDate()

Returns:

The date at which the given status became applicable.

setStatusDate

public PackagedProductDefinition setStatusDate(Date value)

Parameters:

value - The date at which the given status became applicable.

getContainedItemQuantity

public List<Quantity> getContainedItemQuantity()

Returns:

containedItemQuantity (A total of the complete count of contained items of a particular type/form, independent of sub-packaging or organization. This can be considered as the pack size. This attribute differs from containedItem.amount in that it can give a single aggregated count of all tablet types in a pack, even when these are different manufactured items. For example a pill pack of 21 tablets plus 7 sugar tablets, can be denoted here as '28 tablets'. This attribute is repeatable so that the different item types in one pack type can be counted (e.g. a count of vials and count of syringes). Each repeat must have different units, so that it is clear what the different sets of counted items are, and it is not intended to allow different counts of similar items (e.g. not '2 tubes and 3 tubes'). Repeats are not to be used to represent different pack sizes (e.g. 20 pack vs. 50 pack) - which would be different instances of this resource.)

setContainedItemQuantity

public PackagedProductDefinition setContainedItemQuantity(List<Quantity> theContainedItemQuantity)

Returns:

Returns a reference to this for easy method chaining

hasContainedItemQuantity

public boolean hasContainedItemQuantity()

addContainedItemQuantity

public Quantity addContainedItemQuantity()

addContainedItemQuantity

public PackagedProductDefinition addContainedItemQuantity(Quantity t)

getContainedItemQuantityFirstRep

public Quantity getContainedItemQuantityFirstRep()

Returns:

The first repetition of repeating field containedItemQuantity, creating it if it does not already exist {3}

getDescriptionElement

public MarkdownType getDescriptionElement()

Returns:

description (Textual description. Note that this is not the name of the package or product.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

hasDescriptionElement

public boolean hasDescriptionElement()

hasDescription

public boolean hasDescription()

setDescriptionElement

public PackagedProductDefinition setDescriptionElement(MarkdownType value)

Parameters:

value - description (Textual description. Note that this is not the name of the package or product.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

Textual description. Note that this is not the name of the package or product.

setDescription

public PackagedProductDefinition setDescription(String value)

Parameters:

value - Textual description. Note that this is not the name of the package or product.

getLegalStatusOfSupply

public List<PackagedProductDefinition.PackagedProductDefinitionLegalStatusOfSupplyComponent> getLegalStatusOfSupply()

Returns:

legalStatusOfSupply (The legal status of supply of the packaged item as classified by the regulator.)

setLegalStatusOfSupply

public PackagedProductDefinition setLegalStatusOfSupply(List<PackagedProductDefinition.PackagedProductDefinitionLegalStatusOfSupplyComponent> theLegalStatusOfSupply)

Returns:

Returns a reference to this for easy method chaining

hasLegalStatusOfSupply

public boolean hasLegalStatusOfSupply()

addLegalStatusOfSupply

public PackagedProductDefinition.PackagedProductDefinitionLegalStatusOfSupplyComponent addLegalStatusOfSupply()

addLegalStatusOfSupply

public PackagedProductDefinition addLegalStatusOfSupply(PackagedProductDefinition.PackagedProductDefinitionLegalStatusOfSupplyComponent t)

getLegalStatusOfSupplyFirstRep

public PackagedProductDefinition.PackagedProductDefinitionLegalStatusOfSupplyComponent getLegalStatusOfSupplyFirstRep()

Returns:

The first repetition of repeating field legalStatusOfSupply, creating it if it does not already exist {3}

getMarketingStatus

public List<MarketingStatus> getMarketingStatus()

Returns:

marketingStatus (Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated.)

setMarketingStatus

public PackagedProductDefinition setMarketingStatus(List<MarketingStatus> theMarketingStatus)

Returns:

Returns a reference to this for easy method chaining

hasMarketingStatus

public boolean hasMarketingStatus()

addMarketingStatus

public MarketingStatus addMarketingStatus()

addMarketingStatus

public PackagedProductDefinition addMarketingStatus(MarketingStatus t)

getMarketingStatusFirstRep

public MarketingStatus getMarketingStatusFirstRep()

Returns:

The first repetition of repeating field marketingStatus, creating it if it does not already exist {3}

getCopackagedIndicatorElement

public BooleanType getCopackagedIndicatorElement()

Returns:

copackagedIndicator (Identifies if the package contains different items, such as when a drug product is supplied with another item e.g. a diluent or adjuvant.). This is the underlying object with id, value and extensions. The accessor "getCopackagedIndicator" gives direct access to the value

hasCopackagedIndicatorElement

public boolean hasCopackagedIndicatorElement()

hasCopackagedIndicator

public boolean hasCopackagedIndicator()

setCopackagedIndicatorElement

public PackagedProductDefinition setCopackagedIndicatorElement(BooleanType value)

Parameters:

value - copackagedIndicator (Identifies if the package contains different items, such as when a drug product is supplied with another item e.g. a diluent or adjuvant.). This is the underlying object with id, value and extensions. The accessor "getCopackagedIndicator" gives direct access to the value

getCopackagedIndicator

public boolean getCopackagedIndicator()

Returns:

Identifies if the package contains different items, such as when a drug product is supplied with another item e.g. a diluent or adjuvant.

setCopackagedIndicator

public PackagedProductDefinition setCopackagedIndicator(boolean value)

Parameters:

value - Identifies if the package contains different items, such as when a drug product is supplied with another item e.g. a diluent or adjuvant.

getManufacturer

public List<Reference> getManufacturer()

Returns:

manufacturer (Manufacturer of this package type. When there are multiple it means these are all possible manufacturers.)

setManufacturer

public PackagedProductDefinition setManufacturer(List<Reference> theManufacturer)

Returns:

Returns a reference to this for easy method chaining

hasManufacturer

public boolean hasManufacturer()

addManufacturer

public Reference addManufacturer()

addManufacturer

public PackagedProductDefinition addManufacturer(Reference t)

getManufacturerFirstRep

public Reference getManufacturerFirstRep()

Returns:

The first repetition of repeating field manufacturer, creating it if it does not already exist {3}

getAttachedDocument

public List<Reference> getAttachedDocument()

Returns:

attachedDocument (Additional information or supporting documentation about the packaged product.)

setAttachedDocument

public PackagedProductDefinition setAttachedDocument(List<Reference> theAttachedDocument)

Returns:

Returns a reference to this for easy method chaining

hasAttachedDocument

public boolean hasAttachedDocument()

addAttachedDocument

public Reference addAttachedDocument()

addAttachedDocument

public PackagedProductDefinition addAttachedDocument(Reference t)

getAttachedDocumentFirstRep

public Reference getAttachedDocumentFirstRep()

Returns:

The first repetition of repeating field attachedDocument, creating it if it does not already exist {3}

getPackaging

public PackagedProductDefinition.PackagedProductDefinitionPackagingComponent getPackaging()

Returns:

packaging (A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap (which is not a device or a medication manufactured item).)

hasPackaging

public boolean hasPackaging()

setPackaging

public PackagedProductDefinition setPackaging(PackagedProductDefinition.PackagedProductDefinitionPackagingComponent value)

Parameters:

value - packaging (A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap (which is not a device or a medication manufactured item).)

getCharacteristic

public List<PackagedProductDefinition.PackagedProductDefinitionPackagingPropertyComponent> getCharacteristic()

Returns:

characteristic (Allows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack".)

setCharacteristic

public PackagedProductDefinition setCharacteristic(List<PackagedProductDefinition.PackagedProductDefinitionPackagingPropertyComponent> theCharacteristic)

Returns:

Returns a reference to this for easy method chaining

hasCharacteristic

public boolean hasCharacteristic()

addCharacteristic

public PackagedProductDefinition.PackagedProductDefinitionPackagingPropertyComponent addCharacteristic()

addCharacteristic

public PackagedProductDefinition addCharacteristic(PackagedProductDefinition.PackagedProductDefinitionPackagingPropertyComponent t)

getCharacteristicFirstRep

public PackagedProductDefinition.PackagedProductDefinitionPackagingPropertyComponent getCharacteristicFirstRep()

Returns:

The first repetition of repeating field characteristic, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

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 DomainResource

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 DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

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 DomainResource

Returns:

the FHIR type name of the instance (not the java class name)

copy

public PackagedProductDefinition copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(PackagedProductDefinition dst)

typedCopy

protected PackagedProductDefinition typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource