Package org.linuxforhealth.fhir.model.resource

Class PackagedProductDefinition

  • All Implemented Interfaces:
    Visitable
    @Generated("org.linuxforhealth.fhir.tools.CodeGenerator")
public class PackagedProductDefinition
extends DomainResource
    A medically related item or items, in a container or package.

    Maturity level: FMM1 (Trial Use)

    • Method Detail

      • getIdentifier

        public java.util.List<Identifier> getIdentifier()
        A unique identifier for this package as whole. Unique instance identifiers assigned to a package by manufacturers, regulators, drug catalogue custodians or other organizations.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getName

        public String getName()
        A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.
        Returns:
        An immutable object of type String that may be null.

      • getType

        public CodeableConcept getType()
        A high level category e.g. medicinal product, raw material, shipping/transport container, etc.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getPackageFor

        public java.util.List<Reference> getPackageFor()
        The product that this is a pack for.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getStatus

        public CodeableConcept getStatus()
        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.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getStatusDate

        public DateTime getStatusDate()
        The date at which the given status became applicable.
        Returns:
        An immutable object of type DateTime that may be null.

      • getContainedItemQuantity

        public java.util.List<Quantity> getContainedItemQuantity()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type Quantity that may be empty.

      • getDescription

        public Markdown getDescription()
        Textual description. Note that this is not the name of the package or product.
        Returns:
        An immutable object of type Markdown that may be null.

      • getMarketingStatus

        public java.util.List<MarketingStatus> getMarketingStatus()
        Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated.
        Returns:
        An unmodifiable list containing immutable objects of type MarketingStatus that may be empty.

      • getCharacteristic

        public java.util.List<CodeableConcept> getCharacteristic()
        Allows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack".
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getCopackagedIndicator

        public Boolean getCopackagedIndicator()
        States whether a drug product is supplied with another item such as a diluent or adjuvant.
        Returns:
        An immutable object of type Boolean that may be null.

      • getManufacturer

        public java.util.List<Reference> getManufacturer()
        Manufacturer of this package type. When there are multiple it means these are all possible manufacturers.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getPackage

        public PackagedProductDefinition.Package getPackage()
        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).
        Returns:
        An immutable object of type PackagedProductDefinition.Package that may be null.

      • accept

        public void accept​(java.lang.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​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object